File	Doc	Category	Size	Date	Package
Manager.java	API Doc	Apache Tomcat 6.0.14	11313	Fri Jul 20 04:20:36 BST 2007	org.apache.catalina

Manager

Fields Summary

Constructors Summary

Methods Summary
public void	add(Session session) Add this Session to the set of active Sessions for this Manager. param session Session to be added
public void	addPropertyChangeListener(java.beans.PropertyChangeListener listener) Add a property change listener to this component. param listener The listener to add
public 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.
public Session	createEmptySession() Get a session from the recycled ones or create a new empty one. The PersistentManager manager does not need to create session data because it reads it from the Store.
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, return null. exception IllegalStateException if a new session cannot be instantiated for any reason deprecated
public Session	createSession(java.lang.String sessionId) Construct and return a new session object, based on the default settings specified by this Manager's properties. The session id specified will be used as the session id. If a new session cannot be created for any reason, return null. param 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. exception IllegalStateException if a new session cannot be instantiated for any reason
public Session	findSession(java.lang.String id) Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return null. param id The session id for the session to be returned exception IllegalStateException if a new session cannot be instantiated for any reason exception IOException if an input/output error occurs while processing this request
public Session[]	findSessions() Return the set of active Sessions associated with this Manager. If this Manager has no active Sessions, a zero-length array is returned.
public int	getActiveSessions() Gets the number of currently active sessions. return Number of currently active sessions
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 int	getExpiredSessions() Gets the number of sessions that have expired. return Number of sessions that have expired
public java.lang.String	getInfo() Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.
public int	getMaxActive() Gets the maximum number of sessions that have been active at the same time. return Maximum number of sessions that have been active at the same time
public int	getMaxInactiveInterval() Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.
public int	getRejectedSessions() Gets the number of sessions that were not created because the maximum number of active sessions was reached. return Number of rejected sessions
public int	getSessionAverageAliveTime() Gets the average time (in seconds) that expired sessions had been alive. return Average time (in seconds) that expired sessions had been alive.
public int	getSessionCounter() Returns the total number of sessions created by this manager. return Total number of sessions created by this manager.
public int	getSessionIdLength() Gets the session id length (in bytes) of Sessions created by this Manager. return The session id length
public int	getSessionMaxAliveTime() Gets the longest time (in seconds) that an expired session had been alive. return Longest time (in seconds) that an expired session had been alive.
public void	load() 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 be found during the reload exception IOException if an input/output error occurs
public void	remove(Session session) Remove this Session from the active Sessions for this Manager. param session Session to be removed
public void	removePropertyChangeListener(java.beans.PropertyChangeListener listener) Remove a property change listener from this component. param listener The listener to remove
public void	setContainer(Container container) Set the Container with which this Manager is associated. param container The newly associated Container
public void	setDistributable(boolean distributable) 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. param distributable The new distributable flag
public void	setExpiredSessions(int expiredSessions) Sets the number of sessions that have expired. param expiredSessions Number of sessions that have expired
public void	setMaxActive(int maxActive) (Re)sets the maximum number of sessions that have been active at the same time. param maxActive Maximum number of sessions that have been active at the same time.
public void	setMaxInactiveInterval(int interval) Set the default maximum inactive interval (in seconds) for Sessions created by this Manager. param interval The new default value
public void	setRejectedSessions(int rejectedSessions) Sets the number of sessions that were not created because the maximum number of active sessions was reached. param rejectedSessions Number of rejected sessions
public void	setSessionAverageAliveTime(int sessionAverageAliveTime) Sets the average time (in seconds) that expired sessions had been alive. param sessionAverageAliveTime Average time (in seconds) that expired sessions had been alive.
public void	setSessionCounter(int sessionCounter) Sets the total number of sessions created by this manager. param sessionCounter Total number of sessions created by this manager.
public void	setSessionIdLength(int idLength) Sets the session id length (in bytes) for Sessions created by this Manager. param idLength The session id length
public void	setSessionMaxAliveTime(int sessionMaxAliveTime) Sets the longest time (in seconds) that an expired session had been alive. param sessionMaxAliveTime Longest time (in seconds) that an expired session had been alive.
public void	unload() 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