org.jboss.as.web.session

Class AbstractSessionManager

java.lang.Object

org.apache.catalina.session.ManagerBase

org.jboss.as.web.session.AbstractSessionManager

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Lifecycle, org.apache.catalina.Manager, SessionManager, SessionManagerMBean

Direct Known Subclasses:

DistributableSessionManager

public abstract class AbstractSessionManager
extends org.apache.catalina.session.ManagerBase
implements SessionManager, SessionManagerMBean, org.apache.catalina.Lifecycle

Author:

Paul Ferraro

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicInteger	averageAliveTime Average time in ms a now expired session has been alive
protected AtomicInteger	createdCounter Number of sessions created by this manager
protected AtomicInteger	duplicates Number of times our session id generator has generated an id that matches an existing session.
protected AtomicInteger	expiredCounter Number of sessions that have been active locally that are now expired.
protected org.apache.catalina.util.LifecycleSupport	lifecycle
protected AtomicInteger	localActiveCounter Number of active sessions
protected int	maxActiveAllowed Maximum of active sessions allowed.
protected AtomicInteger	maxActiveCounter Maximum number of active sessions seen so far
protected AtomicInteger	maxAliveTime Maximum time in ms a now expired session has been alive
protected AtomicInteger	maxLocalActiveCounter Maximum number of concurrently locally active sessions
protected AtomicLong	processingTime Cumulative time spent in backgroundProcess
protected AtomicInteger	rejectedCounter number of sessions rejected because the number active sessions exceeds maxActive
protected boolean	started Has this component been started yet?
protected long	timeSinceLastReset Number of ms since last call to reset()

Fields inherited from class org.apache.catalina.session.ManagerBase

container, distributable, domain, expiredSessions, initialized, log, maxActive, maxInactiveInterval, mserver, name, oname, processExpiresFrequency, sessionAverageAliveTime, sessionCounter, sessionIdLength, sessionMaxAliveTime, sessions, sm, support

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSessionManager(org.jboss.metadata.web.jboss.JBossWebMetaData metaData)

Method Summary

Methods

Modifier and Type	Method and Description
void	addLifecycleListener(org.apache.catalina.LifecycleListener listener)
protected int	calcActiveSessions() Calculates the number of active sessions, and updates the max # of local active sessions and max # of sessions.
String	createSessionId(String realId, String jvmRoute)
org.apache.catalina.LifecycleListener[]	findLifecycleListeners()
long	getActiveSessionCount() Gets the number of sessions active on this node.
long	getCreatedSessionCount() Gets the number of sessions created on this node.
long	getExpiredSessionCount() Gets the number of sessions that have been expired on this node.
long	getLocalActiveSessionCount() Gets the count of sessions known to this manager, excluding those in the distributed stored that have not been accessed on this node.
int	getMaxActiveAllowed() Gets the maximum number of active sessions that will concurrently be allowed on this node.
long	getMaxActiveSessionCount() Gets the highest number of sessions concurrently active on this node.
int	getMaxActiveSessions() Gets the maximum number of active Sessions allowed, or -1 for no limit.
long	getMaxLocalActiveSessionCount() Gets the highest value seen for #getLocalSessionCount()
long	getRejectedSessionCount() Gets the number of times session creation has failed because the number of active sessions exceeds maxActiveAllowed
int	getRejectedSessions() Gets the number of sessions we rejected due to maxActive being reached.
ReplicationStatistics	getReplicationStatistics() Gets the replication statistics for the sessions managed by this manager.
long	getTimeSinceLastReset() Gets the elapsed time (in seconds) since this manager was instantiated or the last call to resetStats()
protected abstract int	getTotalActiveSessions() Get the total number of active sessions
void	load()
Map.Entry<String,String>	parse(String sessionId)
protected abstract void	processExpirationPassivation()
void	processExpires()
void	removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
void	resetStats() Resets all statistics.
protected void	sessionExpired(int sessionAliveTime) Updates statistics to reflect that a session with a given "alive time" has been expired.
void	setMaxActiveAllowed(int max) Sets the maximum number of active sessions that will concurrently be allowed on this node, excluding any sessions that have been passivated.
void	setNewSessionCookie(String sessionId, javax.servlet.http.HttpServletResponse response) Sets a new cookie for the given session id and response
void	setRejectedSessions(int rejectedSessions)
void	start()
void	stop()
void	unload()

Methods inherited from class org.apache.catalina.session.ManagerBase

add, addPropertyChangeListener, appendJVMRoute, backgroundProcess, changeSessionId, createEmptySession, createSession, destroy, encode, expireSession, findSession, findSessions, generateSessionId, getActiveSessions, getClassName, getContainer, getCreationTime, getDistributable, getDomain, getDuplicates, getEngine, getExpiredSessions, getInfo, getJvmRoute, getLastAccessedTime, getMaxActive, getMaxInactiveInterval, getName, getNewSession, getObjectName, getProcessExpiresFrequency, getProcessingTime, getSession, getSessionAttribute, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, init, listSessionIds, postDeregister, postRegister, preDeregister, preRegister, remove, removePropertyChangeListener, setContainer, setDistributable, setDuplicates, setExpiredSessions, setMaxActive, setMaxInactiveInterval, setProcessExpiresFrequency, setProcessingTime, setSessionAverageAliveTime, setSessionCounter, setSessionIdLength, setSessionMaxAliveTime

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jboss.as.web.session.SessionManager

getJvmRoute, locate, removeLocal, storeSession

Methods inherited from interface org.apache.catalina.Manager

add, addPropertyChangeListener, backgroundProcess, changeSessionId, createEmptySession, createSession, findSession, findSessions, getActiveSessions, getContainer, getDistributable, getExpiredSessions, getInfo, getMaxActive, getMaxInactiveInterval, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, remove, removePropertyChangeListener, setContainer, setDistributable, setExpiredSessions, setMaxActive, setMaxInactiveInterval, setSessionAverageAliveTime, setSessionCounter, setSessionIdLength, setSessionMaxAliveTime

Methods inherited from interface org.jboss.as.web.session.SessionManagerMBean

getActiveSessions, getClassName, getDistributable, getExpiredSessions, getMaxActive, getMaxInactiveInterval, getName, getProcessExpiresFrequency, getProcessingTime, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, setDistributable, setMaxActive, setMaxInactiveInterval, setProcessExpiresFrequency, setProcessingTime, setSessionCounter, setSessionMaxAliveTime

Field Detail

maxActiveAllowed

protected int maxActiveAllowed

Maximum of active sessions allowed. -1 is unlimited.

lifecycle

protected org.apache.catalina.util.LifecycleSupport lifecycle

started

protected volatile boolean started

Has this component been started yet?

createdCounter

protected AtomicInteger createdCounter

Number of sessions created by this manager

rejectedCounter

protected AtomicInteger rejectedCounter

number of sessions rejected because the number active sessions exceeds maxActive

localActiveCounter

protected AtomicInteger localActiveCounter

Number of active sessions

maxLocalActiveCounter

protected AtomicInteger maxLocalActiveCounter

Maximum number of concurrently locally active sessions

maxActiveCounter

protected AtomicInteger maxActiveCounter

Maximum number of active sessions seen so far

expiredCounter

protected AtomicInteger expiredCounter

Number of sessions that have been active locally that are now expired.

timeSinceLastReset

protected long timeSinceLastReset

Number of ms since last call to reset()

processingTime

protected AtomicLong processingTime

Cumulative time spent in backgroundProcess

maxAliveTime

protected AtomicInteger maxAliveTime

Maximum time in ms a now expired session has been alive

averageAliveTime

protected AtomicInteger averageAliveTime

Average time in ms a now expired session has been alive

duplicates

protected AtomicInteger duplicates

Number of times our session id generator has generated an id that matches an existing session.

Constructor Detail

AbstractSessionManager

protected AbstractSessionManager(org.jboss.metadata.web.jboss.JBossWebMetaData metaData)

Method Detail

start

public void start()
           throws org.apache.catalina.LifecycleException

Specified by:

start in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Specified by:

stop in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

processExpires

public void processExpires()

Overrides:

processExpires in class org.apache.catalina.session.ManagerBase

processExpirationPassivation

protected abstract void processExpirationPassivation()

addLifecycleListener

public void addLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

addLifecycleListener in interface org.apache.catalina.Lifecycle

findLifecycleListeners

public org.apache.catalina.LifecycleListener[] findLifecycleListeners()

Specified by:

findLifecycleListeners in interface org.apache.catalina.Lifecycle

removeLifecycleListener

public void removeLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

removeLifecycleListener in interface org.apache.catalina.Lifecycle

getRejectedSessions

public int getRejectedSessions()

Description copied from interface: SessionManagerMBean

Gets the number of sessions we rejected due to maxActive being reached. Same as SessionManagerMBean.getRejectedSessionCount()

Specified by:

getRejectedSessions in interface org.apache.catalina.Manager

Specified by:

getRejectedSessions in interface SessionManagerMBean

setRejectedSessions

public void setRejectedSessions(int rejectedSessions)

Specified by:

setRejectedSessions in interface org.apache.catalina.Manager

load

public void load()
          throws ClassNotFoundException,
                 IOException

Specified by:

load in interface org.apache.catalina.Manager

Throws:

ClassNotFoundException

IOException

unload

public void unload()
            throws IOException

Specified by:

unload in interface org.apache.catalina.Manager

Throws:

IOException

setNewSessionCookie

public void setNewSessionCookie(String sessionId,
                       javax.servlet.http.HttpServletResponse response)

Description copied from interface: SessionManager

Sets a new cookie for the given session id and response

Specified by:

setNewSessionCookie in interface SessionManager

Parameters:

sessionId - The session id

getReplicationStatistics

public ReplicationStatistics getReplicationStatistics()

Description copied from interface: SessionManagerMBean

Gets the replication statistics for the sessions managed by this manager.

Specified by:

getReplicationStatistics in interface SessionManagerMBean

Returns:

the statistics

resetStats

public void resetStats()

Description copied from interface: SessionManagerMBean

Resets all statistics.

Specified by:

resetStats in interface SessionManagerMBean

getTimeSinceLastReset

public long getTimeSinceLastReset()

Description copied from interface: SessionManagerMBean

Gets the elapsed time (in seconds) since this manager was instantiated or the last call to resetStats()

Specified by:

getTimeSinceLastReset in interface SessionManagerMBean

getActiveSessionCount

public long getActiveSessionCount()

Description copied from interface: SessionManagerMBean

Gets the number of sessions active on this node. This includes replicated sessions that have not been accessed on this node.

Specified by:

getActiveSessionCount in interface SessionManagerMBean

getLocalActiveSessionCount

public long getLocalActiveSessionCount()

Description copied from interface: SessionManagerMBean

Gets the count of sessions known to this manager, excluding those in the distributed stored that have not been accessed on this node.

Specified by:

getLocalActiveSessionCount in interface SessionManagerMBean

getRejectedSessionCount

public long getRejectedSessionCount()

Description copied from interface: SessionManagerMBean

Gets the number of times session creation has failed because the number of active sessions exceeds maxActiveAllowed

Specified by:

getRejectedSessionCount in interface SessionManagerMBean

getCreatedSessionCount

public long getCreatedSessionCount()

Description copied from interface: SessionManagerMBean

Gets the number of sessions created on this node. Does not include sessions initially created on other nodes, even if those sessions were accessed on this node.

Specified by:

getCreatedSessionCount in interface SessionManagerMBean

getExpiredSessionCount

public long getExpiredSessionCount()

Description copied from interface: SessionManagerMBean

Gets the number of sessions that have been expired on this node.

Specified by:

getExpiredSessionCount in interface SessionManagerMBean

getMaxActiveSessionCount

public long getMaxActiveSessionCount()

Description copied from interface: SessionManagerMBean

Gets the highest number of sessions concurrently active on this node. This includes replicated sessions that have not been accessed on this node.

Specified by:

getMaxActiveSessionCount in interface SessionManagerMBean

getMaxLocalActiveSessionCount

public long getMaxLocalActiveSessionCount()

Description copied from interface: SessionManagerMBean

Gets the highest value seen for #getLocalSessionCount()

Specified by:

getMaxLocalActiveSessionCount in interface SessionManagerMBean

getMaxActiveAllowed

public int getMaxActiveAllowed()

Description copied from interface: SessionManagerMBean

Gets the maximum number of active sessions that will concurrently be allowed on this node. This includes replicated sessions that have not been accessed on this node.

Specified by:

getMaxActiveAllowed in interface SessionManagerMBean

setMaxActiveAllowed

public void setMaxActiveAllowed(int max)

Description copied from interface: SessionManagerMBean

Sets the maximum number of active sessions that will concurrently be allowed on this node, excluding any sessions that have been passivated. This includes replicated sessions that have not been accessed on this node. If the active session count exceeds this value and an attempt to create a new session is made, session creation will fail with an IllegalStateException.

Specified by:

setMaxActiveAllowed in interface SessionManagerMBean

Parameters:

max - the max number of sessions, or -1 if there is no limit.

getMaxActiveSessions

public int getMaxActiveSessions()

Description copied from interface: SessionManagerMBean

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

Specified by:

getMaxActiveSessions in interface SessionManagerMBean

parse

public Map.Entry<String,String> parse(String sessionId)

Specified by:

parse in interface SessionManager

createSessionId

public String createSessionId(String realId,
                     String jvmRoute)

Specified by:

createSessionId in interface SessionManager

sessionExpired

protected void sessionExpired(int sessionAliveTime)

Updates statistics to reflect that a session with a given "alive time" has been expired.

Parameters:

sessionAliveTime - number of ms from when the session was created to when it was expired.

calcActiveSessions

protected int calcActiveSessions()

Calculates the number of active sessions, and updates the max # of local active sessions and max # of sessions.

Call this method when a new session is added or when an accurate count of active sessions is needed.

Returns:

the size of the sessions map + the size of the unloaded sessions map - the count of passivated sessions

getTotalActiveSessions

protected abstract int getTotalActiveSessions()

Get the total number of active sessions