Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.catalina.session.ManagerBase
org.apache.catalina.session.StandardManager
start()
and
stop()
methods of this class at the correct times.
Field Summary | |
protected int |
|
protected static String |
|
protected LifecycleSupport |
|
protected int |
|
protected static String |
|
protected String |
|
protected long |
|
protected int |
|
protected boolean |
|
Fields inherited from class org.apache.catalina.session.ManagerBase | |
DEFAULT_ALGORITHM , algorithm , container , debug , defaultContext , devRandomSource , digest , distributable , domain , duplicates , entropy , initialized , log , maxActive , maxInactiveInterval , mserver , name , oname , random , randomClass , randomIS , sessionCounter , sessionIdLength , sessions , sm , support |
Fields inherited from interface org.apache.catalina.Lifecycle | |
AFTER_START_EVENT , AFTER_STOP_EVENT , BEFORE_START_EVENT , BEFORE_STOP_EVENT , START_EVENT , STOP_EVENT |
Method Summary | |
void |
|
void |
|
Session |
|
protected void |
|
protected void |
|
protected File |
|
LifecycleListener[] |
|
int |
|
String |
|
int |
|
String |
|
String |
|
long | |
int |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
protected int expiredSessions
Number of sessions that expired.
protected static final String info
The descriptive information about this implementation.
protected int maxActiveSessions
The maximum number of active Sessions allowed, or -1 for no limit.
protected static String name
The descriptive name of this Manager implementation (for logging).
protected String pathname
Path name of the disk file in which active sessions are saved when we stop, and from which these sessions are loaded when we start. Anull
value indicates that no persistence is desired. If this pathname is relative, it will be resolved against the temporary working directory provided by our context, available via thejavax.servlet.context.tempdir
context attribute.
protected long processingTime
Processing time during session expiration.
protected int rejectedSessions
Number of session creations that failed due to maxActiveSessions.
protected boolean started
Has this component been started yet?
public void addLifecycleListener(LifecycleListener listener)
Add a lifecycle event listener to this component.
- Specified by:
- addLifecycleListener in interface Lifecycle
- Parameters:
listener
- The listener to add
public void backgroundProcess()
Implements the Manager interface, direct call to processExpires
- Specified by:
- backgroundProcess in interface Manager
- Overrides:
- backgroundProcess in interface ManagerBase
public Session createSession()
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
.
- Specified by:
- createSession in interface Manager
- Overrides:
- createSession in interface ManagerBase
protected void doLoad() throws ClassNotFoundException, IOException
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.
protected void doUnload() throws IOException
Save any currently active sessions in the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything.
protected File file()
Return a File object representing the pathname to our persistence file, if any.
public LifecycleListener[] findLifecycleListeners()
Get the lifecycle listeners associated with this lifecycle. If this Lifecycle has no listeners registered, a zero-length array is returned.
- Specified by:
- findLifecycleListeners in interface Lifecycle
public int getExpiredSessions()
Number of sessions that expired.
- Specified by:
- getExpiredSessions in interface Manager
- Returns:
- The count
public String getInfo()
Return descriptive information about this Manager implementation and the corresponding version number, in the format<description>/<version>
.
- Overrides:
- getInfo in interface ManagerBase
public int getMaxActiveSessions()
Return the maximum number of active Sessions allowed, or -1 for no limit.
public String getName()
Return the descriptive short name of this Manager implementation.
- Overrides:
- getName in interface ManagerBase
public String getPathname()
Return the session persistence pathname, if any.
public long getProcessingTime()
public int getRejectedSessions()
Number of session creations that failed due to maxActiveSessions
- Specified by:
- getRejectedSessions in interface Manager
- Returns:
- The count
public void load() throws ClassNotFoundException, IOException
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.
public void processExpires()
Invalidate all sessions that have expired.
public void propertyChange(PropertyChangeEvent event)
Process property change events from our associated Context.
- Parameters:
event
- The property change event that has occurred
public void removeLifecycleListener(LifecycleListener listener)
Remove a lifecycle event listener from this component.
- Specified by:
- removeLifecycleListener in interface Lifecycle
- Parameters:
listener
- The listener to remove
public void setContainer(Container container)
Set the Container with which this Manager has been associated. If it is a Context (the usual case), listen for changes to the session timeout property.
- Specified by:
- setContainer in interface Manager
- Overrides:
- setContainer in interface ManagerBase
- Parameters:
container
- The associated Container
public void setExpiredSessions(int expiredSessions)
- Specified by:
- setExpiredSessions in interface Manager
public void setMaxActiveSessions(int max)
Set the maximum number of actives Sessions allowed, or -1 for no limit.
- Parameters:
max
- The new maximum number of sessions
public void setPathname(String pathname)
Set the session persistence pathname to the specified value. If no persistence support is desired, set the pathname tonull
.
- Parameters:
pathname
- New session persistence pathname
public void setProcessingTime(long processingTime)
public void setRejectedSessions(int rejectedSessions)
- Specified by:
- setRejectedSessions in interface Manager
public void start() throws LifecycleException
Prepare for the beginning of active use of the public methods of this component. This method should be called afterconfigure()
, and before any of the public methods of the component are utilized.
- Throws:
LifecycleException
- if this component detects a fatal error that prevents this component from being used
public void stop() throws LifecycleException
Gracefully terminate the active use of the public methods of this component. This method should be the last one called on a given instance of this component.
- Throws:
LifecycleException
- if this component detects a fatal error that needs to be reported