Package org.eclipse.jetty.server.session

Class FileSessionDataStore

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.FileSessionDataStore

All Implemented Interfaces:

SessionDataMap, SessionDataStore, Container, Destroyable, Dumpable, LifeCycle

@ManagedObject
public class FileSessionDataStore
extends AbstractSessionDataStore

FileSessionDataStore A file-based store of session data.

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.Container

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

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

_context, _gracePeriodSec, _lastExpiryCheckTime, _savePeriodSec

Constructor Summary

Constructors

Constructor	Description
FileSessionDataStore()

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.
protected void	doStart()
protected void	doStop()
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.
java.io.File	getStoreDir()
void	initializeStore()
boolean	isDeleteUnrestorableFiles()
boolean	isPassivating()	True if this type of datastore will passivate session objects
SessionData	load(java.lang.String id)	Read in session data.
void	setDeleteUnrestorableFiles(boolean deleteUnrestorableFiles)
void	setStoreDir(java.io.File storeDir)
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.server.session.AbstractSessionDataStore

checkStarted, getExpired, getGracePeriodSec, getSavePeriodSec, initialize, newSessionData, setGracePeriodSec, setSavePeriodSec, store

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

Constructor Detail

FileSessionDataStore

public FileSessionDataStore()

Method Detail

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class AbstractSessionDataStore

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class ContainerLifeCycle

Throws:

java.lang.Exception

getStoreDir

@ManagedAttribute(value="dir where sessions are stored",
                  readonly=true)
public java.io.File getStoreDir()

setStoreDir

public void setStoreDir(java.io.File storeDir)

isDeleteUnrestorableFiles

public boolean isDeleteUnrestorableFiles()

setDeleteUnrestorableFiles

public void setDeleteUnrestorableFiles(boolean deleteUnrestorableFiles)

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)

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)

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)

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)

initializeStore

public void initializeStore()

isPassivating

@ManagedAttribute(value="are sessions serialized by this store",
                  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)
               throws java.lang.Exception

Description copied from interface: SessionDataStore

Test if data exists for a given session id.

Parameters:

id - Identity of session whose existance should be checked

Returns:

true if valid, non-expired session exists

Throws:

java.lang.Exception - if problem checking existance with persistence layer

See Also:

SessionDataStore.exists(java.lang.String)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractSessionDataStore

See Also:

AbstractSessionDataStore.toString()