Package org.eclipse.jetty.server.session

Class AbstractSessionCache

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.session.AbstractSessionCache

All Implemented Interfaces:

SessionCache, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

DefaultSessionCache, NullSessionCache

@ManagedObject
public abstract class AbstractSessionCache
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements SessionCache

AbstractSessionCache A base implementation of the SessionCache interface for managing a set of Session objects pertaining to a context in memory. This implementation ensures that multiple requests for the same session id always return the same Session object. It will delay writing out a session to the SessionDataStore until the last request exits the session. If the SessionDataStore supports passivation then the session passivation and activation listeners are called appropriately as the session is written. This implementation also supports evicting idle Session objects. An idle Session is one that is still valid, has not expired, but has not been accessed by a request for a configurable amount of time. An idle session will be first passivated before it is evicted from the cache.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractSessionCache.PlaceHolderSession	PlaceHolder

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

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

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected SessionContext	_context	Information about the context to which this SessionCache pertains
protected int	_evictionPolicy	When, if ever, to evict sessions: never; only when the last request for them finishes; after inactivity time (expressed as secs)
protected SessionHandler	_handler	The SessionHandler related to this SessionCache
protected boolean	_removeUnloadableSessions	If true, a Session whose data cannot be read will be deleted from the SessionDataStore.
protected boolean	_saveOnCreate	If true, as soon as a new session is created, it will be persisted to the SessionDataStore
protected boolean	_saveOnInactiveEviction	If true, a session that will be evicted from the cache because it has been inactive too long will be saved before being evicted.
protected SessionDataStore	_sessionDataStore	The authoritative source of session data

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.server.session.SessionCache

EVICT_ON_INACTIVITY, EVICT_ON_SESSION_EXIT, NEVER_EVICT

Constructor Summary

Constructors

Constructor	Description
AbstractSessionCache(SessionHandler handler)

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	checkExpiration(java.util.Set<java.lang.String> candidates)	Check a list of session ids that belong to potentially expired sessions.
void	checkInactiveSession(Session session)	Check a session for being inactive and thus being able to be evicted, if eviction is enabled.
boolean	contains(java.lang.String id)	Check to see if this cache contains an entry for the session corresponding to the session id.
Session	delete(java.lang.String id)	Remove a session object from this store and from any backing store.
abstract Session	doDelete(java.lang.String id)	Remove the session with this identity from the store
abstract Session	doGet(java.lang.String id)	Get the session matching the key
abstract Session	doPutIfAbsent(java.lang.String id, Session session)	Put the session into the map if it wasn't already there
abstract boolean	doReplace(java.lang.String id, Session oldValue, Session newValue)	Replace the mapping from id to oldValue with newValue
protected void	doStart()
protected void	doStop()
boolean	exists(java.lang.String id)	Check to see if a session corresponding to the id exists.
Session	get(java.lang.String id)	Get a session object.
int	getEvictionPolicy()
SessionDataStore	getSessionDataStore()
SessionHandler	getSessionHandler()
void	initialize(SessionContext context)
boolean	isRemoveUnloadableSessions()
boolean	isSaveOnCreate()
boolean	isSaveOnInactiveEviction()	Whether we should save a session that has been inactive before we boot it from the cache.
Session	newSession(HttpServletRequest request, java.lang.String id, long time, long maxInactiveMs)	Create an entirely new Session.
abstract Session	newSession(HttpServletRequest request, SessionData data)	Create a new Session for a request.
abstract Session	newSession(SessionData data)	Create a new Session object from pre-existing session data
void	put(java.lang.String id, Session session)	Put the Session object back into the session store.
Session	renewSessionId(java.lang.String oldId, java.lang.String newId)	Change the id of a Session.
void	setEvictionPolicy(int evictionTimeout)	-1 means we never evict inactive sessions.
void	setRemoveUnloadableSessions(boolean removeUnloadableSessions)	If a session's data cannot be loaded from the store without error, remove it from the persistent store.
void	setSaveOnCreate(boolean saveOnCreate)	Whether or not a session that is newly created should be immediately saved.
void	setSaveOnInactiveEviction(boolean saveOnEvict)	Whether or not a a session that is about to be evicted should be saved before being evicted.
void	setSessionDataStore(SessionDataStore sessionStore)	A SessionDataStore that is the authoritative source of session information.
java.lang.String	toString()

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 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, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.session.SessionCache

shutdown

Field Detail

_sessionDataStore

protected SessionDataStore _sessionDataStore

The authoritative source of session data

_handler

protected final SessionHandler _handler

The SessionHandler related to this SessionCache

_context

protected SessionContext _context

Information about the context to which this SessionCache pertains

_evictionPolicy

protected int _evictionPolicy

When, if ever, to evict sessions: never; only when the last request for them finishes; after inactivity time (expressed as secs)

_saveOnCreate

protected boolean _saveOnCreate

If true, as soon as a new session is created, it will be persisted to the SessionDataStore

_saveOnInactiveEviction

protected boolean _saveOnInactiveEviction

If true, a session that will be evicted from the cache because it has been inactive too long will be saved before being evicted.

_removeUnloadableSessions

protected boolean _removeUnloadableSessions

If true, a Session whose data cannot be read will be deleted from the SessionDataStore.

Constructor Detail

AbstractSessionCache

public AbstractSessionCache(SessionHandler handler)

Parameters:

handler - the SessionHandler to use

Method Detail

newSession

public abstract Session newSession(SessionData data)

Create a new Session object from pre-existing session data

Specified by:

newSession in interface SessionCache

Parameters:

data - the session data

Returns:

a new Session object

newSession

public abstract Session newSession(HttpServletRequest request,
                                   SessionData data)

Create a new Session for a request.

Parameters:

request - the request

data - the session data

Returns:

the new session

doGet

public abstract Session doGet(java.lang.String id)

Get the session matching the key

Parameters:

id - session id

Returns:

the Session object matching the id

doPutIfAbsent

public abstract Session doPutIfAbsent(java.lang.String id,
                                      Session session)

Put the session into the map if it wasn't already there

Parameters:

id - the identity of the session

session - the session object

Returns:

null if the session wasn't already in the map, or the existing entry otherwise

doReplace

public abstract boolean doReplace(java.lang.String id,
                                  Session oldValue,
                                  Session newValue)

Replace the mapping from id to oldValue with newValue

Parameters:

id - the id

oldValue - the old value

newValue - the new value

Returns:

true if replacement was done

doDelete

public abstract Session doDelete(java.lang.String id)

Remove the session with this identity from the store

Parameters:

id - the id

Returns:

true if removed false otherwise

getSessionHandler

public SessionHandler getSessionHandler()

Specified by:

getSessionHandler in interface SessionCache

Returns:

the SessionManger

initialize

public void initialize(SessionContext context)

Specified by:

initialize in interface SessionCache

Parameters:

context - the SessionContext to use for this cache

See Also:

SessionCache.initialize(org.eclipse.jetty.server.session.SessionContext)

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStart()

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

See Also:

AbstractLifeCycle.doStop()

getSessionDataStore

public SessionDataStore getSessionDataStore()

Specified by:

getSessionDataStore in interface SessionCache

Returns:

the SessionDataStore or null if there isn't one

setSessionDataStore

public void setSessionDataStore(SessionDataStore sessionStore)

Description copied from interface: SessionCache

A SessionDataStore that is the authoritative source of session information.

Specified by:

setSessionDataStore in interface SessionCache

Parameters:

sessionStore - the SessionDataStore to use

See Also:

SessionCache.setSessionDataStore(org.eclipse.jetty.server.session.SessionDataStore)

getEvictionPolicy

@ManagedAttribute(value="session eviction policy",
                  readonly=true)
public int getEvictionPolicy()

Specified by:

getEvictionPolicy in interface SessionCache

Returns:

the eviction policy

See Also:

SessionCache.getEvictionPolicy()

setEvictionPolicy

public void setEvictionPolicy(int evictionTimeout)

-1 means we never evict inactive sessions. 0 means we evict a session after the last request for it exits >0 is the number of seconds after which we evict inactive sessions from the cache

Specified by:

setEvictionPolicy in interface SessionCache

Parameters:

evictionTimeout - -1 is never evict; 0 is evict-on-exit; and any other positive value is the time in seconds that a session can be idle before it can be evicted.

See Also:

SessionCache.setEvictionPolicy(int)

isSaveOnCreate

@ManagedAttribute(value="immediately save new sessions",
                  readonly=true)
public boolean isSaveOnCreate()

Specified by:

isSaveOnCreate in interface SessionCache

Returns:

if true the newly created session will be saved immediately

setSaveOnCreate

public void setSaveOnCreate(boolean saveOnCreate)

Description copied from interface: SessionCache

Whether or not a session that is newly created should be immediately saved. If false, a session that is created and invalidated within a single request is never persisted.

Specified by:

setSaveOnCreate in interface SessionCache

Parameters:

saveOnCreate - true to immediately save the newly created session

isRemoveUnloadableSessions

@ManagedAttribute(value="delete unreadable stored sessions",
                  readonly=true)
public boolean isRemoveUnloadableSessions()

Specified by:

isRemoveUnloadableSessions in interface SessionCache

Returns:

true if sessions that can't be loaded are deleted from the store

setRemoveUnloadableSessions

public void setRemoveUnloadableSessions(boolean removeUnloadableSessions)

If a session's data cannot be loaded from the store without error, remove it from the persistent store.

Specified by:

setRemoveUnloadableSessions in interface SessionCache

Parameters:

removeUnloadableSessions - if true unloadable sessions will be removed from session store

get

public Session get(java.lang.String id)
            throws java.lang.Exception

Get a session object. If the session object is not in this session store, try getting the data for it from a SessionDataStore associated with the session manager.

Specified by:

get in interface SessionCache

Parameters:

id - the session id

Returns:

the Session if one exists, null otherwise

Throws:

java.lang.Exception - if any error occurred

See Also:

SessionCache.get(java.lang.String)

put

public void put(java.lang.String id,
                Session session)
         throws java.lang.Exception

Put the Session object back into the session store. This should be called when a request exists the session. Only when the last simultaneous request exists the session will any action be taken. If there is a SessionDataStore write the session data through to it. If the SessionDataStore supports passivation, call the passivate/active listeners. If the evictionPolicy == SessionCache.EVICT_ON_SESSION_EXIT then after we have saved the session, we evict it from the cache.

Specified by:

put in interface SessionCache

Parameters:

id - the session id

session - the current session object

Throws:

java.lang.Exception - if any error occurred

See Also:

SessionCache.put(java.lang.String, org.eclipse.jetty.server.session.Session)

exists

public boolean exists(java.lang.String id)
               throws java.lang.Exception

Check to see if a session corresponding to the id exists. This method will first check with the object store. If it doesn't exist in the object store (might be passivated etc), it will check with the data store.

Specified by:

exists in interface SessionCache

Parameters:

id - the session id

Returns:

true if the session exists, false otherwise

Throws:

java.lang.Exception - the Exception

See Also:

SessionCache.exists(java.lang.String)

contains

public boolean contains(java.lang.String id)
                 throws java.lang.Exception

Check to see if this cache contains an entry for the session corresponding to the session id.

Specified by:

contains in interface SessionCache

Parameters:

id - the session id

Returns:

true if a Session object matching the id is present in the cache, false otherwise

Throws:

java.lang.Exception - if any error occurred

See Also:

SessionCache.contains(java.lang.String)

delete

public Session delete(java.lang.String id)
               throws java.lang.Exception

Remove a session object from this store and from any backing store.

Specified by:

delete in interface SessionCache

Parameters:

id - the session id

Returns:

the Session that was removed, null otherwise

Throws:

java.lang.Exception - if any error occurred

See Also:

SessionCache.delete(java.lang.String)

checkExpiration

public java.util.Set<java.lang.String> checkExpiration(java.util.Set<java.lang.String> candidates)

Description copied from interface: SessionCache

Check a list of session ids that belong to potentially expired sessions. The Session in the cache should be checked, but also the SessionDataStore, as that is the authoritative source of all session information.

Specified by:

checkExpiration in interface SessionCache

Parameters:

candidates - the session ids to check

Returns:

the set of session ids that have actually expired: this can be a superset of the original candidate list.

See Also:

SessionCache.checkExpiration(Set)

checkInactiveSession

public void checkInactiveSession(Session session)

Check a session for being inactive and thus being able to be evicted, if eviction is enabled.

Specified by:

checkInactiveSession in interface SessionCache

Parameters:

session - session to check

renewSessionId

public Session renewSessionId(java.lang.String oldId,
                              java.lang.String newId)
                       throws java.lang.Exception

Description copied from interface: SessionCache

Change the id of a Session.

Specified by:

renewSessionId in interface SessionCache

Parameters:

oldId - the current session id

newId - the new session id

Returns:

the Session after changing its id

Throws:

java.lang.Exception - if any error occurred

See Also:

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

setSaveOnInactiveEviction

public void setSaveOnInactiveEviction(boolean saveOnEvict)

Description copied from interface: SessionCache

Whether or not a a session that is about to be evicted should be saved before being evicted.

Specified by:

setSaveOnInactiveEviction in interface SessionCache

Parameters:

saveOnEvict - true if the session should be saved before being evicted

See Also:

SessionCache.setSaveOnInactiveEviction(boolean)

isSaveOnInactiveEviction

@ManagedAttribute(value="save sessions before evicting from cache",
                  readonly=true)
public boolean isSaveOnInactiveEviction()

Whether we should save a session that has been inactive before we boot it from the cache.

Specified by:

isSaveOnInactiveEviction in interface SessionCache

Returns:

true if an inactive session will be saved before being evicted

newSession

public Session newSession(HttpServletRequest request,
                          java.lang.String id,
                          long time,
                          long maxInactiveMs)

Description copied from interface: SessionCache

Create an entirely new Session.

Specified by:

newSession in interface SessionCache

Parameters:

request - the request

id - the unique id associated to the session

time - the timestamp of the session creation

maxInactiveMs - the max inactive time in milliseconds

Returns:

a new Session

See Also:

SessionCache.newSession(javax.servlet.http.HttpServletRequest, java.lang.String, long, long)

toString

public java.lang.String toString()

Overrides:

toString in class org.eclipse.jetty.util.component.AbstractLifeCycle