Package com.aspectran.core.component.session

Class FileSessionStore

java.lang.Object

com.aspectran.core.component.AbstractComponent

com.aspectran.core.component.session.AbstractSessionStore

com.aspectran.core.component.session.FileSessionStore

All Implemented Interfaces:

Component, SessionStore

public class FileSessionStore
extends AbstractSessionStore

A file-based store of session data.

Constructor Summary

Constructors

Constructor	Description
FileSessionStore()

Method Summary

Modifier and Type	Method	Description
boolean	delete(java.lang.String id)	Delete session data.
protected void	doDestroy()
java.util.Set<java.lang.String>	doGetExpired(java.util.Set<java.lang.String> candidates)	Check to see which sessions have expired.
protected void	doInitialize()
void	doSave(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()
boolean	isDeleteUnrestorableFiles()
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 com.aspectran.core.component.session.AbstractSessionStore

checkAlreadyInitialized, getExpired, getGracePeriodSecs, getLastExpiryCheckTime, getNonPersistentAttributes, getSavePeriodSecs, isNonPersistentAttributes, save, setGracePeriodSecs, setNonPersistentAttributes, setSavePeriodSecs

Methods inherited from class com.aspectran.core.component.AbstractComponent

destroy, getComponentName, initialize, isAvailable, isDestroyed, isDestroying, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspectran.core.component.Component

destroy, getComponentName, initialize, isAvailable, isDestroyed, isDestroying, isInitialized

Constructor Detail

FileSessionStore

public FileSessionStore()

Method Detail

getStoreDir

public java.io.File getStoreDir()

setStoreDir

public void setStoreDir(java.io.File storeDir)

isDeleteUnrestorableFiles

public boolean isDeleteUnrestorableFiles()

setDeleteUnrestorableFiles

public void setDeleteUnrestorableFiles(boolean deleteUnrestorableFiles)

load

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

Description copied from interface: SessionStore

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

delete

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

Description copied from interface: SessionStore

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

exists

public boolean exists(java.lang.String id)

Description copied from interface: SessionStore

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

doSave

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

Description copied from class: AbstractSessionStore

Store the session data persistently.

Specified by:

doSave in class AbstractSessionStore

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

doGetExpired

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

Check to see which sessions have expired.

Specified by:

doGetExpired in class AbstractSessionStore

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

doInitialize

protected void doInitialize()
                     throws java.lang.Exception

Specified by:

doInitialize in class AbstractComponent

Throws:

java.lang.Exception

doDestroy

protected void doDestroy()

Specified by:

doDestroy in class AbstractComponent

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object