|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Object
|
+--org.apache.catalina.session.ManagerBase
|
+--org.apache.catalina.session.StandardManager
Standard implementation of the Manager interface that provides simple session persistence across restarts of this component (such as when the entire server is shut down and restarted, or when a particular web application is reloaded.
IMPLEMENTATION NOTE: Correct behavior of session storing and
reloading depends upon external calls to the start() and
stop() methods of this class at the correct times.
| Field Summary | |
protected LifecycleSupport |
lifecycle
The lifecycle event support for this component. |
protected static java.lang.String |
name
The descriptive name of this Manager implementation (for logging). |
| Fields inherited from class org.apache.catalina.session.ManagerBase |
algorithm, container, debug, DEFAULT_ALGORITHM, digest, distributable, entropy, maxInactiveInterval, random, randomClass, recycled, SESSION_ID_BYTES, sessions, sm, support |
| Fields inherited from interface org.apache.catalina.Lifecycle |
START_EVENT, STOP_EVENT |
| Constructor Summary | |
StandardManager()
|
|
| Method Summary | |
void |
addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component. |
Session |
createSession()
Construct and return a new session object, based on the default settings specified by this Manager's properties. |
int |
getCheckInterval()
Return the check interval (in seconds) for this Manager. |
java.lang.String |
getInfo()
Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>. |
int |
getMaxActiveSessions()
Return the maximum number of active Sessions allowed, or -1 for no limit. |
java.lang.String |
getName()
Return the descriptive short name of this Manager implementation. |
java.lang.String |
getPathname()
Return the session persistence pathname, if any. |
void |
load()
Load any currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any. |
void |
propertyChange(java.beans.PropertyChangeEvent event)
Process property change events from our associated Context. |
void |
removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component. |
void |
run()
The background thread that checks for session timeouts and shutdown. |
void |
setCheckInterval(int checkInterval)
Set the check interval (in seconds) for this Manager. |
void |
setContainer(Container container)
Set the Container with which this Manager has been associated. |
void |
setMaxActiveSessions(int max)
Set the maximum number of actives Sessions allowed, or -1 for no limit. |
void |
setPathname(java.lang.String pathname)
Set the session persistence pathname to the specified value. |
void |
start()
Prepare for the beginning of active use of the public methods of this component. |
void |
stop()
Gracefully terminate the active use of the public methods of this component. |
void |
unload()
Save any currently active sessions in the appropriate persistence mechanism, if any. |
| Methods inherited from class org.apache.catalina.session.ManagerBase |
add, addPropertyChangeListener, findSession, findSessions, generateSessionId, getAlgorithm, getContainer, getDebug, getDigest, getDistributable, getEngine, getEntropy, getJvmRoute, getMaxInactiveInterval, getRandom, getRandomClass, remove, removePropertyChangeListener, setAlgorithm, setDebug, setDistributable, setEntropy, setMaxInactiveInterval, setRandomClass |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
protected LifecycleSupport lifecycle
protected static java.lang.String name
| Constructor Detail |
public StandardManager()
| Method Detail |
public int getCheckInterval()
public void setCheckInterval(int checkInterval)
checkInterval - The new check intervalpublic void setContainer(Container container)
setContainer in class ManagerBasecontainer - The associated Containerpublic java.lang.String getInfo()
<description>/<version>.getInfo in class ManagerBasepublic int getMaxActiveSessions()
public void setMaxActiveSessions(int max)
max - The new maximum number of sessionspublic java.lang.String getName()
getName in class ManagerBasepublic java.lang.String getPathname()
public void setPathname(java.lang.String pathname)
null.pathname - New session persistence pathnamepublic Session createSession()
null.createSession in class ManagerBasejava.lang.IllegalStateException - if a new session cannot be
instantiated for any reason
public void load()
throws java.lang.ClassNotFoundException,
java.io.IOException
java.lang.ClassNotFoundException - if a serialized class cannot be
found during the reloadjava.io.IOException - if an input/output error occurs
public void unload()
throws java.io.IOException
java.io.IOException - if an input/output error occurspublic void addLifecycleListener(LifecycleListener listener)
addLifecycleListener in interface Lifecyclelistener - The listener to addpublic void removeLifecycleListener(LifecycleListener listener)
removeLifecycleListener in interface Lifecyclelistener - The listener to remove
public void start()
throws LifecycleException
configure(),
and before any of the public methods of the component are utilized.start in interface Lifecyclejava.lang.IllegalStateException - if this component has already been
startedLifecycleException - if this component detects a fatal error
that prevents this component from being used
public void stop()
throws LifecycleException
stop in interface Lifecyclejava.lang.IllegalStateException - if this component has not been startedLifecycleException - if this component detects a fatal error
that needs to be reportedpublic void propertyChange(java.beans.PropertyChangeEvent event)
propertyChange in interface java.beans.PropertyChangeListenerevent - The property change event that has occurredpublic void run()
run in interface java.lang.Runnable
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||