Package org.apache.catalina
Interface Manager
-
- All Known Subinterfaces:
ClusterManager
- All Known Implementing Classes:
BackupManager,ClusterManagerBase,DeltaManager,ManagerBase,PersistentManager,PersistentManagerBase,StandardManager
public interface ManagerA Manager manages the pool of Sessions that are associated with a particular Context. 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
Managerimplementation to successfully operate with aContextimplementation that implements reloading, it must obey the following constraints:- Must implement
Lifecycleso that the Context can indicate that a restart is required. - Must allow a call to
stop()to be followed by a call tostart()on the sameManagerinstance.
- Author:
- Craig R. McClanahan
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description voidadd(Session session)Add this Session to the set of active Sessions for this Manager.voidaddPropertyChangeListener(PropertyChangeListener listener)Add a property change listener to this component.voidbackgroundProcess()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.voidchangeSessionId(Session session, String newId)Change the session ID of the current session to a specified session ID.SessioncreateEmptySession()Get a session from the recycled ones or create a new empty one.SessioncreateSession(String sessionId)Construct and return a new session object, based on the default settings specified by this Manager's properties.SessionfindSession(String id)Return the active Session, associated with this Manager, with the specified session id (if any); otherwise returnnull.Session[]findSessions()Return the set of active Sessions associated with this Manager.intgetActiveSessions()Gets the number of currently active sessions.ContextgetContext()Get the Context with which this Manager is associated.longgetExpiredSessions()Gets the number of sessions that have expired.intgetMaxActive()Gets the maximum number of sessions that have been active at the same time.default booleangetNotifyAttributeListenerOnUnchangedValue()When an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListeneris configured for the session shouldHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)be called?default booleangetNotifyBindingListenerOnUnchangedValue()When an attribute that is already present in the session is added again under the same name and the attribute implementsHttpSessionBindingListener, shouldHttpSessionBindingListener.valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent)be called followed byHttpSessionBindingListener.valueBound(jakarta.servlet.http.HttpSessionBindingEvent)?intgetRejectedSessions()Gets the number of sessions that were not created because the maximum number of active sessions was reached.default booleangetSessionActivityCheck()If this istrue, Tomcat will track the number of active requests for each session.intgetSessionAverageAliveTime()Gets the average time (in seconds) that expired sessions had been alive.longgetSessionCounter()Returns the total number of sessions created by this manager.intgetSessionCreateRate()Gets the current rate of session creation (in session per minute).intgetSessionExpireRate()Gets the current rate of session expiration (in session per minute).SessionIdGeneratorgetSessionIdGenerator()default booleangetSessionLastAccessAtStart()If this istrue, the last accessed time for sessions will be calculated from the beginning of the previous request.intgetSessionMaxAliveTime()Gets the longest time (in seconds) that an expired session had been alive.voidload()Load any currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any.voidremove(Session session)Remove this Session from the active Sessions for this Manager.voidremove(Session session, boolean update)Remove this Session from the active Sessions for this Manager.voidremovePropertyChangeListener(PropertyChangeListener listener)Remove a property change listener from this component.default StringrotateSessionId(Session session)Change the session ID of the current session to a new randomly generated session ID.voidsetContext(Context context)Set the Context with which this Manager is associated.voidsetExpiredSessions(long expiredSessions)Sets the number of sessions that have expired.voidsetMaxActive(int maxActive)(Re)sets the maximum number of sessions that have been active at the same time.voidsetNotifyAttributeListenerOnUnchangedValue(boolean notifyAttributeListenerOnUnchangedValue)Configure ifHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)when an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListeneris configured for the session.voidsetNotifyBindingListenerOnUnchangedValue(boolean notifyBindingListenerOnUnchangedValue)Configure ifHttpSessionBindingListener.valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent)be called followed byHttpSessionBindingListener.valueBound(jakarta.servlet.http.HttpSessionBindingEvent)when an attribute that is already present in the session is added again under the same name and the attribute implementsHttpSessionBindingListener.voidsetSessionActivityCheck(boolean sessionActivityCheck)Configure if Tomcat will track the number of active requests for each session.voidsetSessionCounter(long sessionCounter)Sets the total number of sessions created by this manager.voidsetSessionIdGenerator(SessionIdGenerator sessionIdGenerator)Sets the session id generatorvoidsetSessionLastAccessAtStart(boolean sessionLastAccessAtStart)Configure if the last accessed time for sessions will be calculated from the beginning of the previous request.voidsetSessionMaxAliveTime(int sessionMaxAliveTime)Sets the longest time (in seconds) that an expired session had been alive.voidunload()Save any currently active sessions in the appropriate persistence mechanism, if any.booleanwillAttributeDistribute(String name, Object value)Would the Manager distribute the given session attribute?
-
-
-
Method Detail
-
getContext
Context getContext()
Get the Context with which this Manager is associated.- Returns:
- The associated Context
-
setContext
void setContext(Context context)
Set the Context with which this Manager is associated. The Context must be set to a non-null value before the Manager is first used. Multiple calls to this method before first use are permitted. Once the Manager has been used, this method may not be used to change the Context (including setting anullvalue) that the Manager is associated with.- Parameters:
context- The newly associated Context
-
getSessionIdGenerator
SessionIdGenerator getSessionIdGenerator()
- Returns:
- the session id generator
-
setSessionIdGenerator
void setSessionIdGenerator(SessionIdGenerator sessionIdGenerator)
Sets the session id generator- Parameters:
sessionIdGenerator- The session id generator
-
getSessionCounter
long getSessionCounter()
Returns the total number of sessions created by this manager.- Returns:
- Total number of sessions created by this manager.
-
setSessionCounter
void setSessionCounter(long sessionCounter)
Sets the total number of sessions created by this manager.- Parameters:
sessionCounter- Total number of sessions created by this manager.
-
getMaxActive
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
-
setMaxActive
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.
-
getActiveSessions
int getActiveSessions()
Gets the number of currently active sessions.- Returns:
- Number of currently active sessions
-
getExpiredSessions
long getExpiredSessions()
Gets the number of sessions that have expired.- Returns:
- Number of sessions that have expired
-
setExpiredSessions
void setExpiredSessions(long expiredSessions)
Sets the number of sessions that have expired.- Parameters:
expiredSessions- Number of sessions that have expired
-
getRejectedSessions
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
-
getSessionMaxAliveTime
int getSessionMaxAliveTime()
Gets the longest time (in seconds) that an expired session had been alive.- Returns:
- Longest time (in seconds) that an expired session had been alive.
-
setSessionMaxAliveTime
void setSessionMaxAliveTime(int sessionMaxAliveTime)
Sets the longest time (in seconds) that an expired session had been alive.- Parameters:
sessionMaxAliveTime- Longest time (in seconds) that an expired session had been alive.
-
getSessionAverageAliveTime
int getSessionAverageAliveTime()
Gets the average time (in seconds) that expired sessions had been alive. This may be based on sample data.- Returns:
- Average time (in seconds) that expired sessions had been alive.
-
getSessionCreateRate
int getSessionCreateRate()
Gets the current rate of session creation (in session per minute). This may be based on sample data.- Returns:
- The current rate (in sessions per minute) of session creation
-
getSessionExpireRate
int getSessionExpireRate()
Gets the current rate of session expiration (in session per minute). This may be based on sample data- Returns:
- The current rate (in sessions per minute) of session expiration
-
add
void add(Session session)
Add this Session to the set of active Sessions for this Manager.- Parameters:
session- Session to be added
-
addPropertyChangeListener
void addPropertyChangeListener(PropertyChangeListener listener)
Add a property change listener to this component.- Parameters:
listener- The listener to add
-
rotateSessionId
default String rotateSessionId(Session session)
Change the session ID of the current session to a new randomly generated session ID.- Parameters:
session- The session to change the session ID for- Returns:
- The new session ID
-
changeSessionId
void changeSessionId(Session session, String newId)
Change the session ID of the current session to a specified session ID.- Parameters:
session- The session to change the session ID fornewId- new session ID
-
createEmptySession
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.- Returns:
- An empty Session object
-
createSession
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, returnnull.- Parameters:
sessionId- The session id which should be used to create the new session; ifnull, the session id will be assigned by this method, and available via the getId() method of the returned session.- Returns:
- An empty Session object with the given ID or a newly created session ID if none was specified
- Throws:
IllegalStateException- if a new session cannot be instantiated for any reason
-
findSession
Session findSession(String id) throws IOException
Return the active Session, associated with this Manager, with the specified session id (if any); otherwise returnnull.- Parameters:
id- The session id for the session to be returned- Returns:
- the request session or
nullif a session with the requested ID could not be found - Throws:
IllegalStateException- if a new session cannot be instantiated for any reasonIOException- if an input/output error occurs while processing this request
-
findSessions
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.- Returns:
- All the currently active sessions managed by this manager
-
load
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.- Throws:
ClassNotFoundException- if a serialized class cannot be found during the reloadIOException- if an input/output error occurs
-
remove
void remove(Session session)
Remove this Session from the active Sessions for this Manager.- Parameters:
session- Session to be removed
-
remove
void remove(Session session, boolean update)
Remove this Session from the active Sessions for this Manager.- Parameters:
session- Session to be removedupdate- Should the expiration statistics be updated
-
removePropertyChangeListener
void removePropertyChangeListener(PropertyChangeListener listener)
Remove a property change listener from this component.- Parameters:
listener- The listener to remove
-
unload
void unload() throws IOExceptionSave any currently active sessions in the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything.- Throws:
IOException- if an input/output error occurs
-
backgroundProcess
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.
-
willAttributeDistribute
boolean willAttributeDistribute(String name, Object value)
Would the Manager distribute the given session attribute? Manager implementations may provide additional configuration options to control which attributes are distributable.- Parameters:
name- The attribute namevalue- The attribute value- Returns:
trueif the Manager would distribute the given attribute otherwisefalse
-
getNotifyBindingListenerOnUnchangedValue
default boolean getNotifyBindingListenerOnUnchangedValue()
When an attribute that is already present in the session is added again under the same name and the attribute implementsHttpSessionBindingListener, shouldHttpSessionBindingListener.valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent)be called followed byHttpSessionBindingListener.valueBound(jakarta.servlet.http.HttpSessionBindingEvent)?The default value is
false.- Returns:
trueif the listener will be notified,falseif it will not
-
setNotifyBindingListenerOnUnchangedValue
void setNotifyBindingListenerOnUnchangedValue(boolean notifyBindingListenerOnUnchangedValue)
Configure ifHttpSessionBindingListener.valueUnbound(jakarta.servlet.http.HttpSessionBindingEvent)be called followed byHttpSessionBindingListener.valueBound(jakarta.servlet.http.HttpSessionBindingEvent)when an attribute that is already present in the session is added again under the same name and the attribute implementsHttpSessionBindingListener.- Parameters:
notifyBindingListenerOnUnchangedValue-truethe listener will be called,falseit will not
-
getNotifyAttributeListenerOnUnchangedValue
default boolean getNotifyAttributeListenerOnUnchangedValue()
When an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListeneris configured for the session shouldHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)be called?The default value is
true.- Returns:
trueif the listener will be notified,falseif it will not
-
setNotifyAttributeListenerOnUnchangedValue
void setNotifyAttributeListenerOnUnchangedValue(boolean notifyAttributeListenerOnUnchangedValue)
Configure ifHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)when an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListeneris configured for the session.- Parameters:
notifyAttributeListenerOnUnchangedValue-truethe listener will be called,falseit will not
-
getSessionActivityCheck
default boolean getSessionActivityCheck()
If this istrue, Tomcat will track the number of active requests for each session. When determining if a session is valid, any session with at least one active request will always be considered valid. Iforg.apache.catalina.STRICT_SERVLET_COMPLIANCEis set totrue, the default of this setting will betrue, else the default value will befalse.- Returns:
- the flag value
-
setSessionActivityCheck
void setSessionActivityCheck(boolean sessionActivityCheck)
Configure if Tomcat will track the number of active requests for each session. When determining if a session is valid, any session with at least one active request will always be considered valid.- Parameters:
sessionActivityCheck- the new flag value
-
getSessionLastAccessAtStart
default boolean getSessionLastAccessAtStart()
If this istrue, the last accessed time for sessions will be calculated from the beginning of the previous request. Iffalse, the last accessed time for sessions will be calculated from the end of the previous request. This also affects how the idle time is calculated. Iforg.apache.catalina.STRICT_SERVLET_COMPLIANCEis set totrue, the default of this setting will betrue, else the default value will befalse.- Returns:
- the flag value
-
setSessionLastAccessAtStart
void setSessionLastAccessAtStart(boolean sessionLastAccessAtStart)
Configure if the last accessed time for sessions will be calculated from the beginning of the previous request. Iffalse, the last accessed time for sessions will be calculated from the end of the previous request. This also affects how the idle time is calculated.- Parameters:
sessionLastAccessAtStart- the new flag value
-
-