Package org.apache.catalina.session
Class FileStore
- java.lang.Object
- 
- org.apache.catalina.util.LifecycleBase
- 
- org.apache.catalina.session.StoreBase
- 
- org.apache.catalina.session.FileStore
 
 
 
- 
 public final class FileStore extends StoreBase Concrete implementation of the Store interface that utilizes a file per saved Session in a configured directory. Sessions that are saved are still subject to being expired based on inactivity.- Author:
- Craig R. McClanahan
 
- 
- 
Nested Class Summary- 
Nested classes/interfaces inherited from interface org.apache.catalina.LifecycleLifecycle.SingleUse
 
- 
 - 
Field Summary- 
Fields inherited from interface org.apache.catalina.LifecycleAFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT
 
- 
 - 
Constructor SummaryConstructors Constructor Description FileStore()
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Remove all of the Sessions in this Store.java.lang.StringgetDirectory()intgetSize()Return the number of Sessions present in this Store.java.lang.StringgetStoreName()Return the name for this Store, used for logging.java.lang.StringgetThreadName()java.lang.String[]keys()Return an array containing the session identifiers of all Sessions currently saved in this Store.Sessionload(java.lang.String id)Load and return the Session associated with the specified session identifier from this Store, without removing it.voidremove(java.lang.String id)Remove the Session with the specified session identifier from this Store, if present.voidsave(Session session)Save the specified Session into this Store.voidsetDirectory(java.lang.String path)Set the directory path for this Store.- 
Methods inherited from class org.apache.catalina.session.StoreBaseaddPropertyChangeListener, destroyInternal, expiredKeys, getManager, getObjectInputStream, initInternal, processExpires, removePropertyChangeListener, setManager, startInternal, stopInternal, toString
 - 
Methods inherited from class org.apache.catalina.util.LifecycleBaseaddLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, getThrowOnFailure, init, removeLifecycleListener, setState, setState, setThrowOnFailure, start, stop
 
- 
 
- 
- 
- 
Method Detail- 
getDirectorypublic java.lang.String getDirectory() - Returns:
- The directory path for this Store.
 
 - 
setDirectorypublic void setDirectory(java.lang.String path) Set the directory path for this Store.- Parameters:
- path- The new directory path
 
 - 
getThreadNamepublic java.lang.String getThreadName() - Returns:
- The thread name for this Store.
 
 - 
getStoreNamepublic java.lang.String getStoreName() Return the name for this Store, used for logging.- Overrides:
- getStoreNamein class- StoreBase
- Returns:
- the name for this Store, used for logging.
 
 - 
getSizepublic int getSize() throws java.io.IOExceptionReturn the number of Sessions present in this Store.- Returns:
- the number of Sessions present in this Store.
- Throws:
- java.io.IOException- if an input/output error occurs
 
 - 
clearpublic void clear() throws java.io.IOExceptionRemove all of the Sessions in this Store.- Throws:
- java.io.IOException- if an input/output error occurs
 
 - 
keyspublic java.lang.String[] keys() throws java.io.IOExceptionReturn an array containing the session identifiers of all Sessions currently saved in this Store. If there are no such Sessions, a zero-length array is returned.- Returns:
- an array containing the session identifiers of all Sessions currently saved in this Store. If there are no such Sessions, a zero-length array is returned.
- Throws:
- java.io.IOException- if an input/output error occurred
 
 - 
loadpublic Session load(java.lang.String id) throws java.lang.ClassNotFoundException, java.io.IOException Load and return the Session associated with the specified session identifier from this Store, without removing it. If there is no such stored Session, returnnull.- Parameters:
- id- Session identifier of the session to load
- Returns:
- the loaded Session instance
- Throws:
- java.lang.ClassNotFoundException- if a deserialization error occurs
- java.io.IOException- if an input/output error occurs
 
 - 
removepublic void remove(java.lang.String id) throws java.io.IOExceptionRemove the Session with the specified session identifier from this Store, if present. If no such Session is present, this method takes no action.- Parameters:
- id- Session identifier of the Session to be removed
- Throws:
- java.io.IOException- if an input/output error occurs
 
 - 
savepublic void save(Session session) throws java.io.IOException Save the specified Session into this Store. Any previously saved information for the associated session identifier is replaced.- Parameters:
- session- Session to be saved
- Throws:
- java.io.IOException- if an input/output error occurs
 
 
- 
 
-