| org.apache.catalina.Store
All known Subclasses: org.apache.catalina.session.StoreBase, org.apache.catalina.session.JDBCStore, org.apache.catalina.session.FileStore,
| Store | | public interface Store (Code) | | A Store is the abstraction of a Catalina component that provides
persistent storage and loading of Sessions and their associated user data.
Implementations are free to save and load the Sessions to any media they
wish, but it is assumed that saved Sessions are persistent across
server or context restarts.
author:
Craig R. McClanahan
version:
$Revision: 1.2 $ $Date: 2004/02/27 14:58:39 $ |
| Method Summary | |
| public void | addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component. | | public void | clear()
Remove all Sessions from this Store. | | public String | getInfo()
Return descriptive information about this Store implementation and
the corresponding version number, in the format
<description>/<version>. | | public Manager | getManager()
Return the Manager instance associated with this Store. | | public int | getSize()
Return the number of Sessions present in this Store. | | public String[] | keys()
Return an array containing the session identifiers of all Sessions
currently saved in this Store. | | public Session | load(String id)
Load and return the Session associated with the specified session
identifier from this Store, without removing it. | | public void | remove(String id)
Remove the Session with the specified session identifier from
this Store, if present. | | public void | removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component. | | public void | save(Session session)
Save the specified Session into this Store. | | public void | setManager(Manager manager)
Set the Manager associated with this Store. |
| addPropertyChangeListener | | public void addPropertyChangeListener(PropertyChangeListener listener)(Code) | | Add a property change listener to this component.
Parameters:
listener - The listener to add |
| clear | | public void clear() throws IOException(Code) | | Remove all Sessions from this Store.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Store implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getManager | | public Manager getManager()(Code) | | Return the Manager instance associated with this Store.
|
| getSize | | public int getSize() throws IOException(Code) | | Return the number of Sessions present in this Store.
exception:
IOException - if an input/output error occurs |
| keys | | public String[] keys() throws IOException(Code) | | 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.
exception:
IOException - if an input/output error occurred |
| load | | public Session load(String id) throws ClassNotFoundException, IOException(Code) | | 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.
Parameters:
id - Session identifier of the session to load
exception:
ClassNotFoundException - if a deserialization error occurs
exception:
IOException - if an input/output error occurs |
| remove | | public void remove(String id) throws IOException(Code) | | Remove 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
exception:
IOException - if an input/output error occurs |
| removePropertyChangeListener | | public void removePropertyChangeListener(PropertyChangeListener listener)(Code) | | Remove a property change listener from this component.
Parameters:
listener - The listener to remove |
| save | | public void save(Session session) throws IOException(Code) | | Save the specified Session into this Store. Any previously saved
information for the associated session identifier is replaced.
Parameters:
session - Session to be saved
exception:
IOException - if an input/output error occurs |
| setManager | | public void setManager(Manager manager)(Code) | | Set the Manager associated with this Store.
Parameters:
manager - The Manager which will use this Store. |
|
|