Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	PersistentManagerBase.PrivilegedStoreClear
private class	PersistentManagerBase.PrivilegedStoreKeys
private class	PersistentManagerBase.PrivilegedStoreLoad
private class	PersistentManagerBase.PrivilegedStoreRemove
private class	PersistentManagerBase.PrivilegedStoreSave

Field Summary

Modifier and Type	Field and Description
private final Log	log Hides org.apache.catalina.session.ManagerBase.log.
protected int	maxIdleBackup How long a session must be idle before it should be backed up.
protected int	maxIdleSwap The maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity.
protected int	minIdleSwap The minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions.
private static final String	name Hides org.apache.catalina.session.ManagerBase.name. The descriptive name of this Manager implementation (for logging).
private static final String	PERSISTED_LAST_ACCESSED_TIME Key of the note of a session in which the timestamp of last backup is stored.
protected boolean	saveOnRestart Whether to save and reload sessions when the Manager `unload` and `load` methods are called.
private final Map<String, Object>	sessionSwapInLocks Sessions currently being swapped in and the associated locks
private final ThreadLocal<Session>	sessionToSwapIn
protected Store	store Store object which will manage the Session store.

Constructor Summary

Access	Constructor and Description
public	PersistentManagerBase()

Method Summary

Modifier and Type	Method and Description
public void	clearStore() Clear all sessions from the Store.
public Session	findSession(String The session id for the session to be returned id) Overrides org.apache.catalina.session.ManagerBase.findSession. Implements org.apache.catalina.Manager.findSession. Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return `null`.
public int	getActiveSessionsFull() Implements org.apache.catalina.DistributedManager.getActiveSessionsFull. Returns the total session count for primary, backup and proxy.
public int	Returns: the timeout after which sessions are ripe for back up getMaxIdleBackup() Indicates how many seconds old a session can get, after its last use in a request, before it should be backed up to the store.
public int	Returns: The maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity. A value of `-1` means sessions should not be swapped out just because of inactivity. getMaxIdleSwap()
public int	Returns: The minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions. A value of `-1` means sessions will not be swapped out to keep the active session count down. getMinIdleSwap()
public String	getName() Overrides org.apache.catalina.session.ManagerBase.getName.
public boolean	Returns: `true`, when sessions should be saved on restart, {code false} otherwise getSaveOnRestart() Indicates whether sessions are saved when the Manager is shut down properly.
public Set<String>	getSessionIdsFull() Implements org.apache.catalina.DistributedManager.getSessionIdsFull. Returns the list of all sessions IDS (primary, backup and proxy).
public Store	Returns: the Store object which manages persistent Session storage for this Manager. getStore() Implements org.apache.catalina.StoreManager.getStore.
public boolean	Returns: `true`, if the session id is loaded in memory otherwise `false` is returned isLoaded(String The session id for the session to be searched for id) Check, whether a session is loaded in memory
public void	load() Implements org.apache.catalina.Manager.load. Load all sessions found in the persistence mechanism, assuming they are marked as valid and have not passed their expiration limit.
private Session	loadSessionFromStore(String id)
public void	processExpires() Overrides org.apache.catalina.session.ManagerBase.processExpires. Invalidate all sessions that have expired.
protected void	processMaxActiveSwaps() Swap idle sessions out to Store if too many are active
protected void	processMaxIdleBackups() Back up idle sessions.
protected void	processMaxIdleSwaps() Swap idle sessions out to Store if they are idle too long.
public void	processPersistenceChecks() Called by the background thread after active sessions have been checked for expiration, to allow sessions to be swapped out, backed up, etc.
private void	reactivateLoadedSession(String id, Session session)
public void	remove(Session Session to be removed session, boolean Should the expiration statistics be updated update) Overrides org.apache.catalina.session.ManagerBase.remove. Implements org.apache.catalina.Manager.remove. Remove this Session from the active Sessions for this Manager.
protected void	removeSession(String Session's id to be removed id) Remove this Session from the active Sessions for this Manager, and from the Store.
public void	removeSuper(Session Session to be removed session) Implements org.apache.catalina.StoreManager.removeSuper. Remove this Session from the active Sessions for this Manager, but not from the Store.
private Session	securedStoreLoad(String id)
public void	setMaxIdleBackup(int The number of seconds after their last accessed time when they should be written to the Store. backup) Sets the option to back sessions up to the Store after they are used in a request.
public void	setMaxIdleSwap(int time in seconds to wait for possible swap out max) Sets the maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity.
public void	setMinIdleSwap(int time in seconds before a possible swap out min) Sets the minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions.
public void	setSaveOnRestart(boolean `true` if sessions should be saved on restart, `false` if they should be ignored. saveOnRestart) Set the option to save sessions to the Store when the Manager is shut down, then loaded when the Manager starts again.
public void	setStore(Store the associated Store store) Set the Store object which will manage persistent Session storage for this Manager.
protected void	startInternal() Overrides org.apache.catalina.session.ManagerBase.startInternal. Start this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`.
protected void	stopInternal() Overrides org.apache.catalina.session.ManagerBase.stopInternal. Stop this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#stopInternal()`.
protected Session	Returns: restored session, or `null`, if none is found swapIn(String The id of the session that should be swapped in id) Look for a session in the Store and, if found, restore it in the Manager's list of active sessions if appropriate.
protected void	swapOut(Session The Session to write out session) Remove the session from the Manager's list of active sessions and write it out to the Store.
public void	unload() Implements org.apache.catalina.Manager.unload. Save all currently active sessions in the appropriate persistence mechanism, if any.
protected void	writeSession(Session The session that should be written session) Write the provided session to the Store without modifying the copy in memory or triggering passivation events.

Inherited from org.apache.catalina.session.ManagerBase:: add addPropertyChangeListener backgroundProcess changeSessionId changeSessionId createEmptySession createSession expireSession findSessions generateSessionId getActiveSessions getClassName getContext getCreationTime getCreationTimestamp getDomainInternal getDuplicates getEngine getExpiredSessions getJvmRoute getLastAccessedTime getLastAccessedTimestamp getMaxActive getMaxActiveSessions getNewSession getNotifyAttributeListenerOnUnchangedValue getNotifyBindingListenerOnUnchangedValue getObjectNameKeyProperties getPersistAuthentication getProcessExpiresFrequency getProcessingTime getRejectedSessions getSecureRandomAlgorithm getSecureRandomClass getSecureRandomProvider getSession getSessionActivityCheck getSessionAttribute getSessionAttributeNameFilter getSessionAttributeNamePattern getSessionAttributeValueClassNameFilter getSessionAttributeValueClassNamePattern getSessionAverageAliveTime getSessionCounter getSessionCreateRate getSessionExpireRate getSessionIdGenerator getSessionLastAccessAtStart getSessionMaxAliveTime getThisAccessedTime getThisAccessedTimestamp getWarnOnSessionAttributeFilterFailure initInternal listSessionIds remove removePropertyChangeListener rotateSessionId setContext setDuplicates setExpiredSessions setMaxActive setMaxActiveSessions setNotifyAttributeListenerOnUnchangedValue setNotifyBindingListenerOnUnchangedValue setPersistAuthentication setProcessExpiresFrequency setProcessingTime setSecureRandomAlgorithm setSecureRandomClass setSecureRandomProvider setSessionActivityCheck setSessionAttributeNameFilter setSessionAttributeValueClassNameFilter setSessionCounter setSessionIdGenerator setSessionLastAccessAtStart setSessionMaxAliveTime setWarnOnSessionAttributeFilterFailure toString updateSessionMaxAliveTime willAttributeDistribute

Field Detail

log	back to summary
private final Log log Hides org.apache.catalina.session.ManagerBase.log.

maxIdleBackup	back to summary
protected int maxIdleBackup How long a session must be idle before it should be backed up. `-1` means sessions won't be backed up.

maxIdleSwap	back to summary
protected int maxIdleSwap The maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity. Setting this to `-1` means sessions should not be swapped out just because of inactivity.

minIdleSwap	back to summary
protected int minIdleSwap The minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions. Setting to `-1` means sessions will not be swapped out to keep the active session count down.

name	back to summary
private static final String name Hides org.apache.catalina.session.ManagerBase.name. The descriptive name of this Manager implementation (for logging).

name

back to summary

private static final String name

Hides org.apache.catalina.session.ManagerBase.name.

The descriptive name of this Manager implementation (for logging).

PERSISTED_LAST_ACCESSED_TIME	back to summary
private static final String PERSISTED_LAST_ACCESSED_TIME Key of the note of a session in which the timestamp of last backup is stored.

saveOnRestart	back to summary
protected boolean saveOnRestart Whether to save and reload sessions when the Manager `unload` and `load` methods are called.

sessionSwapInLocks	back to summary
private final Map<String, Object> sessionSwapInLocks Sessions currently being swapped in and the associated locks

sessionToSwapIn	back to summary
private final ThreadLocal<Session> sessionToSwapIn

store	back to summary
protected Store store Store object which will manage the Session store.

Constructor Detail

PersistentManagerBase	back to summary
public PersistentManagerBase()

Method Detail

clearStore	back to summary
public void clearStore() Clear all sessions from the Store.

findSession back to summary

findSession	back to summary
public Session findSession(String id) throws IOException Overrides org.apache.catalina.session.ManagerBase.findSession. Implements org.apache.catalina.Manager.findSession. Doc from org.apache.catalina.Manager.findSession. Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return `null`. This method checks the persistence store if persistence is enabled, otherwise just uses the functionality from ManagerBase. Parameters id:String The session id for the session to be returned Returns:Session the request session or `null` if a session with the requested ID could not be found Annotations @Override Exceptions IOException: if an input/output error occurs while processing this request

public Session findSession(String id) throws IOException

Overrides org.apache.catalina.session.ManagerBase.findSession.

Implements org.apache.catalina.Manager.findSession.

Doc from org.apache.catalina.Manager.findSession.

Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return null.

This method checks the persistence store if persistence is enabled, otherwise just uses the functionality from ManagerBase.

Parameters

id:String: The session id for the session to be returned

Returns:Session

the request session or null if a session with the requested ID could not be found

Annotations

@Override

Exceptions

IOException:: if an input/output error occurs while processing this request

getActiveSessionsFull	back to summary
public int getActiveSessionsFull() Implements org.apache.catalina.DistributedManager.getActiveSessionsFull. Doc from org.apache.catalina.DistributedManager.getActiveSessionsFull. Returns the total session count for primary, backup and proxy. Returns:int The total session count across the cluster. Annotations @Override

getActiveSessionsFull

back to summary

public int getActiveSessionsFull()

Implements org.apache.catalina.DistributedManager.getActiveSessionsFull.

Doc from org.apache.catalina.DistributedManager.getActiveSessionsFull.

Returns the total session count for primary, backup and proxy.

Returns:int

The total session count across the cluster.

Annotations

@Override

getMaxIdleBackup back to summary

getMaxIdleBackup	back to summary
public int getMaxIdleBackup() Indicates how many seconds old a session can get, after its last use in a request, before it should be backed up to the store. `-1` means sessions are not backed up. Returns:int the timeout after which sessions are ripe for back up

public int getMaxIdleBackup()

Indicates how many seconds old a session can get, after its last use in a request, before it should be backed up to the store. -1 means sessions are not backed up.

Returns:int: the timeout after which sessions are ripe for back up

getMaxIdleSwap	back to summary
public int getMaxIdleSwap() Returns:int The maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity. A value of `-1` means sessions should not be swapped out just because of inactivity.

getMinIdleSwap	back to summary
public int getMinIdleSwap() Returns:int The minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions. A value of `-1` means sessions will not be swapped out to keep the active session count down.

getName	back to summary
public String getName() Overrides org.apache.catalina.session.ManagerBase.getName. Returns:String Doc from org.apache.catalina.session.ManagerBase.getName. The descriptive short name of this Manager implementation. Annotations @Override

getName

back to summary

public String getName()

Overrides org.apache.catalina.session.ManagerBase.getName.

Returns:String

Doc from org.apache.catalina.session.ManagerBase.getName.

The descriptive short name of this Manager implementation.

Annotations

@Override

getSaveOnRestart back to summary

getSaveOnRestart	back to summary
public boolean getSaveOnRestart() Indicates whether sessions are saved when the Manager is shut down properly. This requires the `unload()` method to be called. Returns:boolean `true`, when sessions should be saved on restart, {code false} otherwise

public boolean getSaveOnRestart()

Indicates whether sessions are saved when the Manager is shut down properly. This requires the unload() method to be called.

Returns:boolean: true, when sessions should be saved on restart, {code false} otherwise

getSessionIdsFull	back to summary
public Set<String> getSessionIdsFull() Implements org.apache.catalina.DistributedManager.getSessionIdsFull. Doc from org.apache.catalina.DistributedManager.getSessionIdsFull. Returns the list of all sessions IDS (primary, backup and proxy). Returns:Set<String> The complete set of sessions IDs across the cluster. Annotations @Override

getSessionIdsFull

back to summary

public Set<String> getSessionIdsFull()

Implements org.apache.catalina.DistributedManager.getSessionIdsFull.

Doc from org.apache.catalina.DistributedManager.getSessionIdsFull.

Returns the list of all sessions IDS (primary, backup and proxy).

Returns:Set<String>

The complete set of sessions IDs across the cluster.

Annotations

@Override

getStore	back to summary
public Store getStore() Implements org.apache.catalina.StoreManager.getStore. Returns:Store the Store object which manages persistent Session storage for this Manager. Annotations @Override

getStore

back to summary

public Store getStore()

Implements org.apache.catalina.StoreManager.getStore.

Returns:Store

the Store object which manages persistent Session storage for this Manager.

Annotations

@Override

isLoaded back to summary

isLoaded	back to summary
public boolean isLoaded(String id) Check, whether a session is loaded in memory Parameters id:String The session id for the session to be searched for Returns:boolean `true`, if the session id is loaded in memory otherwise `false` is returned

public boolean isLoaded(String id)

Check, whether a session is loaded in memory

Parameters

id:String: The session id for the session to be searched for

Returns:boolean

true, if the session id is loaded in memory otherwise false is returned

load	back to summary
public void load() Implements org.apache.catalina.Manager.load. Load all sessions found in the persistence mechanism, assuming they are marked as valid and have not passed their expiration limit. If persistence is not supported, this method returns without doing anything. Note that by default, this method is not called by the MiddleManager class. In order to use it, a subclass must specifically call it, for example in the start() and/or processPersistenceChecks() methods. Annotations @Override

load

back to summary

public void load()

Implements org.apache.catalina.Manager.load.

Load all sessions found in the persistence mechanism, assuming they are marked as valid and have not passed their expiration limit. If persistence is not supported, this method returns without doing anything.

Note that by default, this method is not called by the MiddleManager class. In order to use it, a subclass must specifically call it, for example in the start() and/or processPersistenceChecks() methods.

Annotations

@Override

loadSessionFromStore	back to summary
private Session loadSessionFromStore(String id) throws IOException

processExpires	back to summary
public void processExpires() Overrides org.apache.catalina.session.ManagerBase.processExpires. Doc from org.apache.catalina.session.ManagerBase.processExpires. Invalidate all sessions that have expired. Direct call to processExpires and processPersistenceChecks Annotations @Override

processExpires

back to summary

public void processExpires()

Overrides org.apache.catalina.session.ManagerBase.processExpires.

Doc from org.apache.catalina.session.ManagerBase.processExpires.

Invalidate all sessions that have expired.

Direct call to processExpires and processPersistenceChecks

Annotations

@Override

processMaxActiveSwaps	back to summary
protected void processMaxActiveSwaps() Swap idle sessions out to Store if too many are active

processMaxIdleBackups	back to summary
protected void processMaxIdleBackups() Back up idle sessions.

processMaxIdleSwaps	back to summary
protected void processMaxIdleSwaps() Swap idle sessions out to Store if they are idle too long.

processPersistenceChecks	back to summary
public void processPersistenceChecks() Called by the background thread after active sessions have been checked for expiration, to allow sessions to be swapped out, backed up, etc.

reactivateLoadedSession	back to summary
private void reactivateLoadedSession(String id, Session session)

remove	back to summary
public void remove(Session session, boolean update) Overrides org.apache.catalina.session.ManagerBase.remove. Implements org.apache.catalina.Manager.remove. Doc from org.apache.catalina.Manager.remove. Remove this Session from the active Sessions for this Manager. Remove this Session from the Store. Parameters session:Session Session to be removed update:boolean Should the expiration statistics be updated Annotations @Override

remove

back to summary

public void remove(Session session, boolean update)

Overrides org.apache.catalina.session.ManagerBase.remove.

Implements org.apache.catalina.Manager.remove.

Doc from org.apache.catalina.Manager.remove.

Remove this Session from the active Sessions for this Manager.

Remove this Session from the Store.

Parameters

session:Session: Session to be removed
update:boolean: Should the expiration statistics be updated

Annotations

@Override

removeSession	back to summary
protected void removeSession(String id) Remove this Session from the active Sessions for this Manager, and from the Store. Parameters id:String Session's id to be removed

removeSession

back to summary

protected void removeSession(String id)

Remove this Session from the active Sessions for this Manager, and from the Store.

Parameters

id:String: Session's id to be removed

removeSuper	back to summary
public void removeSuper(Session session) Implements org.apache.catalina.StoreManager.removeSuper. Remove this Session from the active Sessions for this Manager, but not from the Store. (Used by the PersistentValve) Parameters session:Session Session to be removed Annotations @Override

removeSuper

back to summary

public void removeSuper(Session session)

Implements org.apache.catalina.StoreManager.removeSuper.

Remove this Session from the active Sessions for this Manager, but not from the Store. (Used by the PersistentValve)

Parameters

session:Session: Session to be removed

Annotations

@Override

securedStoreLoad	back to summary
private Session securedStoreLoad(String id) throws IOException, ClassNotFoundException

setMaxIdleBackup back to summary

setMaxIdleBackup	back to summary
public void setMaxIdleBackup(int backup) Sets the option to back sessions up to the Store after they are used in a request. Sessions remain available in memory after being backed up, so they are not passivated as they are when swapped out. The value set indicates how old a session may get (since its last use) before it must be backed up: `-1` means sessions are not backed up. Note that this is not a hard limit: sessions are checked against this age limit periodically according to `processExpiresFrequency`. This value should be considered to indicate when a session is ripe for backing up. So it is possible that a session may be idle for `maxIdleBackup + processExpiresFrequency * engine.backgroundProcessorDelay` seconds, plus the time it takes to handle other session expiration, swapping, etc. tasks. Parameters backup:int The number of seconds after their last accessed time when they should be written to the Store.

public void setMaxIdleBackup(int backup)

Sets the option to back sessions up to the Store after they are used in a request. Sessions remain available in memory after being backed up, so they are not passivated as they are when swapped out. The value set indicates how old a session may get (since its last use) before it must be backed up: -1 means sessions are not backed up.

Note that this is not a hard limit: sessions are checked against this age limit periodically according to processExpiresFrequency. This value should be considered to indicate when a session is ripe for backing up.

So it is possible that a session may be idle for maxIdleBackup + processExpiresFrequency * engine.backgroundProcessorDelay seconds, plus the time it takes to handle other session expiration, swapping, etc. tasks.

Parameters

backup:int: The number of seconds after their last accessed time when they should be written to the Store.

setMaxIdleSwap back to summary

setMaxIdleSwap	back to summary
public void setMaxIdleSwap(int max) Sets the maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity. Setting this to `-1` means sessions should not be swapped out just because of inactivity. Parameters max:int time in seconds to wait for possible swap out

public void setMaxIdleSwap(int max)

Sets the maximum time in seconds a session may be idle before it is eligible to be swapped to disk due to inactivity. Setting this to -1 means sessions should not be swapped out just because of inactivity.

Parameters

max:int: time in seconds to wait for possible swap out

setMinIdleSwap back to summary

setMinIdleSwap	back to summary
public void setMinIdleSwap(int min) Sets the minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions. Setting to `-1` means sessions will not be swapped out to keep the active session count down. Parameters min:int time in seconds before a possible swap out

public void setMinIdleSwap(int min)

Sets the minimum time in seconds a session must be idle before it is eligible to be swapped to disk to keep the active session count below maxActiveSessions. Setting to -1 means sessions will not be swapped out to keep the active session count down.

Parameters

min:int: time in seconds before a possible swap out

setSaveOnRestart back to summary

setSaveOnRestart	back to summary
public void setSaveOnRestart(boolean saveOnRestart) Set the option to save sessions to the Store when the Manager is shut down, then loaded when the Manager starts again. If set to false, any sessions found in the Store may still be picked up when the Manager is started again. Parameters saveOnRestart:boolean `true` if sessions should be saved on restart, `false` if they should be ignored.

public void setSaveOnRestart(boolean saveOnRestart)

Set the option to save sessions to the Store when the Manager is shut down, then loaded when the Manager starts again. If set to false, any sessions found in the Store may still be picked up when the Manager is started again.

Parameters

saveOnRestart:boolean: true if sessions should be saved on restart, false if they should be ignored.

setStore	back to summary
public void setStore(Store store) Set the Store object which will manage persistent Session storage for this Manager. Parameters store:Store the associated Store

setStore

back to summary

public void setStore(Store store)

Set the Store object which will manage persistent Session storage for this Manager.

Parameters

store:Store: the associated Store

startInternal back to summary

startInternal	back to summary
protected void startInternal() throws LifecycleException Overrides org.apache.catalina.session.ManagerBase.startInternal. Start this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#startInternal()`. Annotations @Override Exceptions LifecycleException: if this component detects a fatal error that prevents this component from being used

protected void startInternal() throws LifecycleException

Overrides org.apache.catalina.session.ManagerBase.startInternal.

Start this component and implement the requirements of org.apache.catalina.util.LifecycleBase#startInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that prevents this component from being used

stopInternal back to summary

stopInternal	back to summary
protected void stopInternal() throws LifecycleException Overrides org.apache.catalina.session.ManagerBase.stopInternal. Stop this component and implement the requirements of `org.apache.catalina.util.LifecycleBase#stopInternal()`. Annotations @Override Exceptions LifecycleException: if this component detects a fatal error that prevents this component from being used

protected void stopInternal() throws LifecycleException

Overrides org.apache.catalina.session.ManagerBase.stopInternal.

Stop this component and implement the requirements of org.apache.catalina.util.LifecycleBase#stopInternal().

Annotations

@Override

Exceptions

LifecycleException:: if this component detects a fatal error that prevents this component from being used

swapIn back to summary

swapIn	back to summary
protected Session swapIn(String id) throws IOException Look for a session in the Store and, if found, restore it in the Manager's list of active sessions if appropriate. The session will be removed from the Store after swapping in, but will not be added to the active session list if it is invalid or past its expiration. Parameters id:String The id of the session that should be swapped in Returns:Session restored session, or `null`, if none is found Exceptions IOException: an IO error occurred

protected Session swapIn(String id) throws IOException

Look for a session in the Store and, if found, restore it in the Manager's list of active sessions if appropriate. The session will be removed from the Store after swapping in, but will not be added to the active session list if it is invalid or past its expiration.

Parameters

id:String: The id of the session that should be swapped in

Returns:Session

restored session, or null, if none is found

Exceptions

IOException:: an IO error occurred

swapOut	back to summary
protected void swapOut(Session session) throws IOException Remove the session from the Manager's list of active sessions and write it out to the Store. If the session is past its expiration or invalid, this method does nothing. Parameters session:Session The Session to write out Exceptions IOException: an IO error occurred

swapOut

back to summary

protected void swapOut(Session session) throws IOException

Remove the session from the Manager's list of active sessions and write it out to the Store. If the session is past its expiration or invalid, this method does nothing.

Parameters

session:Session: The Session to write out

Exceptions

IOException:: an IO error occurred

unload	back to summary
public void unload() Implements org.apache.catalina.Manager.unload. Save all currently active sessions in the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything. Note that by default, this method is not called by the MiddleManager class. In order to use it, a subclass must specifically call it, for example in the stop() and/or processPersistenceChecks() methods. Annotations @Override

unload

back to summary

public void unload()

Implements org.apache.catalina.Manager.unload.

Save all currently active sessions in the appropriate persistence mechanism, if any. If persistence is not supported, this method returns without doing anything.

Note that by default, this method is not called by the MiddleManager class. In order to use it, a subclass must specifically call it, for example in the stop() and/or processPersistenceChecks() methods.

Annotations

@Override

writeSession	back to summary
protected void writeSession(Session session) throws IOException Write the provided session to the Store without modifying the copy in memory or triggering passivation events. Does nothing if the session is invalid or past its expiration. Parameters session:Session The session that should be written Exceptions IOException: an IO error occurred

writeSession

back to summary

protected void writeSession(Session session) throws IOException

Write the provided session to the Store without modifying the copy in memory or triggering passivation events. Does nothing if the session is invalid or past its expiration.

Parameters

session:Session: The session that should be written

Exceptions

IOException:: an IO error occurred

org.apache.catalina.session back to summary

private Class PersistentManagerBase.PrivilegedStoreClear

Class Inheritance

extends Object
implements PrivilegedExceptionAction<Void>

java.lang.Object
org.apache.catalina.session.PersistentManagerBase.PrivilegedStoreClear

All Implemented Interfaces

java.security.PrivilegedExceptionAction

Constructor Summary

Access	Constructor and Description
pack-priv	PrivilegedStoreClear()

Method Summary

Modifier and Type	Method and Description
public Void	run() Implements java.security.PrivilegedExceptionAction.run. Performs the computation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

PrivilegedStoreClear	back to summary
pack-priv PrivilegedStoreClear()

Method Detail

run back to summary

public Void run() throws Exception

Implements java.security.PrivilegedExceptionAction.run.

Doc from java.security.PrivilegedExceptionAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:Void

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedExceptionAction should document what (if anything) this value represents.

Annotations

@Override

Exceptions

Exception:: an exceptional condition has occurred. Each class that implements PrivilegedExceptionAction should document the exceptions that its run method can throw.

org.apache.catalina.session back to summary

private Class PersistentManagerBase.PrivilegedStoreKeys

Class Inheritance

extends Object
implements PrivilegedExceptionAction<String[]>

java.lang.Object
org.apache.catalina.session.PersistentManagerBase.PrivilegedStoreKeys

All Implemented Interfaces

java.security.PrivilegedExceptionAction

Constructor Summary

Access	Constructor and Description
pack-priv	PrivilegedStoreKeys()

Method Summary

Modifier and Type	Method and Description
public String[]	run() Implements java.security.PrivilegedExceptionAction.run. Performs the computation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

PrivilegedStoreKeys	back to summary
pack-priv PrivilegedStoreKeys()

Method Detail

run back to summary

public String[] run() throws Exception

Implements java.security.PrivilegedExceptionAction.run.

Doc from java.security.PrivilegedExceptionAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:String[]

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedExceptionAction should document what (if anything) this value represents.

Annotations

@Override

Exceptions

Exception:: an exceptional condition has occurred. Each class that implements PrivilegedExceptionAction should document the exceptions that its run method can throw.

org.apache.catalina.session back to summary

private Class PersistentManagerBase.PrivilegedStoreLoad

Class Inheritance

extends Object
implements PrivilegedExceptionAction<Session>

java.lang.Object
org.apache.catalina.session.PersistentManagerBase.PrivilegedStoreLoad

All Implemented Interfaces

java.security.PrivilegedExceptionAction

Field Summary

Modifier and Type	Field and Description
private String	id

Constructor Summary

Access	Constructor and Description
pack-priv	PrivilegedStoreLoad(String id)

Method Summary

Modifier and Type	Method and Description
public Session	run() Implements java.security.PrivilegedExceptionAction.run. Performs the computation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

id	back to summary
private String id

Constructor Detail

PrivilegedStoreLoad	back to summary
pack-priv PrivilegedStoreLoad(String id)

Method Detail

run back to summary

public Session run() throws Exception

Implements java.security.PrivilegedExceptionAction.run.

Doc from java.security.PrivilegedExceptionAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:Session

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedExceptionAction should document what (if anything) this value represents.

Annotations

@Override

Exceptions

Exception:: an exceptional condition has occurred. Each class that implements PrivilegedExceptionAction should document the exceptions that its run method can throw.

org.apache.catalina.session back to summary

private Class PersistentManagerBase.PrivilegedStoreRemove

Class Inheritance

extends Object
implements PrivilegedExceptionAction<Void>

java.lang.Object
org.apache.catalina.session.PersistentManagerBase.PrivilegedStoreRemove

All Implemented Interfaces

java.security.PrivilegedExceptionAction

Field Summary

Modifier and Type	Field and Description
private String	id

Constructor Summary

Access	Constructor and Description
pack-priv	PrivilegedStoreRemove(String id)

Method Summary

Modifier and Type	Method and Description
public Void	run() Implements java.security.PrivilegedExceptionAction.run. Performs the computation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

id	back to summary
private String id

Constructor Detail

PrivilegedStoreRemove	back to summary
pack-priv PrivilegedStoreRemove(String id)

Method Detail

run back to summary

public Void run() throws Exception

Implements java.security.PrivilegedExceptionAction.run.

Doc from java.security.PrivilegedExceptionAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:Void

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedExceptionAction should document what (if anything) this value represents.

Annotations

@Override

Exceptions

Exception:: an exceptional condition has occurred. Each class that implements PrivilegedExceptionAction should document the exceptions that its run method can throw.

org.apache.catalina.session back to summary

private Class PersistentManagerBase.PrivilegedStoreSave

Class Inheritance

extends Object
implements PrivilegedExceptionAction<Void>

java.lang.Object
org.apache.catalina.session.PersistentManagerBase.PrivilegedStoreSave

All Implemented Interfaces

java.security.PrivilegedExceptionAction

Field Summary

Modifier and Type	Field and Description
private Session	session

Constructor Summary

Access	Constructor and Description
pack-priv	PrivilegedStoreSave(Session session)

Method Summary

Modifier and Type	Method and Description
public Void	run() Implements java.security.PrivilegedExceptionAction.run. Performs the computation.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

session	back to summary
private Session session

Constructor Detail

PrivilegedStoreSave	back to summary
pack-priv PrivilegedStoreSave(Session session)

Method Detail

run back to summary

public Void run() throws Exception

Implements java.security.PrivilegedExceptionAction.run.

Doc from java.security.PrivilegedExceptionAction.run.

Performs the computation. This method will be called by AccessController.doPrivileged after enabling privileges.

Returns:Void

a class-dependent value that may represent the results of the computation. Each class that implements PrivilegedExceptionAction should document what (if anything) this value represents.

Annotations

@Override

Exceptions

Exception:: an exceptional condition has occurred. Each class that implements PrivilegedExceptionAction should document the exceptions that its run method can throw.

public abstract Class PersistentManagerBase

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PersistentManagerBase.PrivilegedStoreClear

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class PersistentManagerBase.PrivilegedStoreKeys

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class PersistentManagerBase.PrivilegedStoreLoad

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PersistentManagerBase.PrivilegedStoreRemove

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class PersistentManagerBase.PrivilegedStoreSave

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail