Home » apache-tomcat-6.0.26-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Manager [javadoc | source]

All Known Implementing Classes:
    SimpleTcpReplicationManager, SimpleTcpReplicationManager, ClusterManager, PersistentManagerBase, ClusterManager, MockDeltaManager, DeltaManager, BackupManager, StandardManager, ClusterManagerBase, ManagerBase, PersistentManager, DeltaManager

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:

Method from org.apache.catalina.Manager Summary:
add,   addPropertyChangeListener,   backgroundProcess,   changeSessionId,   createEmptySession,   createSession,   createSession,   findSession,   findSessions,   getActiveSessions,   getContainer,   getDistributable,   getExpiredSessions,   getInfo,   getMaxActive,   getMaxInactiveInterval,   getRejectedSessions,   getSessionAverageAliveTime,   getSessionCounter,   getSessionIdLength,   getSessionMaxAliveTime,   load,   remove,   removePropertyChangeListener,   setContainer,   setDistributable,   setExpiredSessions,   setMaxActive,   setMaxInactiveInterval,   setRejectedSessions,   setSessionAverageAliveTime,   setSessionCounter,   setSessionIdLength,   setSessionMaxAliveTime,   unload
Method from org.apache.catalina.Manager Detail:
 public  void add(Session session)
    Add this Session to the set of active Sessions for this Manager.
 public  void addPropertyChangeListener(PropertyChangeListener listener)
    Add a property change listener to this component.
 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  void changeSessionId(Session session)
    Change the session ID of the current session to a new randomly generated session ID.
 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()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, return null.
 public Session createSession(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.
 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.
 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.
 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.
 public 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.
 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.
 public int getSessionAverageAliveTime()
    Gets the average time (in seconds) that expired sessions had been alive.
 public int getSessionCounter()
    Returns the total number of sessions created by this manager.
 public int getSessionIdLength()
    Gets the session id length (in bytes) of Sessions created by this Manager.
 public int getSessionMaxAliveTime()
    Gets the longest time (in seconds) that an expired session had been alive.
 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 remove(Session session)
    Remove this Session from the active Sessions for this Manager.
 public  void removePropertyChangeListener(PropertyChangeListener listener)
    Remove a property change listener from this component.
 public  void setContainer(Container container)
    Set the Container with which this Manager is associated.
 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.
 public  void setExpiredSessions(int expiredSessions)
    Sets the 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.
 public  void setMaxInactiveInterval(int interval)
    Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.
 public  void setRejectedSessions(int rejectedSessions)
    Sets the number of sessions that were not created because the maximum number of active sessions was reached.
 public  void setSessionAverageAliveTime(int sessionAverageAliveTime)
    Sets the 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.
 public  void setSessionIdLength(int idLength)
    Sets the session id length (in bytes) for Sessions created by this Manager.
 public  void setSessionMaxAliveTime(int sessionMaxAliveTime)
    Sets the longest time (in seconds) that an expired session had been alive.
 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.