org.apache.catalina

Interface Manager

Known Implementing Classes:
ManagerBase, PersistentManager, PersistentManagerBase, StandardManager

public interface Manager

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:

Version:
$Revision: 1.11 $ $Date: 2004/05/26 15:28:21 $

Author:
Craig R. McClanahan

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.
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
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.
DefaultContext
getDefaultContext()
Return the DefaultContext 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
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.
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
setDefaultContext(DefaultContext defaultContext)
Set the DefaultContext 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
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
unload()
Save any currently active sessions in the appropriate persistence mechanism, if any.

Method Details

add

public void add(Session session)
Add this Session to the set of active Sessions for this Manager.

Parameters:
session - Session to be added


addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.

Parameters:
listener - The listener to add


backgroundProcess

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.


createEmptySession

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.


createSession

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.


findSession

public Session findSession(String id)
            throws IOException
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


findSessions

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.


getActiveSessions

public int getActiveSessions()
Gets the number of currently active sessions.

Returns:
Number of currently active sessions


getContainer

public Container getContainer()
Return the Container with which this Manager is associated.


getDefaultContext

public DefaultContext getDefaultContext()
Return the DefaultContext with which this Manager is associated.


getDistributable

public boolean getDistributable()
Return the distributable flag for the sessions supported by this Manager.


getExpiredSessions

public int getExpiredSessions()
Gets the number of sessions that have expired.

Returns:
Number of sessions that have expired


getInfo

public String getInfo()
Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.


getMaxActive

public int getMaxActive()
Gets the maximum number of sessions that have been active at the same time.

Returns:
Maximum number of sessions that have been active at the same time


getMaxInactiveInterval

public int getMaxInactiveInterval()
Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.


getRejectedSessions

public int getRejectedSessions()
Gets the number of sessions that were not created because the maximum number of active sessions was reached.

Returns:
Number of rejected sessions


getSessionCounter

public int getSessionCounter()
Returns the total number of sessions created by this manager.

Returns:
Total number of sessions created by this manager.


getSessionIdLength

public int getSessionIdLength()
Gets the session id length (in bytes) of Sessions created by this Manager.

Returns:
The session id length


load

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.


remove

public void remove(Session session)
Remove this Session from the active Sessions for this Manager.

Parameters:
session - Session to be removed


removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.

Parameters:
listener - The listener to remove


setContainer

public void setContainer(Container container)
Set the Container with which this Manager is associated.

Parameters:
container - The newly associated Container


setDefaultContext

public void setDefaultContext(DefaultContext defaultContext)
Set the DefaultContext with which this Manager is associated.

Parameters:
defaultContext - The newly associated DefaultContext


setDistributable

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.

Parameters:
distributable - The new distributable flag


setExpiredSessions

public void setExpiredSessions(int expiredSessions)
Sets the number of sessions that have expired.

Parameters:
expiredSessions - Number of sessions that have expired


setMaxActive

public void setMaxActive(int maxActive)
(Re)sets the maximum number of sessions that have been active at the same time.

Parameters:
maxActive - Maximum number of sessions that have been active at the same time.


setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)
Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.

Parameters:
interval - The new default value


setRejectedSessions

public void setRejectedSessions(int rejectedSessions)
Sets the number of sessions that were not created because the maximum number of active sessions was reached.

Parameters:
rejectedSessions - Number of rejected sessions


setSessionCounter

public void setSessionCounter(int sessionCounter)
Sets the total number of sessions created by this manager.

Parameters:
sessionCounter - Total number of sessions created by this manager.


setSessionIdLength

public void setSessionIdLength(int idLength)
Sets the session id length (in bytes) for Sessions created by this Manager.

Parameters:
idLength - The session id length


unload

public void unload()
            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.


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.