Package org.eclipse.jetty.server.session

Class NullSessionDataStore

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.session.AbstractSessionDataStore

org.eclipse.jetty.server.session.NullSessionDataStore

All Implemented Interfaces:

SessionDataMap, SessionDataStore, org.eclipse.jetty.util.component.LifeCycle

@ManagedObject
public class NullSessionDataStore
extends AbstractSessionDataStore

NullSessionDataStore Does not actually store anything, useful for testing.

Nested Class Summary

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 inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

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

_context, _gracePeriodSec, _lastExpiryCheckTime, _savePeriodSec

Constructor Summary

Constructors

Constructor	Description
NullSessionDataStore()

Method Summary

Modifier and Type	Method	Description
boolean	delete(java.lang.String id)	Delete session data
java.util.Set<java.lang.String>	doGetExpired(java.util.Set<java.lang.String> candidates)	Implemented by subclasses to resolve which sessions this node should attempt to expire.
void	doStore(java.lang.String id, SessionData data, long lastSaveTime)	Store the session data persistently.
boolean	exists(java.lang.String id)	Test if data exists for a given session id.
boolean	isPassivating()	True if this type of datastore will passivate session objects
SessionData	load(java.lang.String id)	Read in session data.
SessionData	newSessionData(java.lang.String id, long created, long accessed, long lastAccessed, long maxInactiveMs)	Create a new SessionData

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.server.session.AbstractSessionDataStore

checkStarted, doStart, getExpired, getGracePeriodSec, getSavePeriodSec, initialize, setGracePeriodSec, setSavePeriodSec, store, toString

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStop, 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

Constructor Detail

NullSessionDataStore

public NullSessionDataStore()

Method Detail

load

public SessionData load(java.lang.String id)
                 throws java.lang.Exception

Description copied from interface: SessionDataMap

Read in session data.

Parameters:

id - identity of session to load

Returns:

the SessionData matching the id

Throws:

java.lang.Exception - if unable to load session data

See Also:

SessionDataMap.load(java.lang.String)

newSessionData

public SessionData newSessionData(java.lang.String id,
                                  long created,
                                  long accessed,
                                  long lastAccessed,
                                  long maxInactiveMs)

Description copied from interface: SessionDataStore

Create a new SessionData

Specified by:

newSessionData in interface SessionDataStore

Overrides:

newSessionData in class AbstractSessionDataStore

Parameters:

id - the id

created - the timestamp when created

accessed - the timestamp when accessed

lastAccessed - the timestamp when last accessed

maxInactiveMs - the max inactive time in milliseconds

Returns:

a new SessionData object

See Also:

AbstractSessionDataStore.newSessionData(java.lang.String, long, long, long, long)

delete

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

Description copied from interface: SessionDataMap

Delete session data

Parameters:

id - identity of session to delete

Returns:

true if the session was deleted

Throws:

java.lang.Exception - if unable to delete session data

See Also:

SessionDataMap.delete(java.lang.String)

doStore

public void doStore(java.lang.String id,
                    SessionData data,
                    long lastSaveTime)
             throws java.lang.Exception

Description copied from class: AbstractSessionDataStore

Store the session data persistently.

Specified by:

doStore in class AbstractSessionDataStore

Parameters:

id - identity of session to store

data - info of the session

lastSaveTime - time of previous save or 0 if never saved

Throws:

java.lang.Exception - if unable to store data

See Also:

AbstractSessionDataStore.doStore(java.lang.String, org.eclipse.jetty.server.session.SessionData, long)

doGetExpired

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

Description copied from class: AbstractSessionDataStore

Implemented by subclasses to resolve which sessions this node should attempt to expire.

Specified by:

doGetExpired in class AbstractSessionDataStore

Parameters:

candidates - the ids of sessions the SessionDataStore thinks has expired

Returns:

the reconciled set of session ids that this node should attempt to expire

See Also:

SessionDataStore.getExpired(Set)

isPassivating

@ManagedAttribute(value="does this store serialize sessions",
                  readonly=true)
public boolean isPassivating()

Description copied from interface: SessionDataStore

True if this type of datastore will passivate session objects

Returns:

true if this store can passivate sessions, false otherwise

See Also:

SessionDataStore.isPassivating()

exists

public boolean exists(java.lang.String id)

Description copied from interface: SessionDataStore

Test if data exists for a given session id.

Parameters:

id - Identity of session whose existence should be checked

Returns:

true if valid, non-expired session exists

See Also:

SessionDataStore.exists(java.lang.String)