org.eclipse.jetty.session.infinispan

Class InfinispanSessionIdManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.server.session.AbstractSessionIdManager

org.eclipse.jetty.session.infinispan.InfinispanSessionIdManager

All Implemented Interfaces:

SessionIdManager, LifeCycle

public class InfinispanSessionIdManager
extends AbstractSessionIdManager

InfinispanSessionIdManager Maintain a set of in-use session ids. This session id manager does NOT locally store a list of in-use sesssion ids, but rather stores them in the cluster cache. Thus, all operations to this session manager involve interaction with a possibly remote cache. For each session id that is in-use, an entry of the following form is put into the cluster cache:

   ("__o.e.j.s.infinispanIdMgr__"+[id], [id])
 

where [id] is the id of the session. If the first session to be added is not immortal (ie it has a timeout on it) then the corresponding session id is entered into infinispan with an idle expiry timeout equivalent to double the session's timeout (the multiplier is configurable). Having one entry per in-use session id means that there is no contention on cache entries (as would be the case if a single entry was kept containing a list of in-use session ids).

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.infinispan.commons.api.BasicCache<String,Object>	_cache
static int	DEFAULT_IDLE_EXPIRY_MULTIPLE
static String	ID_KEY

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

_random, _reseed, _weakRandom, _workerAttr, _workerName

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
InfinispanSessionIdManager(Server server)
InfinispanSessionIdManager(Server server, Random random)

Method Summary

Modifier and Type	Method and Description
void	addSession(HttpSession session) Remember a new in-use session id.
protected void	delete(String id) Remove a session id from the cluster.
protected void	doStart() Start the id manager.
protected void	doStop() Stop the id manager
protected boolean	exists(String id) Ask the cluster if a particular id exists.
org.infinispan.commons.api.BasicCache<String,Object>	getCache() Get the cache.
int	getIdleExpiryMultiple()
boolean	idInUse(String id) Check to see if the given session id is being used by a session in any context.
protected void	insert(String id) Put a session id into the cluster.
protected void	insert(String id, long idleTimeOutSec) Put a session id into the cluster with an idle expiry.
void	invalidateAll(String id) Remove a session id.
protected String	makeKey(String id) Generate a unique cache key from the session id.
void	removeSession(HttpSession session) Remove a session id from the list of in-use ids.
void	renewSessionId(String oldClusterId, String oldNodeId, HttpServletRequest request) Change a session id.
void	setCache(org.infinispan.commons.api.BasicCache<String,Object> cache) Set the cache.
void	setIdleExpiryMultiple(int multiplier)
void	touch(String id) Do any operation to the session id in the cache to ensure its idle expiry time moves forward

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

getClusterId, getNodeId, getRandom, getReseed, getWorkerName, initRandom, newSessionId, newSessionId, setRandom, setReseed, setWorkerName

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

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, 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

ID_KEY

public static final String ID_KEY

See Also:

Constant Field Values

DEFAULT_IDLE_EXPIRY_MULTIPLE

public static final int DEFAULT_IDLE_EXPIRY_MULTIPLE

See Also:

Constant Field Values

_cache

protected org.infinispan.commons.api.BasicCache<String,Object> _cache

Constructor Detail

InfinispanSessionIdManager

public InfinispanSessionIdManager(Server server)

InfinispanSessionIdManager

public InfinispanSessionIdManager(Server server,
                                  Random random)

Method Detail

doStart

protected void doStart()
                throws Exception

Start the id manager.

Overrides:

doStart in class AbstractSessionIdManager

Throws:

Exception

See Also:

AbstractSessionIdManager.doStart()

doStop

protected void doStop()
               throws Exception

Stop the id manager

Overrides:

doStop in class AbstractSessionIdManager

Throws:

Exception

See Also:

AbstractSessionIdManager.doStop()

idInUse

public boolean idInUse(String id)

Check to see if the given session id is being used by a session in any context. This method will consult the cluster.

Parameters:

id - The session ID without any cluster node extension

Returns:

True if the session ID is in use by at least one context.

See Also:

SessionIdManager.idInUse(java.lang.String)

addSession

public void addSession(HttpSession session)

Remember a new in-use session id. This will save the in-use session id to the cluster.

Parameters:

session - The session

See Also:

SessionIdManager.addSession(javax.servlet.http.HttpSession)

setIdleExpiryMultiple

public void setIdleExpiryMultiple(int multiplier)

getIdleExpiryMultiple

public int getIdleExpiryMultiple()

removeSession

public void removeSession(HttpSession session)

Remove a session id from the list of in-use ids. This will remvove the corresponding session id from the cluster.

Parameters:

session - the session to remove

See Also:

SessionIdManager.removeSession(javax.servlet.http.HttpSession)

invalidateAll

public void invalidateAll(String id)

Remove a session id. This compels all other contexts who have a session with the same id to also remove it.

Parameters:

id - The session ID without any cluster node extension

See Also:

SessionIdManager.invalidateAll(java.lang.String)

renewSessionId

public void renewSessionId(String oldClusterId,
                           String oldNodeId,
                           HttpServletRequest request)

Change a session id. Typically this occurs when a previously existing session has passed through authentication.

Specified by:

renewSessionId in interface SessionIdManager

Specified by:

renewSessionId in class AbstractSessionIdManager

Parameters:

oldClusterId - the old cluster id

oldNodeId - the old node id

request - the request containing the session

See Also:

AbstractSessionIdManager.renewSessionId(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)

getCache

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

Get the cache.

Returns:

the cache

setCache

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

Set the cache.

Parameters:

cache - the cache

touch

public void touch(String id)

Do any operation to the session id in the cache to ensure its idle expiry time moves forward

Parameters:

id - the session id

exists

protected boolean exists(String id)

Ask the cluster if a particular id exists.

Parameters:

id - the session id

Returns:

true if exists

insert

protected void insert(String id)

Put a session id into the cluster.

Parameters:

id - the session id

insert

protected void insert(String id,
                      long idleTimeOutSec)

Put a session id into the cluster with an idle expiry.

Parameters:

id - the session id

idleTimeOutSec - idle timeout in seconds

delete

protected void delete(String id)

Remove a session id from the cluster.

Parameters:

id - the session id

makeKey

protected String makeKey(String id)

Generate a unique cache key from the session id.

Parameters:

id - the session id

Returns:

unique cache id