Package org.apache.catalina
Interface Manager
- All Known Subinterfaces:
ClusterManager
- All Known Implementing Classes:
BackupManager
,ClusterManagerBase
,DeltaManager
,ManagerBase
,PersistentManager
,PersistentManagerBase
,StandardManager
public interface Manager
A 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 Manager
implementation to successfully operate with a Context
implementation
that implements reloading, it must obey the following constraints:
- Must implement
Lifecycle
so 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 sameManager
instance.
- Author:
- Craig R. McClanahan
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Add this Session to the set of active Sessions for this Manager.void
Add a property change listener to this component.void
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.void
changeSessionId
(Session session, String newId) Change the session ID of the current session to a specified session ID.Get a session from the recycled ones or create a new empty one.createSession
(String sessionId) Construct and return a new session object, based on the default settings specified by this Manager's properties.findSession
(String id) Return the active Session, associated with this Manager, with the specified session id (if any); otherwise returnnull
.Session[]
Return the set of active Sessions associated with this Manager.int
Gets the number of currently active sessions.Get the Context with which this Manager is associated.long
Gets the number of sessions that have expired.int
Gets the maximum number of sessions that have been active at the same time.default boolean
When an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListener
is configured for the session shouldHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)
be called?default boolean
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)
?int
Gets the number of sessions that were not created because the maximum number of active sessions was reached.default boolean
If this istrue
, Tomcat will track the number of active requests for each session.int
Gets the average time (in seconds) that expired sessions had been alive.long
Returns the total number of sessions created by this manager, which is approximated as the number of active sessions plus the number of expired sessions.int
Gets the current rate of session creation (in session per minute).int
Gets the current rate of session expiration (in session per minute).default boolean
If this istrue
, the last accessed time for sessions will be calculated from the beginning of the previous request.int
Gets the longest time (in seconds) that an expired session had been alive.void
load()
Load any currently active sessions that were previously unloaded to the appropriate persistence mechanism, if any.void
Remove this Session from the active Sessions for this Manager.void
Remove this Session from the active Sessions for this Manager.void
Remove a property change listener from this component.default String
rotateSessionId
(Session session) Change the session ID of the current session to a new randomly generated session ID.void
setContext
(Context context) Set the Context with which this Manager is associated.void
setExpiredSessions
(long 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
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 aHttpSessionAttributeListener
is configured for the session.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
.void
setSessionActivityCheck
(boolean sessionActivityCheck) Configure if Tomcat will track the number of active requests for each session.void
setSessionIdGenerator
(SessionIdGenerator sessionIdGenerator) Sets the session id generatorvoid
setSessionLastAccessAtStart
(boolean sessionLastAccessAtStart) Configure if the last accessed time for sessions will be calculated from the beginning of the previous request.void
setSessionMaxAliveTime
(int sessionMaxAliveTime) Sets the longest time (in seconds) that an expired session had been alive.void
unload()
Save any currently active sessions in the appropriate persistence mechanism, if any.boolean
willAttributeDistribute
(String name, Object value) Would the Manager distribute the given session attribute?
-
Method Details
-
getContext
Context getContext()Get the Context with which this Manager is associated.- Returns:
- The associated Context
-
setContext
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 anull
value) that the Manager is associated with.- Parameters:
context
- The newly associated Context
-
getSessionIdGenerator
SessionIdGenerator getSessionIdGenerator()- Returns:
- the session id generator
-
setSessionIdGenerator
Sets the session id generator- Parameters:
sessionIdGenerator
- The session id generator
-
getSessionCounter
long getSessionCounter()Returns the total number of sessions created by this manager, which is approximated as the number of active sessions plus the number of expired sessions.- Returns:
- 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
Add this Session to the set of active Sessions for this Manager.- Parameters:
session
- Session to be added
-
addPropertyChangeListener
Add a property change listener to this component.- Parameters:
listener
- The listener to add
-
rotateSessionId
-
changeSessionId
-
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
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
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
null
if 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
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
Remove this Session from the active Sessions for this Manager.- Parameters:
session
- Session to be removed
-
remove
Remove this Session from the active Sessions for this Manager.- Parameters:
session
- Session to be removedupdate
- Should the expiration statistics be updated
-
removePropertyChangeListener
Remove a property change listener from this component.- Parameters:
listener
- The listener to remove
-
unload
Save 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
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:
true
if 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:
true
if the listener will be notified,false
if 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
-true
the listener will be called,false
it will not
-
getNotifyAttributeListenerOnUnchangedValue
default boolean getNotifyAttributeListenerOnUnchangedValue()When an attribute that is already present in the session is added again under the same name and aHttpSessionAttributeListener
is configured for the session shouldHttpSessionAttributeListener.attributeReplaced(jakarta.servlet.http.HttpSessionBindingEvent)
be called?The default value is
true
.- Returns:
true
if the listener will be notified,false
if 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 aHttpSessionAttributeListener
is configured for the session.- Parameters:
notifyAttributeListenerOnUnchangedValue
-true
the listener will be called,false
it 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_COMPLIANCE
is 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_COMPLIANCE
is 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
-