org.apache.catalina.session
Class ManagerBase

java.lang.Object
  org.apache.catalina.util.LifecycleBase
      org.apache.catalina.util.LifecycleMBeanBase
          org.apache.catalina.session.ManagerBase

All Implemented Interfaces:

PropertyChangeListener, EventListener, MBeanRegistration, Lifecycle, Manager

Direct Known Subclasses:

ClusterManagerBase, PersistentManagerBase, StandardManager

public abstract class ManagerBase
extends LifecycleMBeanBase
implements Manager, PropertyChangeListener

Minimal implementation of the Manager interface that supports no session persistence or distributable capabilities. This class may be subclassed to create more sophisticated Manager implementations.

Version:

$Id: ManagerBase.java 987920 2010-08-22 15:34:34Z markt $

Author:

Craig R. McClanahan

Field Summary

protected String	algorithm The message digest algorithm to be used when generating session identifiers.
protected Container	container The Container with which this Manager is associated.
protected static String	DEFAULT_ALGORITHM The default message digest algorithm to use if we cannot use the requested one.
protected String	devRandomSource
protected MessageDigest	digest Return the MessageDigest implementation to be used when creating session identifiers.
protected boolean	distributable The distributable flag for Sessions created by this Manager.
protected int	duplicates
protected String	entropy A String initialization parameter used to increase the entropy of the initialization of our random number generator.
protected long	expiredSessions Number of sessions that have expired.
protected int	maxActive
protected int	maxActiveSessions The maximum number of active Sessions allowed, or -1 for no limit.
protected int	maxInactiveInterval The default maximum inactive interval for Sessions created by this Manager.
protected static String	name The descriptive name of this Manager implementation (for logging).
protected int	processExpiresFrequency Frequency of the session expiration, and related manager operations.
protected long	processingTime Processing time during session expiration.
protected Random	random A random number generator to use when generating session identifiers.
protected String	randomClass The Java class name of the random number generator class to be used when generating session identifiers.
protected DataInputStream	randomIS
protected int	rejectedSessions Number of session creations that failed due to maxActiveSessions.
protected int	sessionAverageAliveTime Average time (in seconds) that expired sessions had been alive.
protected long	sessionCounter
protected int	sessionIdLength The session id length of Sessions created by this Manager.
protected int	sessionMaxAliveTime The longest time (in seconds) that an expired session had been alive.
protected Map<String,Session>	sessions The set of currently active Sessions for this Manager, keyed by session identifier.
protected static StringManager	sm The string manager for this package.
protected PropertyChangeSupport	support The property change support for this component.

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, DESTROY_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

ManagerBase()

Method Summary

void	add(Session session) Add this Session to the set of active Sessions for this Manager.
void	addPropertyChangeListener(PropertyChangeListener listener) Add a property change listener to this component.
void	backgroundProcess() Implements the Manager interface, direct call to processExpires
void	changeSessionId(Session session) Change the session ID of the current session to a new randomly generated session ID.
Session	createEmptySession() Get a session from the recycled ones or create a new empty one.
Session	createSession(String sessionId) Construct and return a new session object, based on the default settings specified by this Manager's properties.
protected void	destroyInternal() Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.
void	expireSession(String sessionId)
Session	findSession(String id) Return the active Session, associated with this Manager, with the specified session id (if any); otherwise return null.
Session[]	findSessions() Return the set of active Sessions associated with this Manager.
protected String	generateSessionId() Generate and return a new session identifier.
int	getActiveSessions() Returns the number of active sessions
String	getAlgorithm() Return the message digest algorithm for this Manager.
String	getClassName() Returns the name of the implementation class.
Container	getContainer() Return the Container with which this Manager is associated.
String	getCreationTime(String sessionId)
long	getCreationTimestamp(String sessionId)
MessageDigest	getDigest() Return the MessageDigest object to be used for calculating session identifiers.
boolean	getDistributable() Return the distributable flag for the sessions supported by this Manager.
String	getDomainInternal() Method implemented by sub-classes to identify the domain in which MBeans should be registered.
int	getDuplicates() Number of duplicated session IDs generated by the random source.
Engine	getEngine() Retrieve the enclosing Engine for this Manager.
String	getEntropy() Return the entropy increaser value, or compute a semi-useful value if this String has not yet been set.
long	getExpiredSessions() Gets the number of sessions that have expired.
String	getInfo() Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.
String	getJvmRoute() Retrieve the JvmRoute for the enclosing Engine.
String	getLastAccessedTime(String sessionId)
long	getLastAccessedTimestamp(String sessionId)
int	getMaxActive() Max number of concurrent active sessions
int	getMaxActiveSessions() Return the maximum number of active Sessions allowed, or -1 for no limit.
int	getMaxInactiveInterval() Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.
String	getName() Return the descriptive short name of this Manager implementation.
protected StandardSession	getNewSession() Get new session class to be used in the doLoad() method.
String	getObjectNameKeyProperties() Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.
int	getProcessExpiresFrequency() Return the frequency of manager checks.
long	getProcessingTime()
Random	getRandom() Return the random number generator instance we should use for generating session identifiers.
protected void	getRandomBytes(byte[] bytes)
String	getRandomClass() Return the random number generator class name.
String	getRandomFile()
int	getRejectedSessions() Number of session creations that failed due to maxActiveSessions
HashMap<String,String>	getSession(String sessionId) Returns information about the session with the given session id.
String	getSessionAttribute(String sessionId, String key) For debugging: get a session attribute
int	getSessionAverageAliveTime() Gets the average time (in seconds) that expired sessions had been alive.
long	getSessionCounter() Total sessions created by this manager.
int	getSessionIdLength() Gets the session id length (in bytes) of Sessions created by this Manager.
int	getSessionMaxAliveTime() Gets the longest time (in seconds) that an expired session had been alive.
String	getThisAccessedTime(String sessionId)
long	getThisAccessedTimestamp(String sessionId)
protected void	initInternal() Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
String	listSessionIds() For debugging: return a list of all session ids currently active
void	processExpires() Invalidate all sessions that have expired.
void	propertyChange(PropertyChangeEvent event) Process property change events from our associated Context.
void	remove(Session session) Remove this Session from the active Sessions for this Manager.
void	removePropertyChangeListener(PropertyChangeListener listener) Remove a property change listener from this component.
void	setAlgorithm(String algorithm) Set the message digest algorithm for this Manager.
void	setContainer(Container container) Set the Container with which this Manager is associated.
void	setDistributable(boolean distributable) Set the distributable flag for the sessions supported by this Manager.
void	setDuplicates(int duplicates)
void	setEntropy(String entropy) Set the entropy increaser value.
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	setMaxActiveSessions(int max) Set the maximum number of active Sessions allowed, or -1 for no limit.
void	setMaxInactiveInterval(int interval) Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.
void	setProcessExpiresFrequency(int processExpiresFrequency) Set the manager checks frequency.
void	setProcessingTime(long processingTime)
void	setRandomClass(String randomClass) Set the random number generator class name.
void	setRandomFile(String s) Use /dev/random-type special device.
void	setSessionAverageAliveTime(int sessionAverageAliveTime) Sets the average time (in seconds) that expired sessions had been alive.
void	setSessionCounter(long sessionCounter) Sets the total number of sessions created by this manager.
void	setSessionIdLength(int idLength) Sets the session id length (in bytes) for Sessions created by this Manager.
void	setSessionMaxAliveTime(int sessionMaxAliveTime) Sets the longest time (in seconds) that an expired session had been alive.
String	toString() Return a String rendering of this object.

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, setState, start, startInternal, stop, stopInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.catalina.Manager

load, unload

Field Detail

randomIS

protected DataInputStream randomIS

devRandomSource

protected String devRandomSource

DEFAULT_ALGORITHM

protected static final String DEFAULT_ALGORITHM

The default message digest algorithm to use if we cannot use the requested one.

See Also:

Constant Field Values

algorithm

protected String algorithm

The message digest algorithm to be used when generating session identifiers. This must be an algorithm supported by the java.security.MessageDigest class on your platform.

container

protected Container container

The Container with which this Manager is associated.

digest

protected MessageDigest digest

Return the MessageDigest implementation to be used when creating session identifiers.

distributable

protected boolean distributable

The distributable flag for Sessions created by this Manager. If this flag is set to true, any user attributes added to a session controlled by this Manager must be Serializable.

entropy

protected String entropy

A String initialization parameter used to increase the entropy of the initialization of our random number generator.

maxInactiveInterval

protected int maxInactiveInterval

The default maximum inactive interval for Sessions created by this Manager.

sessionIdLength

protected int sessionIdLength

The session id length of Sessions created by this Manager.

name

protected static String name

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

random

protected Random random

A random number generator to use when generating session identifiers.

randomClass

protected String randomClass

The Java class name of the random number generator class to be used when generating session identifiers.

sessionMaxAliveTime

protected int sessionMaxAliveTime

The longest time (in seconds) that an expired session had been alive.

sessionAverageAliveTime

protected int sessionAverageAliveTime

Average time (in seconds) that expired sessions had been alive.

expiredSessions

protected long expiredSessions

Number of sessions that have expired.

sessions

protected Map<String,Session> sessions

The set of currently active Sessions for this Manager, keyed by session identifier.

sessionCounter

protected long sessionCounter

maxActive

protected volatile int maxActive

maxActiveSessions

protected int maxActiveSessions

The maximum number of active Sessions allowed, or -1 for no limit.

rejectedSessions

protected int rejectedSessions

Number of session creations that failed due to maxActiveSessions.

duplicates

protected volatile int duplicates

processingTime

protected long processingTime

Processing time during session expiration.

processExpiresFrequency

protected int processExpiresFrequency

Frequency of the session expiration, and related manager operations. Manager operations will be done once for the specified amount of backgrondProcess calls (ie, the lower the amount, the most often the checks will occur).

sm

protected static final StringManager sm

The string manager for this package.

support

protected PropertyChangeSupport support

The property change support for this component.

Constructor Detail

ManagerBase

public ManagerBase()

Method Detail

getAlgorithm

public String getAlgorithm()

Return the message digest algorithm for this Manager.

setAlgorithm

public void setAlgorithm(String algorithm)

Set the message digest algorithm for this Manager.

Parameters:

algorithm - The new message digest algorithm

getContainer

public Container getContainer()

Return the Container with which this Manager is associated.

Specified by:

getContainer in interface Manager

setContainer

public void setContainer(Container container)

Set the Container with which this Manager is associated.

Specified by:

setContainer in interface Manager

Parameters:

container - The newly associated Container

getClassName

public String getClassName()

Returns the name of the implementation class.

getDigest

public MessageDigest getDigest()

Return the MessageDigest object to be used for calculating session identifiers. If none has been created yet, initialize one the first time this method is called.

getDistributable

public boolean getDistributable()

Return the distributable flag for the sessions supported by this Manager.

Specified by:

getDistributable in interface Manager

setDistributable

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.

Specified by:

setDistributable in interface Manager

Parameters:

distributable - The new distributable flag

getEntropy

public String getEntropy()

Return the entropy increaser value, or compute a semi-useful value if this String has not yet been set.

setEntropy

public void setEntropy(String entropy)

Set the entropy increaser value.

Parameters:

entropy - The new entropy increaser value

getInfo

public String getInfo()

Return descriptive information about this Manager implementation and the corresponding version number, in the format <description>/<version>.

Specified by:

getInfo in interface Manager

getMaxInactiveInterval

public int getMaxInactiveInterval()

Return the default maximum inactive interval (in seconds) for Sessions created by this Manager.

Specified by:

getMaxInactiveInterval in interface Manager

setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)

Set the default maximum inactive interval (in seconds) for Sessions created by this Manager.

Specified by:

setMaxInactiveInterval in interface Manager

Parameters:

interval - The new default value

getSessionIdLength

public int getSessionIdLength()

Gets the session id length (in bytes) of Sessions created by this Manager.

Specified by:

getSessionIdLength in interface Manager

Returns:

The session id length

setSessionIdLength

public void setSessionIdLength(int idLength)

Sets the session id length (in bytes) for Sessions created by this Manager.

Specified by:

setSessionIdLength in interface Manager

Parameters:

idLength - The session id length

getName

public String getName()

Return the descriptive short name of this Manager implementation.

setRandomFile

public void setRandomFile(String s)

Use /dev/random-type special device. This is new code, but may reduce the big delay in generating the random. You must specify a path to a random generator file. Use /dev/urandom for linux ( or similar ) systems. Use /dev/random for maximum security ( it may block if not enough "random" exist ). You can also use a pipe that generates random. The code will check if the file exists, and default to java Random if not found. There is a significant performance difference, very visible on the first call to getSession ( like in the first JSP ) - so use it if available.

getRandomFile

public String getRandomFile()

getRandom

public Random getRandom()

Return the random number generator instance we should use for generating session identifiers. If there is no such generator currently defined, construct and seed a new one.

getRandomClass

public String getRandomClass()

Return the random number generator class name.

setRandomClass

public void setRandomClass(String randomClass)

Set the random number generator class name.

Parameters:

randomClass - The new random number generator class name

getRejectedSessions

public int getRejectedSessions()

Number of session creations that failed due to maxActiveSessions

Specified by:

getRejectedSessions in interface Manager

Returns:

The count

getExpiredSessions

public long getExpiredSessions()

Gets the number of sessions that have expired.

Specified by:

getExpiredSessions in interface Manager

Returns:

Number of sessions that have expired

setExpiredSessions

public void setExpiredSessions(long expiredSessions)

Sets the number of sessions that have expired.

Specified by:

setExpiredSessions in interface Manager

Parameters:

expiredSessions - Number of sessions that have expired

getProcessingTime

public long getProcessingTime()

setProcessingTime

public void setProcessingTime(long processingTime)

getProcessExpiresFrequency

public int getProcessExpiresFrequency()

Return the frequency of manager checks.

setProcessExpiresFrequency

public void setProcessExpiresFrequency(int processExpiresFrequency)

Set the manager checks frequency.

Parameters:

processExpiresFrequency - the new manager checks frequency

backgroundProcess

public void backgroundProcess()

Implements the Manager interface, direct call to processExpires

Specified by:

backgroundProcess in interface Manager

processExpires

public void processExpires()

Invalidate all sessions that have expired.

destroyInternal

protected void destroyInternal()
                        throws LifecycleException

Description copied from class: LifecycleMBeanBase

Sub-classes wishing to perform additional clean-up should override this method, ensuring that super.destroyInternal() is the last call in the overriding method.

Overrides:

destroyInternal in class LifecycleMBeanBase

Throws:

LifecycleException

initInternal

protected void initInternal()
                     throws LifecycleException

Description copied from class: LifecycleMBeanBase

Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.

Overrides:

initInternal in class LifecycleMBeanBase

Throws:

LifecycleException

add

public void add(Session session)

Add this Session to the set of active Sessions for this Manager.

Specified by:

add in interface Manager

Parameters:

session - Session to be added

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Add a property change listener to this component.

Specified by:

addPropertyChangeListener in interface Manager

Parameters:

listener - The listener to add

createSession

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.

Specified by:

createSession in interface Manager

Parameters:

sessionId - The session id which should be used to create the new session; if null, a new session id will be generated

Throws:

IllegalStateException - if a new session cannot be instantiated for any reason

createEmptySession

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.

Specified by:

createEmptySession in interface Manager

findSession

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.

Specified by:

findSession in interface Manager

Parameters:

id - The session id for the session to be returned

Throws:

IllegalStateException - if a new session cannot be instantiated for any reason

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

findSessions

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.

Specified by:

findSessions in interface Manager

remove

public void remove(Session session)

Remove this Session from the active Sessions for this Manager.

Specified by:

remove in interface Manager

Parameters:

session - Session to be removed

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Remove a property change listener from this component.

Specified by:

removePropertyChangeListener in interface Manager

Parameters:

listener - The listener to remove

changeSessionId

public void changeSessionId(Session session)

Change the session ID of the current session to a new randomly generated session ID.

Specified by:

changeSessionId in interface Manager

Parameters:

session - The session to change the session ID for

getNewSession

protected StandardSession getNewSession()

Get new session class to be used in the doLoad() method.

getRandomBytes

protected void getRandomBytes(byte[] bytes)

generateSessionId

protected String generateSessionId()

Generate and return a new session identifier.

getEngine

public Engine getEngine()

Retrieve the enclosing Engine for this Manager.

Returns:

an Engine object (or null).

getJvmRoute

public String getJvmRoute()

Retrieve the JvmRoute for the enclosing Engine.

Returns:

the JvmRoute or null.

setSessionCounter

public void setSessionCounter(long sessionCounter)

Description copied from interface: Manager

Sets the total number of sessions created by this manager.

Specified by:

setSessionCounter in interface Manager

Parameters:

sessionCounter - Total number of sessions created by this manager.

getSessionCounter

public long getSessionCounter()

Total sessions created by this manager.

Specified by:

getSessionCounter in interface Manager

Returns:

sessions created

getDuplicates

public int getDuplicates()

Number of duplicated session IDs generated by the random source. Anything bigger than 0 means problems.

Returns:

The count of duplicates

setDuplicates

public void setDuplicates(int duplicates)

getActiveSessions

public int getActiveSessions()

Returns the number of active sessions

Specified by:

getActiveSessions in interface Manager

Returns:

number of sessions active

getMaxActive

public int getMaxActive()

Max number of concurrent active sessions

Specified by:

getMaxActive in interface Manager

Returns:

The highest number of concurrent active sessions

setMaxActive

public void setMaxActive(int maxActive)

Description copied from interface: Manager

(Re)sets the maximum number of sessions that have been active at the same time.

Specified by:

setMaxActive in interface Manager

Parameters:

maxActive - Maximum number of sessions that have been active at the same time.

getMaxActiveSessions

public int getMaxActiveSessions()

Return the maximum number of active Sessions allowed, or -1 for no limit.

setMaxActiveSessions

public void setMaxActiveSessions(int max)

Set the maximum number of active Sessions allowed, or -1 for no limit.

Parameters:

max - The new maximum number of sessions

getSessionMaxAliveTime

public int getSessionMaxAliveTime()

Gets the longest time (in seconds) that an expired session had been alive.

Specified by:

getSessionMaxAliveTime in interface Manager

Returns:

Longest time (in seconds) that an expired session had been alive.

setSessionMaxAliveTime

public void setSessionMaxAliveTime(int sessionMaxAliveTime)

Sets the longest time (in seconds) that an expired session had been alive.

Specified by:

setSessionMaxAliveTime in interface Manager

Parameters:

sessionMaxAliveTime - Longest time (in seconds) that an expired session had been alive.

getSessionAverageAliveTime

public int getSessionAverageAliveTime()

Gets the average time (in seconds) that expired sessions had been alive.

Specified by:

getSessionAverageAliveTime in interface Manager

Returns:

Average time (in seconds) that expired sessions had been alive.

setSessionAverageAliveTime

public void setSessionAverageAliveTime(int sessionAverageAliveTime)

Sets the average time (in seconds) that expired sessions had been alive.

Specified by:

setSessionAverageAliveTime in interface Manager

Parameters:

sessionAverageAliveTime - Average time (in seconds) that expired sessions had been alive.

listSessionIds

public String listSessionIds()

For debugging: return a list of all session ids currently active

getSessionAttribute

public String getSessionAttribute(String sessionId,
                                  String key)

For debugging: get a session attribute

Parameters:

sessionId -

key -

Returns:

The attribute value, if found, null otherwise

getSession

public HashMap<String,String> getSession(String sessionId)

Returns information about the session with the given session id.

The session information is organized as a HashMap, mapping session attribute names to the String representation of their values.

Parameters:

sessionId - Session id

Returns:

HashMap mapping session attribute names to the String representation of their values, or null if no session with the specified id exists, or if the session does not have any attributes

expireSession

public void expireSession(String sessionId)

getThisAccessedTimestamp

public long getThisAccessedTimestamp(String sessionId)

getThisAccessedTime

public String getThisAccessedTime(String sessionId)

getLastAccessedTimestamp

public long getLastAccessedTimestamp(String sessionId)

getLastAccessedTime

public String getLastAccessedTime(String sessionId)

getCreationTime

public String getCreationTime(String sessionId)

getCreationTimestamp

public long getCreationTimestamp(String sessionId)

toString

public String toString()

Return a String rendering of this object.

Overrides:

toString in class Object

getObjectNameKeyProperties

public String getObjectNameKeyProperties()

Description copied from class: LifecycleMBeanBase

Allow sub-classes to specify the key properties component of the ObjectName that will be used to register this component.

Specified by:

getObjectNameKeyProperties in class LifecycleMBeanBase

Returns:

The string representation of the key properties component of the desired ObjectName

getDomainInternal

public String getDomainInternal()

Description copied from class: LifecycleMBeanBase

Method implemented by sub-classes to identify the domain in which MBeans should be registered.

Specified by:

getDomainInternal in class LifecycleMBeanBase

Returns:

The name of the domain to use to register MBeans.

propertyChange

public void propertyChange(PropertyChangeEvent event)

Process property change events from our associated Context.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

event - The property change event that has occurred