org.eclipse.jetty.gcloud.session

Class GCloudSessionManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.session.AbstractSessionManager

org.eclipse.jetty.gcloud.session.GCloudSessionManager

All Implemented Interfaces:

SessionManager, Container, Destroyable, Dumpable, LifeCycle

Direct Known Subclasses:

GCloudMemcachedSessionManager

public class GCloudSessionManager
extends AbstractSessionManager

GCloudSessionManager

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GCloudSessionManager.Scavenger Scavenger
class	GCloudSessionManager.Session Session Representation of a session in local memory.
class	GCloudSessionManager.SessionEntityConverter SessionEntityConverter

Nested classes/interfaces inherited from class org.eclipse.jetty.server.session.AbstractSessionManager

AbstractSessionManager.CookieConfig, AbstractSessionManager.SessionIf

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_ownScheduler
protected long	_scavengeIntervalMs
protected GCloudSessionManager.Scavenger	_scavenger
protected Scheduler	_scheduler
protected Scheduler.Task	_task
static int	DEFAULT_BACKOFF_MS
static int	DEFAULT_MAX_QUERY_RESULTS
static int	DEFAULT_MAX_RETRIES
static long	DEFAULT_SCAVENGE_SEC
static String	KIND

Fields inherited from class org.eclipse.jetty.server.session.AbstractSessionManager

__defaultSessionTrackingModes, __distantFuture, _checkingRemoteSessionIdEncoding, _context, _dftMaxIdleSecs, _httpOnly, _loader, _maxCookieAge, _nodeIdInSessionId, _refreshCookieAge, _secureCookies, _secureRequestOnly, _sessionAttributeListeners, _sessionComment, _sessionCookie, _sessionDomain, _sessionHandler, _sessionIdListeners, _sessionIdManager, _sessionIdPathParameterName, _sessionIdPathParameterNamePrefix, _sessionListeners, _sessionPath, _sessionsStats, _sessionTimeStats, _sessionTrackingModes, MAX_INACTIVE_MINUTES

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.server.SessionManager

__CheckRemoteSessionEncoding, __DefaultSessionCookie, __DefaultSessionDomain, __DefaultSessionIdPathParameterName, __MaxAgeProperty, __SessionCookieProperty, __SessionDomainProperty, __SessionIdPathParameterNameProperty, __SessionPathProperty

Constructor Summary

Constructors

Constructor and Description
GCloudSessionManager()

Method Summary

Modifier and Type	Method and Description
protected void	addSession(AbstractSession session) Add a new session for the context related to this session manager
protected String	canonicalizeKey(String id, ContextHandler.Context context) Make a unique string from the session id and info from its Context
protected void	delete(GCloudSessionManager.Session session) Remove the session from the cluster cache.
void	doStart() Start the session manager.
void	doStop() Stop the session manager.
int	getBackoffMs()
int	getMaxResults()
int	getMaxRetries()
long	getScavengeIntervalSec()
AbstractSession	getSession(String idInCluster) Ask the cluster for the session.
long	getStaleIntervalSec()
void	invalidateSession(String idInCluster) Invalidate a session for this context with the given id
protected GCloudSessionManager.Session	load(com.google.cloud.datastore.Key key) Load a session from the clustered cache.
protected com.google.cloud.datastore.Key	makeKey(GCloudSessionManager.Session session, ContextHandler.Context context) Make a unique key for this session.
protected com.google.cloud.datastore.Key	makeKey(String id, ContextHandler.Context context) Make a unique key for this session.
protected AbstractSession	newSession(HttpServletRequest request) Create a new session instance
protected boolean	removeSession(String idInCluster) Remove a session from local memory, and delete it from the cluster cache.
void	renewSessionId(String oldClusterId, String oldNodeId, String newClusterId, String newNodeId) Tell the HttpSessionIdListeners the id changed.
protected void	save(GCloudSessionManager.Session session) Save or update the session to the cluster cache
void	scavenge() Look for sessions in local memory that have expired.
protected void	scavengeGCloudDataStore()
protected void	scavengeSession(com.google.cloud.datastore.Entity e) Scavenge a session that has expired
void	setBackoffMs(int backoffMs)
void	setDatastore(com.google.cloud.datastore.Datastore datastore)
void	setMaxResults(int maxResults)
void	setMaxRetries(int maxRetries)
void	setScavengeIntervalSec(long sec) Set the interval between runs of the scavenger.
void	setStaleIntervalSec(long staleIntervalSec)
protected void	shutdownSessions() The session manager is stopping.

Methods inherited from class org.eclipse.jetty.server.session.AbstractSessionManager

access, addEventListener, addSession, clearEventListeners, complete, doSessionAttributeListeners, getClusterId, getContext, getContextHandler, getDefaultSessionTrackingModes, getEffectiveSessionTrackingModes, getHttpOnly, getHttpSession, getMaxCookieAge, getMaxInactiveInterval, getMetaManager, getNodeId, getRefreshCookieAge, getSecureCookies, getSessionCookie, getSessionCookie, getSessionCookieConfig, getSessionDomain, getSessionHandler, getSessionIdManager, getSessionIdPathParameterName, getSessionIdPathParameterNamePrefix, getSessionPath, getSessions, getSessionsMax, getSessionsTotal, getSessionTimeMax, getSessionTimeMean, getSessionTimeStdDev, getSessionTimeTotal, isCheckingRemoteSessionIdEncoding, isNodeIdInSessionId, isSecureRequestOnly, isUsingCookies, isUsingURLs, isValid, newHttpSession, removeEventListener, removeSession, removeSession, setCheckingRemoteSessionIdEncoding, setHttpOnly, setMaxInactiveInterval, setNodeIdInSessionId, setRefreshCookieAge, setSecureRequestOnly, setSessionCookie, setSessionHandler, setSessionIdManager, setSessionIdPathParameterName, setSessionTrackingModes, setUsingCookies, statsReset

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Field Detail

KIND

public static final String KIND

See Also:

Constant Field Values

DEFAULT_MAX_QUERY_RESULTS

public static final int DEFAULT_MAX_QUERY_RESULTS

See Also:

Constant Field Values

DEFAULT_SCAVENGE_SEC

public static final long DEFAULT_SCAVENGE_SEC

See Also:

Constant Field Values

DEFAULT_BACKOFF_MS

public static final int DEFAULT_BACKOFF_MS

See Also:

Constant Field Values

DEFAULT_MAX_RETRIES

public static final int DEFAULT_MAX_RETRIES

See Also:

Constant Field Values

_task

protected Scheduler.Task _task

_scheduler

protected Scheduler _scheduler

_scavenger

protected GCloudSessionManager.Scavenger _scavenger

_scavengeIntervalMs

protected long _scavengeIntervalMs

_ownScheduler

protected boolean _ownScheduler

Constructor Detail

GCloudSessionManager

public GCloudSessionManager()

Method Detail

setDatastore

public void setDatastore(com.google.cloud.datastore.Datastore datastore)

doStart

public void doStart()
             throws Exception

Start the session manager.

Overrides:

doStart in class AbstractSessionManager

Throws:

Exception

See Also:

AbstractSessionManager.doStart()

doStop

public void doStop()
            throws Exception

Stop the session manager.

Overrides:

doStop in class AbstractSessionManager

Throws:

Exception

See Also:

AbstractSessionManager.doStop()

scavenge

public void scavenge()

Look for sessions in local memory that have expired.

scavengeGCloudDataStore

protected void scavengeGCloudDataStore()
                                throws Exception

Throws:

Exception

scavengeSession

protected void scavengeSession(com.google.cloud.datastore.Entity e)
                        throws Exception

Scavenge a session that has expired

Parameters:

e - the session info from datastore

Throws:

Exception

getScavengeIntervalSec

public long getScavengeIntervalSec()

setScavengeIntervalSec

public void setScavengeIntervalSec(long sec)

Set the interval between runs of the scavenger. It should not be run too often.

Parameters:

sec - the number of seconds between scavenge cycles

getStaleIntervalSec

public long getStaleIntervalSec()

setStaleIntervalSec

public void setStaleIntervalSec(long staleIntervalSec)

getMaxResults

public int getMaxResults()

setMaxResults

public void setMaxResults(int maxResults)

addSession

protected void addSession(AbstractSession session)

Add a new session for the context related to this session manager

Specified by:

addSession in class AbstractSessionManager

See Also:

AbstractSessionManager.addSession(org.eclipse.jetty.server.session.AbstractSession)

getSession

public AbstractSession getSession(String idInCluster)

Ask the cluster for the session.

Specified by:

getSession in class AbstractSessionManager

Parameters:

idInCluster - The session ID in the cluster, stripped of any worker name.

Returns:

A Session or null if none exists.

See Also:

AbstractSessionManager.getSession(java.lang.String)

shutdownSessions

protected void shutdownSessions()
                         throws Exception

The session manager is stopping.

Specified by:

shutdownSessions in class AbstractSessionManager

Throws:

Exception - if unable to shutdown sesssions

See Also:

AbstractSessionManager.shutdownSessions()

newSession

protected AbstractSession newSession(HttpServletRequest request)

Description copied from class: AbstractSessionManager

Create a new session instance

Specified by:

newSession in class AbstractSessionManager

Parameters:

request - the request to build the session from

Returns:

the new session

removeSession

protected boolean removeSession(String idInCluster)

Remove a session from local memory, and delete it from the cluster cache.

Specified by:

removeSession in class AbstractSessionManager

See Also:

AbstractSessionManager.removeSession(java.lang.String)

renewSessionId

public void renewSessionId(String oldClusterId,
                           String oldNodeId,
                           String newClusterId,
                           String newNodeId)

Description copied from class: AbstractSessionManager

Tell the HttpSessionIdListeners the id changed. NOTE: this method must be called LAST in subclass overrides, after the session has been updated with the new id.

Specified by:

renewSessionId in interface SessionManager

Overrides:

renewSessionId in class AbstractSessionManager

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

newClusterId - the new cluster id

newNodeId - the new node id

See Also:

SessionManager.renewSessionId(java.lang.String, java.lang.String, java.lang.String, java.lang.String)

load

protected GCloudSessionManager.Session load(com.google.cloud.datastore.Key key)
                                     throws Exception

Load a session from the clustered cache.

Parameters:

key - the unique datastore key for the session

Returns:

the Session object restored from datastore

Throws:

Exception

save

protected void save(GCloudSessionManager.Session session)
             throws Exception

Save or update the session to the cluster cache

Parameters:

session - the session to save to datastore

Throws:

Exception

getMaxRetries

public int getMaxRetries()

getBackoffMs

public int getBackoffMs()

setBackoffMs

public void setBackoffMs(int backoffMs)

Parameters:

backoffMs - the backoffMs to set

setMaxRetries

public void setMaxRetries(int maxRetries)

Parameters:

maxRetries - the maxRetries to set

delete

protected void delete(GCloudSessionManager.Session session)

Remove the session from the cluster cache.

Parameters:

session - the session to delete from datastore

invalidateSession

public void invalidateSession(String idInCluster)

Invalidate a session for this context with the given id

Parameters:

idInCluster - the id of the session to invalidate

makeKey

protected com.google.cloud.datastore.Key makeKey(GCloudSessionManager.Session session,
                                                 ContextHandler.Context context)

Make a unique key for this session. As the same session id can be used across multiple contexts, to make it unique, the key must be composed of:

1. the id
2. the context path
3. the virtual hosts

Parameters:

session - the session for which the key should be created

context - the context to which the session belongs

Returns:

a unique datastore key for the session

makeKey

protected com.google.cloud.datastore.Key makeKey(String id,
                                                 ContextHandler.Context context)

Make a unique key for this session. As the same session id can be used across multiple contexts, to make it unique, the key must be composed of:

1. the id
2. the context path
3. the virtual hosts

Parameters:

id - the id of the session for which the key should be created

context - the context to which the session belongs

Returns:

a unique datastore key for the session

canonicalizeKey

protected String canonicalizeKey(String id,
                                 ContextHandler.Context context)

Make a unique string from the session id and info from its Context

Parameters:

id - the id of the Session

context - the Context in which the Session exists

Returns:

a unique string representing the id of the session in the context