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

LifeCycle.Listener

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

Container.InheritedListener, Container.Listener

Field Summary

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

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
FileSessionDataStore()

Method Summary

Modifier and Type	Method and Description
boolean	delete(String id) Delete a session
boolean	deleteFile(String filename) Delete the file associated with a session
Set<String>	doGetExpired(Set<String> candidates) Check to see which sessions have expired.
SessionData	doLoad(String id) Load the session from persistent store.
void	doStore(String id, SessionData data, long lastSaveTime) Store the session data persistently.
boolean	exists(String id) Test if data exists for a given session id.
File	getStoreDir()
void	initialize(SessionContext context) Initialize this data map for the given context.
void	initializeStore() Read the names of the existing session files and build a map of fully qualified session ids (ie with context) to filename.
boolean	isDeleteUnrestorableFiles()
boolean	isPassivating() True if this type of datastore will passivate session objects
void	setDeleteUnrestorableFiles(boolean deleteUnrestorableFiles)
void	setStoreDir(File storeDir)
void	sweepDisk() Check all session files that do not belong to this context and remove any that expired long ago (ie at least 5 gracePeriods ago).
void	sweepFile(long now, Path p) Check to see if the expiry on the file is very old, and delete the file if so.
String	toString()

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

getExpired, getGracePeriodSec, getSavePeriodSec, load, newSessionData, setGracePeriodSec, setSavePeriodSec, store

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans

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 java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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 interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Constructor Detail

FileSessionDataStore

public FileSessionDataStore()

Method Detail

initialize

public void initialize(SessionContext context)
                throws Exception

Description copied from interface: SessionDataMap

Initialize this data map for the given context. A SessionDataMap can only be used by one context(/session manager).

Specified by:

initialize in interface SessionDataMap

Overrides:

initialize in class AbstractSessionDataStore

Parameters:

context - context associated

Throws:

Exception - if unable to initialize the

getStoreDir

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

setStoreDir

public void setStoreDir(File storeDir)

isDeleteUnrestorableFiles

public boolean isDeleteUnrestorableFiles()

setDeleteUnrestorableFiles

public void setDeleteUnrestorableFiles(boolean deleteUnrestorableFiles)

delete

public boolean delete(String id)
               throws Exception

Delete a session

Parameters:

id - session id

Returns:

true if the session was deleted

Throws:

Exception - if unable to delete session data

deleteFile

public boolean deleteFile(String filename)
                   throws Exception

Delete the file associated with a session

Parameters:

filename - name of the file containing the session's information

Returns:

true if file was deleted, false otherwise

Throws:

Exception - indicating delete failure

doGetExpired

public Set<String> doGetExpired(Set<String> candidates)

Check to see which sessions have expired.

Specified by:

doGetExpired in class AbstractSessionDataStore

Parameters:

candidates - the set of session ids that the SessionCache believes have expired

Returns:

the complete set of sessions that have expired, including those that are not currently loaded into the SessionCache

sweepDisk

public void sweepDisk()

Check all session files that do not belong to this context and remove any that expired long ago (ie at least 5 gracePeriods ago).

sweepFile

public void sweepFile(long now,
                      Path p)
               throws Exception

Check to see if the expiry on the file is very old, and delete the file if so. "Old" means that it expired at least 5 gracePeriods ago. The session can belong to any context.

Parameters:

now - the time now in msec

p - the file to check

Throws:

Exception - indicating error in sweep

doLoad

public SessionData doLoad(String id)
                   throws Exception

Description copied from class: AbstractSessionDataStore

Load the session from persistent store.

Specified by:

doLoad in class AbstractSessionDataStore

Parameters:

id - the id of the session to load

Returns:

the re-inflated session

Throws:

Exception - if unable to load the session

doStore

public void doStore(String id,
                    SessionData data,
                    long lastSaveTime)
             throws 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:

Exception - if unable to store data

initializeStore

public void initializeStore()
                     throws Exception

Read the names of the existing session files and build a map of fully qualified session ids (ie with context) to filename. If there is more than one file for the same session, only the most recently modified will be kept and the rest deleted. At the same time, any files - for any context - that expired a long time ago will be cleaned up.

Throws:

Exception - if storeDir doesn't exist, isn't readable/writeable or contains 2 files with the same lastmodify time for the same session. Throws IOException if the lastmodifytimes can't be read.

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

exists

public boolean exists(String id)
               throws Exception

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

Throws:

Exception - if problem checking existence with persistence layer

toString

public String toString()

Overrides:

toString in class AbstractSessionDataStore