org.eclipse.jetty.session.infinispan

Class InfinispanSessionManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.session.AbstractSessionManager

org.eclipse.jetty.session.infinispan.InfinispanSessionManager

All Implemented Interfaces:

SessionManager, Container, Destroyable, Dumpable, LifeCycle

public class InfinispanSessionManager
extends AbstractSessionManager

InfinispanSessionManager The data for a session relevant to a particular context is stored in an Infinispan (clustered) cache:

 Key:   is the id of the session + the context path + the vhost for the context 
 Value: is the data of the session
 

The key is necessarily complex because the same session id can be in-use by more than one context. In this case, the contents of the session will strictly be different for each context, although the id will be the same. Sessions are also kept in local memory when they are used by this session manager. This allows multiple different request threads in the same context to call Request.getSession() and obtain the same object. This session manager support scavenging, which is only done over the set of sessions in its local memory. This can result in some sessions being "stranded" in the cluster cache if no session manager is currently managing it (eg the node managing the session crashed and it was never requested on another node).

Nested Class Summary

Nested Classes

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

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 InfinispanSessionManager.Scavenger	_scavenger
protected Scheduler	_scheduler
protected Scheduler.Task	_task

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

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
InfinispanSessionManager()

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 void	delete(InfinispanSessionManager.Session session) Remove the session from the cluster cache.
void	doStart() Start the session manager.
void	doStop() Stop the session manager.
org.infinispan.commons.api.BasicCache<String,Object>	getCache() Get the clustered cache instance.
long	getScavengeInterval()
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 InfinispanSessionManager.Session	load(String key) Load a session from the clustered cache.
protected AbstractSession	newSession(javax.servlet.http.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(InfinispanSessionManager.Session session) Save or update the session to the cluster cache
void	scavenge()
void	setCache(org.infinispan.commons.api.BasicCache<String,Object> cache) Set the clustered cache instance.
void	setScavengeInterval(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

_task

protected Scheduler.Task _task

_scheduler

protected Scheduler _scheduler

_scavenger

protected InfinispanSessionManager.Scavenger _scavenger

_scavengeIntervalMs

protected long _scavengeIntervalMs

_ownScheduler

protected boolean _ownScheduler

Constructor Detail

InfinispanSessionManager

public InfinispanSessionManager()

Method Detail

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()

getScavengeInterval

public long getScavengeInterval()

setScavengeInterval

public void setScavengeInterval(long sec)

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

Parameters:

sec - scavenge interval in seconds

getCache

public org.infinispan.commons.api.BasicCache<String,Object> getCache()

Get the clustered cache instance.

Returns:

the cache

setCache

public void setCache(org.infinispan.commons.api.BasicCache<String,Object> cache)

Set the clustered cache instance.

Parameters:

cache - the cache

getStaleIntervalSec

public long getStaleIntervalSec()

setStaleIntervalSec

public void setStaleIntervalSec(long staleIntervalSec)

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(javax.servlet.http.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 InfinispanSessionManager.Session load(String key)

Load a session from the clustered cache.

Parameters:

key - the session key

Returns:

the session

save

protected void save(InfinispanSessionManager.Session session)
             throws Exception

Save or update the session to the cluster cache

Parameters:

session - the session

Throws:

Exception - if unable to save

delete

protected void delete(InfinispanSessionManager.Session session)

Remove the session from the cluster cache.

Parameters:

session - the session

invalidateSession

public void invalidateSession(String idInCluster)

Invalidate a session for this context with the given id

Parameters:

idInCluster - session id in cluster