org.apache.catalina
public interface Manager
In order for a Manager
implementation to successfully operate
with a Context
implementation that implements reloading, it
must obey the following constraints:
Lifecycle
so that the Context can indicate
that a restart is required.
stop()
to be followed by a call to
start()
on the same Manager
instance.
Version: $Revision: 892545 $ $Date: 2009-12-20 02:04:17 +0100 (Sun, 20 Dec 2009) $
Method Summary | |
---|---|
void | add(Session session)
Add this Session to the set of active Sessions for this Manager.
|
void | addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.
|
void | backgroundProcess()
This method will be invoked by the context/container on a periodic
basis and allows the manager to implement
a method that executes periodic tasks, such as expiring sessions etc. |
void | changeSessionId(Session session)
Change the session ID of the current session to a new randomly generated
session ID.
|
Session | createEmptySession()
Get a session from the recycled ones or create a new empty one.
|
Session | createSession()
Construct and return a new session object, based on the default
settings specified by this Manager's properties. |
Session | createSession(String sessionId)
Construct and return a new session object, based on the default
settings specified by this Manager's properties. |
Session | findSession(String id)
Return the active Session, associated with this Manager, with the
specified session id (if any); otherwise return null .
|
Session[] | findSessions()
Return the set of active Sessions associated with this Manager.
|
int | getActiveSessions()
Gets the number of currently active sessions.
|
Container | getContainer()
Return the Container with which this Manager is associated. |
boolean | getDistributable()
Return the distributable flag for the sessions supported by
this Manager. |
int | getExpiredSessions()
Gets the number of sessions that have expired.
|
String | getInfo()
Return descriptive information about this Manager implementation and
the corresponding version number, in the format
<description>/<version> . |
int | getMaxActive()
Gets the maximum number of sessions that have been active at the same
time.
|
int | getMaxInactiveInterval()
Return the default maximum inactive interval (in seconds)
for Sessions created by this Manager. |
int | getRejectedSessions()
Gets the number of sessions that were not created because the maximum
number of active sessions was reached.
|
int | getSessionAverageAliveTime()
Gets the average time (in seconds) that expired sessions had been
alive.
|
int | getSessionCounter()
Returns the total number of sessions created by this manager.
|
int | getSessionIdLength()
Gets the session id length (in bytes) of Sessions created by
this Manager.
|
int | getSessionMaxAliveTime()
Gets the longest time (in seconds) that an expired session had been
alive.
|
void | load()
Load any currently active sessions that were previously unloaded
to the appropriate persistence mechanism, if any. |
void | remove(Session session)
Remove this Session from the active Sessions for this Manager.
|
void | removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.
|
void | setContainer(Container container)
Set the Container with which this Manager is associated.
|
void | setDistributable(boolean distributable)
Set the distributable flag for the sessions supported by this
Manager. |
void | setExpiredSessions(int expiredSessions)
Sets the number of sessions that have expired.
|
void | setMaxActive(int maxActive)
(Re)sets the maximum number of sessions that have been active at the
same time.
|
void | setMaxInactiveInterval(int interval)
Set the default maximum inactive interval (in seconds)
for Sessions created by this Manager.
|
void | setRejectedSessions(int rejectedSessions)
Sets the number of sessions that were not created because the maximum
number of active sessions was reached.
|
void | setSessionAverageAliveTime(int sessionAverageAliveTime)
Sets the average time (in seconds) that expired sessions had been
alive.
|
void | setSessionCounter(int sessionCounter)
Sets the total number of sessions created by this manager.
|
void | setSessionIdLength(int idLength)
Sets the session id length (in bytes) for Sessions created by this
Manager.
|
void | setSessionMaxAliveTime(int sessionMaxAliveTime)
Sets the longest time (in seconds) that an expired session had been
alive.
|
void | unload()
Save any currently active sessions in the appropriate persistence
mechanism, if any. |
Parameters: session Session to be added
Parameters: listener The listener to add
Parameters: session The session to change the session ID for
Deprecated:
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, returnnull
.
Throws: IllegalStateException if a new session cannot be instantiated for any reason
null
.
Parameters: sessionId The session id which should be used to create the
new session; if null
, the session
id will be assigned by this method, and available via the getId()
method of the returned session.
Throws: IllegalStateException if a new session cannot be instantiated for any reason
null
.
Parameters: id The session id for the session to be returned
Throws: IllegalStateException if a new session cannot be instantiated for any reason IOException if an input/output error occurs while processing this request
Returns: Number of currently active sessions
Returns: Number of sessions that have expired
<description>/<version>
.Returns: Maximum number of sessions that have been active at the same time
Returns: Number of rejected sessions
Returns: Average time (in seconds) that expired sessions had been alive.
Returns: Total number of sessions created by this manager.
Returns: The session id length
Returns: Longest time (in seconds) that an expired session had been alive.
Throws: ClassNotFoundException if a serialized class cannot be found during the reload IOException if an input/output error occurs
Parameters: session Session to be removed
Parameters: listener The listener to remove
Parameters: container The newly associated Container
Parameters: distributable The new distributable flag
Parameters: expiredSessions Number of sessions that have expired
Parameters: maxActive Maximum number of sessions that have been active at the same time.
Parameters: interval The new default value
Parameters: rejectedSessions Number of rejected sessions
Parameters: sessionAverageAliveTime Average time (in seconds) that expired sessions had been alive.
Parameters: sessionCounter Total number of sessions created by this manager.
Parameters: idLength The session id length
Parameters: sessionMaxAliveTime Longest time (in seconds) that an expired session had been alive.
Throws: IOException if an input/output error occurs