org.eclipse.jetty.server.session

Interface SessionCache

All Superinterfaces:

LifeCycle

All Known Implementing Classes:

AbstractSessionCache, DefaultSessionCache, NullSessionCache

public interface SessionCache
extends LifeCycle

SessionCache A set of Session objects for a context that are actively being managed by this context instance. Multiple requests for the same session id on the same context should always share the same Session object from the SessionCache. The data for the Session objects is obtained from, and written to a SessionDataStore. It is assumed that the SessionDataStore is the authoritative source of session data:

• if the session data is not present in the SessionDataStore the session does not exist.
• if the session data is present in the SessionDataStore but its expiry time has passed then the session is deemed to have expired

Examples of SessionDataStores are relational or nosql databases, filesystems, or other distributed mechanisms. A SessionCache is optionally able to passivate a managed Session to the SessionDataStore and evict it from the cache if it has been in memory, but not accessed for a configurable amount of time. Implementations of the SessionCache may also implement different strategies for writing out Session data to the SessionDataStore.

Nested Class Summary

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVICT_ON_INACTIVITY
static int	EVICT_ON_SESSION_EXIT
static int	NEVER_EVICT

Method Summary

Modifier and Type	Method and Description
Set<String>	checkExpiration(Set<String> candidates)
void	checkInactiveSession(Session session)
boolean	contains(String id)
Session	delete(String id)
boolean	exists(String id)
Session	get(String id)
int	getEvictionPolicy()
SessionDataStore	getSessionDataStore()
SessionHandler	getSessionHandler()
void	initialize(SessionContext context)
boolean	isRemoveUnloadableSessions()
boolean	isSaveOnCreate()
boolean	isSaveOnInactiveEviction()
Session	newSession(HttpServletRequest request, String id, long time, long maxInactiveMs)
Session	newSession(SessionData data)
void	put(String id, Session session)
Session	renewSessionId(String oldId, String newId)
void	setEvictionPolicy(int policy)
void	setRemoveUnloadableSessions(boolean removeUnloadableSessions)
void	setSaveOnCreate(boolean saveOnCreate)
void	setSaveOnInactiveEviction(boolean saveOnEvict)
void	setSessionDataStore(SessionDataStore sds)
void	shutdown()

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

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

Field Detail

NEVER_EVICT

static final int NEVER_EVICT

See Also:

Constant Field Values

EVICT_ON_SESSION_EXIT

static final int EVICT_ON_SESSION_EXIT

See Also:

Constant Field Values

EVICT_ON_INACTIVITY

static final int EVICT_ON_INACTIVITY

See Also:

Constant Field Values

Method Detail

initialize

void initialize(SessionContext context)

getSessionHandler

SessionHandler getSessionHandler()

newSession

Session newSession(HttpServletRequest request,
                   String id,
                   long time,
                   long maxInactiveMs)

newSession

Session newSession(SessionData data)

renewSessionId

Session renewSessionId(String oldId,
                       String newId)
                throws Exception

Throws:

Exception

get

Session get(String id)
     throws Exception

Throws:

Exception

put

void put(String id,
         Session session)
  throws Exception

Throws:

Exception

contains

boolean contains(String id)
          throws Exception

Throws:

Exception

exists

boolean exists(String id)
        throws Exception

Throws:

Exception

delete

Session delete(String id)
        throws Exception

Throws:

Exception

shutdown

void shutdown()

checkExpiration

Set<String> checkExpiration(Set<String> candidates)

getSessionDataStore

SessionDataStore getSessionDataStore()

setSessionDataStore

void setSessionDataStore(SessionDataStore sds)

checkInactiveSession

void checkInactiveSession(Session session)

setEvictionPolicy

void setEvictionPolicy(int policy)

getEvictionPolicy

int getEvictionPolicy()

setSaveOnInactiveEviction

void setSaveOnInactiveEviction(boolean saveOnEvict)

isSaveOnInactiveEviction

boolean isSaveOnInactiveEviction()

setSaveOnCreate

void setSaveOnCreate(boolean saveOnCreate)

isSaveOnCreate

boolean isSaveOnCreate()

setRemoveUnloadableSessions

void setRemoveUnloadableSessions(boolean removeUnloadableSessions)

isRemoveUnloadableSessions

boolean isRemoveUnloadableSessions()