Save This Page
Home » glassfish-v2ur2-b04-src » org.apache » catalina » [javadoc | source]
org.apache.catalina
public interface: Manager [javadoc | source]

All Known Implementing Classes:
    PersistentManager, BackupManager, StandardManager, ManagerBase, ClusterManagerBase, ClusterManager, DeltaManager, MockDeltaManager, ClusterManager, SimpleTcpReplicationManager, SimpleTcpReplicationManager, PersistentManagerBase, 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,   createEmptySession,   createSession,   createSession,   findSession,   findSession,   findSessions,   getActiveSessions,   getContainer,   getDefaultContext,   getDistributable,   getExpiredSessions,   getInfo,   getMaxActive,   getMaxInactiveInterval,   getMaxInactiveIntervalSeconds,   getRejectedSessions,   getSessionAverageAliveTime,   getSessionAverageAliveTimeSeconds,   getSessionCount,   getSessionCounter,   getSessionIdLength,   getSessionMaxAliveTime,   getSessionMaxAliveTimeSeconds,   isSessionVersioningSupported,   load,   lockSession,   postRequestDispatcherProcess,   preRequestDispatcherProcess,   remove,   removePropertyChangeListener,   setContainer,   setDefaultContext,   setDistributable,   setExpiredSessions,   setMaxActive,   setMaxInactiveInterval,   setMaxInactiveIntervalSeconds,   setRejectedSessions,   setSessionAverageAliveTime,   setSessionAverageAliveTimeSeconds,   setSessionCount,   setSessionCounter,   setSessionIDPrefix,   setSessionIdLength,   setSessionMaxAliveTime,   setSessionMaxAliveTimeSeconds,   unload,   unlockSession,   update
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 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.
 public Session createSession(String sessionId)
    Construct and return a new session object, based on the default settings specified by this Manager's properties, using the specified session id.
 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 findSession(String id,
    String version) throws IOException
    Finds and returns the session with the given id that also satisfies the given version requirement. This overloaded version of findSession() will be invoked only if isSessionVersioningSupported() returns true. By default, this method delegates to the version of findSession() that does not take any session version number.
 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 DefaultContext getDefaultContext()
    Return the DefaultContext 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()
    Same as getMaxInactiveIntervalSeconds
 public int getMaxInactiveIntervalSeconds()
    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()
    Same as getSessionAverageAliveTimeSeconds
 public int getSessionAverageAliveTimeSeconds()
    Gets the average time (in seconds) that expired sessions had been alive.
 public int getSessionCount()
    Returns the total number of sessions created by this manager.
 public int getSessionCounter()
    Same as getSessionCount
 public int getSessionIdLength()
    Gets the session id length (in bytes) of Sessions created by this Manager.
 public int getSessionMaxAliveTime()
    Same as getSessionMaxAliveTimeSeconds
 public int getSessionMaxAliveTimeSeconds()
    Gets the longest time (in seconds) that an expired session had been alive.
 public boolean isSessionVersioningSupported()
    Returns true if this session manager supports session versioning, false otherwise.
 public  void load() throws IOException, ClassNotFoundException
    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 boolean lockSession(ServletRequest request) throws ServletException
 public  void postRequestDispatcherProcess(ServletRequest request,
    ServletResponse response)
 public  void preRequestDispatcherProcess(ServletRequest request,
    ServletResponse response)
 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 setDefaultContext(DefaultContext defaultContext)
    Set the DefaultContext 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)
    Same as setMaxInactiveIntervalSeconds
 public  void setMaxInactiveIntervalSeconds(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)
    Same as setSessionAverageAliveTimeSeconds
 public  void setSessionAverageAliveTimeSeconds(int sessionAverageAliveTime)
    Sets the average time (in seconds) that expired sessions had been alive.
 public  void setSessionCount(int sessionCounter)
    Sets the total number of sessions created by this manager.
 public  void setSessionCounter(int sessionCounter)
    Same as setSessionCount
 public  void setSessionIDPrefix(String prefix)
    Allow the caller to add a prefix to the session id.
 public  void setSessionIdLength(int idLength)
    Sets the session id length (in bytes) for Sessions created by this Manager.
 public  void setSessionMaxAliveTime(int sessionMaxAliveTime)
    Same as setSessionMaxAliveTimeSeconds
 public  void setSessionMaxAliveTimeSeconds(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.
 public  void unlockSession(ServletRequest request)
 public  void update(HttpSession session) throws Exception
    Perform any operations when the request is finished.