org.apache.catalina.session
Class FileStore
- Lifecycle, Store
public final class FileStore
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.
Version:
- Craig R. McClanahan
void | clear() - Remove all of the Sessions in this Store.
|
String | getDirectory() - Return the directory path for this Store.
|
String | getInfo() - Return descriptive information about this Store implementation and
the corresponding version number, in the format
<description>/<version> .
|
int | getSize() - Return the number of Sessions present in this Store.
|
String | getStoreName() - Return the name for this Store, used for logging.
|
String | getThreadName() - Return the thread name for this Store.
|
String[] | keys() - Return an array containing the session identifiers of all Sessions
currently saved in this Store.
|
Session | load(String id) - Load and return the Session associated with the specified session
identifier from this Store, without removing it.
|
void | remove(String id) - Remove the Session with the specified session identifier from
this Store, if present.
|
void | save(Session session) - Save the specified Session into this Store.
|
void | setDirectory(String path) - Set the directory path for this Store.
|
addLifecycleListener , addPropertyChangeListener , findLifecycleListeners , getDebug , getInfo , getManager , getStoreName , log , processExpires , removeLifecycleListener , removePropertyChangeListener , setDebug , setManager , start , stop |
clear
public void clear()
throws IOException
Remove all of the Sessions in this Store.
- clear in interface Store
getDirectory
public String getDirectory()
Return the directory path for this Store.
getInfo
public String getInfo()
Return descriptive information about this Store implementation and
the corresponding version number, in the format
<description>/<version>
.
- getInfo in interface Store
- getInfo in interface StoreBase
getSize
public int getSize()
throws IOException
Return the number of Sessions present in this Store.
- getSize in interface Store
getStoreName
public String getStoreName()
Return the name for this Store, used for logging.
- getStoreName in interface StoreBase
getThreadName
public String getThreadName()
Return the thread name for this Store.
keys
public String[] keys()
throws IOException
Return 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.
- keys in interface Store
load
public Session load(String id)
throws ClassNotFoundException,
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, return null
.
- load in interface Store
id
- Session identifier of the session to load
remove
public void remove(String id)
throws IOException
Remove the Session with the specified session identifier from
this Store, if present. If no such Session is present, this method
takes no action.
- remove in interface Store
id
- Session identifier of the Session to be removed
save
public void save(Session session)
throws IOException
Save the specified Session into this Store. Any previously saved
information for the associated session identifier is replaced.
- save in interface Store
session
- Session to be saved
setDirectory
public void setDirectory(String path)
Set the directory path for this Store.
path
- The new directory path
Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.