org.eclipse.jetty.gcloud.memcached.session

Class GCloudMemcachedSessionManager

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

org.eclipse.jetty.gcloud.memcached.session.GCloudMemcachedSessionManager

All Implemented Interfaces:

SessionManager, Container, Destroyable, Dumpable, LifeCycle

public class GCloudMemcachedSessionManager
extends GCloudSessionManager

GCloudMemcachedSessionManager Use memcached in front of GCloudDataStore

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GCloudMemcachedSessionManager.ContextClassloaderSerializingTranscoder ContextClassloaderSerializingTranscoder A xmemcached transcoder that will use the thread context classloader to resolve classes during object deserialization: necessary for Servlet Spec classloading order of context classloader first.
class	GCloudMemcachedSessionManager.MemcacheSession MemcacheSession Needed to make a constructor public.
class	GCloudMemcachedSessionManager.SerializableSessionData Every time a Session is put into the cache one of these objects is created to copy the data out of the in-memory session, and every time an object is read from the cache one of these objects a fresh Session object is created based on the data held by this object.

Nested classes/interfaces inherited from class org.eclipse.jetty.gcloud.session.GCloudSessionManager

GCloudSessionManager.Scavenger, GCloudSessionManager.Session, GCloudSessionManager.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 net.rubyeye.xmemcached.MemcachedClient	_client
protected int	_expirySec
protected String	_host
protected String	_port

Fields inherited from class org.eclipse.jetty.gcloud.session.GCloudSessionManager

_ownScheduler, _scavengeIntervalMs, _scavenger, _scheduler, _task, DEFAULT_BACKOFF_MS, DEFAULT_MAX_QUERY_RESULTS, DEFAULT_MAX_RETRIES, DEFAULT_SCAVENGE_SEC, 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, STOP_ON_FAILURE, 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
GCloudMemcachedSessionManager()

Method Summary

Modifier and Type	Method and Description
protected void	delete(GCloudSessionManager.Session session) Remove the session from the cluster cache.
protected void	deleteFromMemcached(GCloudSessionManager.Session session)
void	doStart() Start the session manager.
void	doStop() Stop the session manager.
int	getExpirySec()
String	getHost()
String	getPort()
protected GCloudSessionManager.Session	load(com.google.cloud.datastore.Key key) Load a session from the clustered cache.
protected GCloudSessionManager.Session	loadFromMemcached(String key)
protected void	save(GCloudSessionManager.Session session) Save or update the session to the cluster cache
protected void	saveToMemcached(GCloudSessionManager.Session session) Store the session into memcached
void	setExpirySec(int expirySec)
void	setHeartbeats(boolean heartbeats)
void	setHost(String host)
void	setPort(String port)

Methods inherited from class org.eclipse.jetty.gcloud.session.GCloudSessionManager

addSession, canonicalizeKey, getBackoffMs, getMaxResults, getMaxRetries, getScavengeIntervalSec, getSession, getStaleIntervalSec, invalidateSession, makeKey, makeKey, newSession, removeSession, renewSessionId, scavenge, scavengeGCloudDataStore, scavengeSession, setBackoffMs, setDatastore, setMaxResults, setMaxRetries, setScavengeIntervalSec, setStaleIntervalSec, shutdownSessions

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

_host

protected String _host

_port

protected String _port

_client

protected net.rubyeye.xmemcached.MemcachedClient _client

_expirySec

protected int _expirySec

Constructor Detail

GCloudMemcachedSessionManager

public GCloudMemcachedSessionManager()

Method Detail

getExpirySec

public int getExpirySec()

Returns:

the expiry setting for memcached

setExpirySec

public void setExpirySec(int expirySec)

Parameters:

expirySec - the time in seconds for an item to remain in memcached

setHeartbeats

public void setHeartbeats(boolean heartbeats)

Parameters:

heartbeats - if true memcached heartbeats are enabled. Default is true.

doStart

public void doStart()
             throws Exception

Description copied from class: GCloudSessionManager

Start the session manager.

Overrides:

doStart in class GCloudSessionManager

Throws:

Exception

See Also:

AbstractSessionManager.doStart()

doStop

public void doStop()
            throws Exception

Description copied from class: GCloudSessionManager

Stop the session manager.

Overrides:

doStop in class GCloudSessionManager

Throws:

Exception

See Also:

AbstractSessionManager.doStop()

load

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

Description copied from class: GCloudSessionManager

Load a session from the clustered cache.

Overrides:

load in class GCloudSessionManager

Parameters:

key - the unique datastore key for the session

Returns:

the Session object restored from datastore

Throws:

Exception

loadFromMemcached

protected GCloudSessionManager.Session loadFromMemcached(String key)
                                                  throws Exception

Parameters:

key - the key for the memcache item

Returns:

the Session inflated from memcache

Throws:

Exception

save

protected void save(GCloudSessionManager.Session session)
             throws Exception

Description copied from class: GCloudSessionManager

Save or update the session to the cluster cache

Overrides:

save in class GCloudSessionManager

Parameters:

session - the session to save to datastore

Throws:

Exception

delete

protected void delete(GCloudSessionManager.Session session)

Description copied from class: GCloudSessionManager

Remove the session from the cluster cache.

Overrides:

delete in class GCloudSessionManager

Parameters:

session - the session to delete from datastore

deleteFromMemcached

protected void deleteFromMemcached(GCloudSessionManager.Session session)
                            throws Exception

Throws:

Exception

saveToMemcached

protected void saveToMemcached(GCloudSessionManager.Session session)
                        throws Exception

Store the session into memcached

Parameters:

session - the Session to be serialized

Throws:

Exception

getHost

public String getHost()

Returns:

the host address of the memcached server

setHost

public void setHost(String host)

Parameters:

host - the host address of the memcached server

getPort

public String getPort()

Returns:

the port of the memcached server

setPort

public void setPort(String port)

Parameters:

port - the port of the memcached server