| org.apache.catalina.Manager
All known Subclasses: org.apache.catalina.session.ManagerBase,
| Manager | | public interface Manager (Code) | | A Manager manages the pool of Sessions that are associated with a
particular Container. Different Manager implementations may support
value-added features such as the persistent storage of session data,
as well as migrating sessions for distributable web applications.
In order for a Manager implementation to successfully operate
with a Context implementation that implements reloading, it
must obey the following constraints:
- Must implement
Lifecycle so that the Context can indicate
that a restart is required.
- Must allow a call to
stop() to be followed by a call to
start() on the same Manager instance.
author:
Craig R. McClanahan
version:
$Revision: 1.5 $ $Date: 2001/07/22 20:13:30 $ |
| Method Summary | |
| public void | add(Session session)
Add this Session to the set of active Sessions for this Manager. | | public void | addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component. | | public Session | createSession()
Construct and return a new session object, based on the default
settings specified by this Manager's properties. | | public Session | findSession(String id)
Return the active Session, associated with this Manager, with the
specified session id (if any); otherwise return null. | | public Session[] | findSessions()
Return the set of active Sessions associated with this Manager. | | public Container | getContainer()
Return the Container with which this Manager is associated. | | public boolean | getDistributable()
Return the distributable flag for the sessions supported by
this Manager. | | public String | getInfo()
Return descriptive information about this Manager implementation and
the corresponding version number, in the format
<description>/<version>. | | public int | getMaxInactiveInterval()
Return the default maximum inactive interval (in seconds)
for Sessions created by this Manager. | | public void | load()
Load any currently active sessions that were previously unloaded
to the appropriate persistence mechanism, if any. | | public void | remove(Session session)
Remove this Session from the active Sessions for this Manager. | | public void | removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component. | | public void | setContainer(Container container)
Set the Container with which this Manager is associated. | | public void | setDistributable(boolean distributable)
Set the distributable flag for the sessions supported by this
Manager. | | public void | setMaxInactiveInterval(int interval)
Set the default maximum inactive interval (in seconds)
for Sessions created by this Manager. | | public void | unload()
Save any currently active sessions in the appropriate persistence
mechanism, if any. |
| add | | public void add(Session session)(Code) | | Add this Session to the set of active Sessions for this Manager.
Parameters:
session - Session to be added |
| addPropertyChangeListener | | public void addPropertyChangeListener(PropertyChangeListener listener)(Code) | | Add a property change listener to this component.
Parameters:
listener - The listener to add |
| createSession | | public Session createSession()(Code) | | Construct and return a new session object, based on the default
settings specified by this Manager's properties. The session
id will be assigned by this method, and available via the getId()
method of the returned session. If a new session cannot be created
for any reason, return null.
exception:
IllegalStateException - if a new session cannot beinstantiated for any reason |
| findSession | | public Session findSession(String id) throws IOException(Code) | | Return the active Session, associated with this Manager, with the
specified session id (if any); otherwise return null.
Parameters:
id - The session id for the session to be returned
exception:
IllegalStateException - if a new session cannot beinstantiated for any reason
exception:
IOException - if an input/output error occurs whileprocessing this request |
| findSessions | | public Session[] findSessions()(Code) | | Return the set of active Sessions associated with this Manager.
If this Manager has no active Sessions, a zero-length array is returned.
|
| getContainer | | public Container getContainer()(Code) | | Return the Container with which this Manager is associated.
|
| getDistributable | | public boolean getDistributable()(Code) | | Return the distributable flag for the sessions supported by
this Manager.
|
| getInfo | | public String getInfo()(Code) | | Return descriptive information about this Manager implementation and
the corresponding version number, in the format
<description>/<version>.
|
| getMaxInactiveInterval | | public int getMaxInactiveInterval()(Code) | | Return the default maximum inactive interval (in seconds)
for Sessions created by this Manager.
|
| load | | public void load() throws ClassNotFoundException, IOException(Code) | | Load any currently active sessions that were previously unloaded
to the appropriate persistence mechanism, if any. If persistence is not
supported, this method returns without doing anything.
exception:
ClassNotFoundException - if a serialized class cannot befound during the reload
exception:
IOException - if an input/output error occurs |
| remove | | public void remove(Session session)(Code) | | Remove this Session from the active Sessions for this Manager.
Parameters:
session - Session to be removed |
| removePropertyChangeListener | | public void removePropertyChangeListener(PropertyChangeListener listener)(Code) | | Remove a property change listener from this component.
Parameters:
listener - The listener to remove |
| setContainer | | public void setContainer(Container container)(Code) | | Set the Container with which this Manager is associated.
Parameters:
container - The newly associated Container |
| setDistributable | | public void setDistributable(boolean distributable)(Code) | | Set the distributable flag for the sessions supported by this
Manager. If this flag is set, all user data objects added to
sessions associated with this manager must implement Serializable.
Parameters:
distributable - The new distributable flag |
| setMaxInactiveInterval | | public void setMaxInactiveInterval(int interval)(Code) | | Set the default maximum inactive interval (in seconds)
for Sessions created by this Manager.
Parameters:
interval - The new default value |
| unload | | public void unload() throws IOException(Code) | | Save any currently active sessions in the appropriate persistence
mechanism, if any. If persistence is not supported, this method
returns without doing anything.
exception:
IOException - if an input/output error occurs |
|
|