org.jboss.as.web.session

Class DistributableSessionManager<O extends OutgoingDistributableSessionData>

java.lang.Object

org.apache.catalina.session.ManagerBase

org.jboss.as.web.session.AbstractSessionManager

org.jboss.as.web.session.DistributableSessionManager<O>

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Lifecycle, org.apache.catalina.LifecycleListener, org.apache.catalina.Manager, LocalDistributableSessionManager, ClusteredSessionManager<O>, DistributableSessionManagerMBean, SessionManager, SessionManagerMBean

public class DistributableSessionManager<O extends OutgoingDistributableSessionData>
extends AbstractSessionManager
implements LocalDistributableSessionManager, ClusteredSessionManager<O>, DistributableSessionManagerMBean, org.apache.catalina.LifecycleListener

Author:

Paul Ferraro

Field Summary

Fields inherited from class org.jboss.as.web.session.AbstractSessionManager

averageAliveTime, createdCounter, duplicates, expiredCounter, lifecycle, localActiveCounter, maxActiveAllowed, maxActiveCounter, maxAliveTime, maxLocalActiveCounter, processingTime, rejectedCounter, started, timeSinceLastReset

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

container, distributable, domain, expiredSessions, initialized, log, maxActive, maxInactiveInterval, mserver, 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

Constructor and Description
DistributableSessionManager(DistributedCacheManagerFactory factory, org.apache.catalina.Context context, org.jboss.metadata.web.jboss.JBossWebMetaData metaData, org.jboss.marshalling.ClassResolver resolver)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.apache.catalina.Session session)
protected boolean	appendJVMRoute()
protected ClusteredSessionNotificationPolicy	createClusteredSessionNotificationPolicy()
ClusteredSession<O>	createEmptySession()
org.apache.catalina.Session	createSession(String sessionId, Random random)
String	createSessionId(String realId, String jvmRoute)
protected SnapshotManager	createSnapshotManager()
ClusteredSession<O>	findSession(String id)
org.apache.catalina.Session[]	findSessions()
org.jboss.marshalling.ClassResolver	getApplicationClassResolver() Get the classloader able to load application classes.
String	getCacheConfigName() Gets the cache config name used to get the underlying cache from a cache manager.
String	getContextName()
DistributedCacheManager<O>	getDistributedCacheManager() Gets the DistributedCacheManager through which we interact with the distributed cache.
String	getEngineName() Returns the name of the session manager's engine.
String	getHostName()
String	getInfo()
long	getMaxPassivatedSessionCount() Gets the highest number of passivated sessions seen.
int	getMaxUnreplicatedInterval() Get the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.
String	getName() Returns the unique name of this session manager.
ClusteredSessionNotificationPolicy	getNotificationPolicy() Gets the policy for determining whether the servlet spec notifications related to session events are allowed to be emitted on the local cluster node.
long	getPassivatedSessionCount() Gets the number of passivated sessions
long	getPassivationMaxIdleTime() Elapsed time after which an inactive session will be passivated to persistent storage if passivation is enabled.
long	getPassivationMinIdleTime() Elapsed time after which an inactive session will be passivated to persistent storage if passivation is enabled and the manager needs to passivate sessions early in order to comply with a SessionManagerMBean.getMaxActiveAllowed() setting.
org.jboss.metadata.web.jboss.ReplicationConfig	getReplicationConfig() Gets the web application metadata.
org.jboss.metadata.web.jboss.ReplicationGranularity	getReplicationGranularity() Gets the replication granularity.
org.jboss.metadata.web.jboss.ReplicationTrigger	getReplicationTrigger() Gets the policy controlling whether session attribute reads and writes mark the session/attribute as needing replication.
int	getSnapshotInterval() Gets the number of milliseconds between replications if "interval" mode is used.
org.jboss.metadata.web.jboss.SnapshotMode	getSnapshotMode() Gets the snapshot mode.
protected int	getTotalActiveSessions() Get the total number of active sessions
boolean	getUseJK() Gets whether JK is being used and special handling of a jvmRoute portion of session ids is needed.
protected void	initializeUnloadedSessions() Gets the ids of all sessions in the distributed cache and adds them to the unloaded sessions map, along with their lastAccessedTime and their maxInactiveInterval.
protected void	installValves() Instantiate a SnapshotManager and ClusteredSessionValve and add the valve to our parent Context's pipeline.
boolean	isPassivationEnabled() Gets whether the webapp is configured for passivation.
void	lifecycleEvent(org.apache.catalina.LifecycleEvent event)
String	listLocalSessionIds() Lists all session ids known to this manager, excluding those in the distributed store that have not been accessed on this node.
String	locate(String sessionId) Locate the most appropriate jvm route for the specified sessionId
void	notifyLocalAttributeModification(String realId) Callback from the distributed cache notifying of a local modification to a session's attributes.
void	notifyRemoteInvalidation(String realId) Notifies the manager that a session in the distributed cache has been invalidated
Map.Entry<String,String>	parse(String sessionId)
protected void	processExpirationPassivation()
void	remove(org.apache.catalina.Session s)
void	removeLocal(org.apache.catalina.Session s) Remove the active session locally from the manager without replicating to the cluster.
void	sessionActivated() Notification that a previously passivated session has been activated.
boolean	sessionChangedInDistributedCache(String realId, String dataOwner, int distributedVersion, long timestamp, DistributableSessionMetadata metadata) Callback from the distributed cache to notify us that a session has been modified remotely.
void	setMaxUnreplicatedInterval(int maxUnreplicatedInterval) Sets the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.
void	start()
void	stop()
boolean	storeSession(org.apache.catalina.Session s) Store the modified session.

Methods inherited from class org.jboss.as.web.session.AbstractSessionManager

addLifecycleListener, calcActiveSessions, findLifecycleListeners, getActiveSessionCount, getCreatedSessionCount, getExpiredSessionCount, getLocalActiveSessionCount, getMaxActiveAllowed, getMaxActiveSessionCount, getMaxActiveSessions, getMaxLocalActiveSessionCount, getRejectedSessionCount, getRejectedSessions, getReplicationStatistics, getTimeSinceLastReset, load, processExpires, removeLifecycleListener, resetStats, sessionExpired, setMaxActiveAllowed, setNewSessionCookie, setRejectedSessions, unload

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

addPropertyChangeListener, backgroundProcess, changeSessionId, destroy, encode, expireSession, generateSessionId, getActiveSessions, getClassName, getContainer, getCreationTime, getDistributable, getDomain, getDuplicates, getEngine, getExpiredSessions, getJvmRoute, getLastAccessedTime, getMaxActive, getMaxInactiveInterval, getNewSession, getObjectName, getProcessExpiresFrequency, getProcessingTime, getSession, getSessionAttribute, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, init, listSessionIds, postDeregister, postRegister, preDeregister, preRegister, 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.clustering.web.LocalDistributableSessionManager

getJvmRoute

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

getJvmRoute, setNewSessionCookie

Methods inherited from interface org.apache.catalina.Manager

addPropertyChangeListener, backgroundProcess, changeSessionId, getActiveSessions, getContainer, getDistributable, getExpiredSessions, getMaxActive, getMaxInactiveInterval, getRejectedSessions, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, load, removePropertyChangeListener, setContainer, setDistributable, setExpiredSessions, setMaxActive, setMaxInactiveInterval, setRejectedSessions, setSessionAverageAliveTime, setSessionCounter, setSessionIdLength, setSessionMaxAliveTime, unload

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

expireSession, getCreationTime, getDuplicates, getLastAccessedTime, getSessionAttribute, listSessionIds, setDuplicates

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

getActiveSessionCount, getActiveSessions, getClassName, getCreatedSessionCount, getDistributable, getExpiredSessionCount, getExpiredSessions, getLocalActiveSessionCount, getMaxActive, getMaxActiveAllowed, getMaxActiveSessionCount, getMaxActiveSessions, getMaxInactiveInterval, getMaxLocalActiveSessionCount, getProcessExpiresFrequency, getProcessingTime, getRejectedSessionCount, getRejectedSessions, getReplicationStatistics, getSessionAverageAliveTime, getSessionCounter, getSessionIdLength, getSessionMaxAliveTime, getTimeSinceLastReset, resetStats, setDistributable, setMaxActive, setMaxActiveAllowed, setMaxInactiveInterval, setProcessExpiresFrequency, setProcessingTime, setSessionCounter, setSessionMaxAliveTime

Constructor Detail

DistributableSessionManager

public DistributableSessionManager(DistributedCacheManagerFactory factory,
                           org.apache.catalina.Context context,
                           org.jboss.metadata.web.jboss.JBossWebMetaData metaData,
                           org.jboss.marshalling.ClassResolver resolver)
                            throws ClusteringNotSupportedException

Throws:

ClusteringNotSupportedException

Method Detail

getHostName

public String getHostName()

Specified by:

getHostName in interface LocalDistributableSessionManager

getContextName

public String getContextName()

Specified by:

getContextName in interface LocalDistributableSessionManager

getName

public String getName()

Description copied from interface: LocalDistributableSessionManager

Returns the unique name of this session manager. Typically composed of host name and context name.

Specified by:

getName in interface LocalDistributableSessionManager

Specified by:

getName in interface SessionManagerMBean

Overrides:

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

Returns:

a unique name

start

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

Specified by:

start in interface org.apache.catalina.Lifecycle

Overrides:

start in class AbstractSessionManager

Throws:

org.apache.catalina.LifecycleException

installValves

protected void installValves()

Instantiate a SnapshotManager and ClusteredSessionValve and add the valve to our parent Context's pipeline. Add a JvmRouteValve and BatchReplicationClusteredSessionValve if needed.

createSnapshotManager

protected SnapshotManager createSnapshotManager()

initializeUnloadedSessions

protected void initializeUnloadedSessions()

Gets the ids of all sessions in the distributed cache and adds them to the unloaded sessions map, along with their lastAccessedTime and their maxInactiveInterval. Passivates overage or excess sessions.

createClusteredSessionNotificationPolicy

protected ClusteredSessionNotificationPolicy createClusteredSessionNotificationPolicy()

stop

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

Specified by:

stop in interface org.apache.catalina.Lifecycle

Overrides:

stop in class AbstractSessionManager

Throws:

org.apache.catalina.LifecycleException

createSession

public org.apache.catalina.Session createSession(String sessionId,
                                        Random random)

Specified by:

createSession in interface org.apache.catalina.Manager

Overrides:

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

appendJVMRoute

protected boolean appendJVMRoute()

Overrides:

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

createEmptySession

public ClusteredSession<O> createEmptySession()

Specified by:

createEmptySession in interface org.apache.catalina.Manager

Overrides:

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

findSession

public ClusteredSession<O> findSession(String id)

Specified by:

findSession in interface org.apache.catalina.Manager

Overrides:

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

findSessions

public org.apache.catalina.Session[] findSessions()

Specified by:

findSessions in interface org.apache.catalina.Manager

Overrides:

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

remove

public void remove(org.apache.catalina.Session s)

Specified by:

remove in interface org.apache.catalina.Manager

Overrides:

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

lifecycleEvent

public void lifecycleEvent(org.apache.catalina.LifecycleEvent event)

Specified by:

lifecycleEvent in interface org.apache.catalina.LifecycleListener

locate

public String locate(String sessionId)

Description copied from interface: SessionManager

Locate the most appropriate jvm route for the specified sessionId

Specified by:

locate in interface SessionManager

Parameters:

sessionId - a session identifier

Returns:

a jvm route

removeLocal

public void removeLocal(org.apache.catalina.Session s)

Description copied from interface: SessionManager

Remove the active session locally from the manager without replicating to the cluster. This can be useful when the session is expired, for example, where there is not need to propagate the expiration.

Specified by:

removeLocal in interface SessionManager

storeSession

public boolean storeSession(org.apache.catalina.Session s)

Description copied from interface: SessionManager

Store the modified session.

Specified by:

storeSession in interface SessionManager

getInfo

public String getInfo()

Specified by:

getInfo in interface org.apache.catalina.Manager

Overrides:

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

add

public void add(org.apache.catalina.Session session)

Specified by:

add in interface org.apache.catalina.Manager

Overrides:

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

getCacheConfigName

public String getCacheConfigName()

Description copied from interface: DistributableSessionManagerMBean

Gets the cache config name used to get the underlying cache from a cache manager.

Specified by:

getCacheConfigName in interface DistributableSessionManagerMBean

Returns:

the config name, or null if this has not yet been configured or the cache was directly injected.

getReplicationGranularity

public org.jboss.metadata.web.jboss.ReplicationGranularity getReplicationGranularity()

Description copied from interface: DistributableSessionManagerMBean

Gets the replication granularity.

Specified by:

getReplicationGranularity in interface DistributableSessionManagerMBean

Returns:

SESSION, ATTRIBUTE or FIELD, or null if this has not yet been configured.

getSnapshotMode

public org.jboss.metadata.web.jboss.SnapshotMode getSnapshotMode()

Description copied from interface: DistributableSessionManagerMBean

Gets the snapshot mode.

Specified by:

getSnapshotMode in interface DistributableSessionManagerMBean

Returns:

"instant" or "interval"

getSnapshotInterval

public int getSnapshotInterval()

Description copied from interface: DistributableSessionManagerMBean

Gets the number of milliseconds between replications if "interval" mode is used.

Specified by:

getSnapshotInterval in interface DistributableSessionManagerMBean

setMaxUnreplicatedInterval

public void setMaxUnreplicatedInterval(int maxUnreplicatedInterval)

Description copied from interface: DistributableSessionManagerMBean

Sets the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty.

Specified by:

setMaxUnreplicatedInterval in interface DistributableSessionManagerMBean

Parameters:

maxUnreplicatedInterval - the maximum interval since last replication after which a request will trigger session metadata replication. A value of 0 means replicate metadata on every request; a value of -1 means never replicate metadata unless the session is otherwise dirty.

listLocalSessionIds

public String listLocalSessionIds()

Description copied from interface: DistributableSessionManagerMBean

Lists all session ids known to this manager, excluding those in the distributed store that have not been accessed on this node.

Specified by:

listLocalSessionIds in interface DistributableSessionManagerMBean

Returns:

a comma-separated list of session ids

getPassivatedSessionCount

public long getPassivatedSessionCount()

Description copied from interface: DistributableSessionManagerMBean

Gets the number of passivated sessions

Specified by:

getPassivatedSessionCount in interface DistributableSessionManagerMBean

Returns:

getMaxPassivatedSessionCount

public long getMaxPassivatedSessionCount()

Description copied from interface: DistributableSessionManagerMBean

Gets the highest number of passivated sessions seen.

Specified by:

getMaxPassivatedSessionCount in interface DistributableSessionManagerMBean

Returns:

getPassivationMaxIdleTime

public long getPassivationMaxIdleTime()

Description copied from interface: DistributableSessionManagerMBean

Elapsed time after which an inactive session will be passivated to persistent storage if passivation is enabled.

Specified by:

getPassivationMaxIdleTime in interface DistributableSessionManagerMBean

Returns:

getPassivationMinIdleTime

public long getPassivationMinIdleTime()

Description copied from interface: DistributableSessionManagerMBean

Elapsed time after which an inactive session will be passivated to persistent storage if passivation is enabled and the manager needs to passivate sessions early in order to comply with a SessionManagerMBean.getMaxActiveAllowed() setting.

Specified by:

getPassivationMinIdleTime in interface DistributableSessionManagerMBean

Returns:

getMaxUnreplicatedInterval

public int getMaxUnreplicatedInterval()

Description copied from interface: ClusteredSessionManager

Get the maximum interval between requests, in seconds, after which a request will trigger replication of the session's metadata regardless of whether the request has otherwise made the session dirty. Such replication ensures that other nodes in the cluster are aware of a relatively recent value for the session's timestamp and won't incorrectly expire an unreplicated session upon failover.

Default value is -1.

The cost of the metadata replication depends on the configured replication granularity. With SESSION, the sesssion's attribute map is replicated along with the metadata, so it can be fairly costly. With other granularities, the metadata object is replicated separately from the attributes and only contains a String, and a few longs, ints and booleans.

Specified by:

getMaxUnreplicatedInterval in interface ClusteredSessionManager<O extends OutgoingDistributableSessionData>

Specified by:

getMaxUnreplicatedInterval in interface DistributableSessionManagerMBean

Returns:

the maximum interval since last replication after which a request will trigger session metadata replication. A value of 0 means replicate metadata on every request; a value of -1 means never replicate metadata unless the session is otherwise dirty.

getNotificationPolicy

public ClusteredSessionNotificationPolicy getNotificationPolicy()

Description copied from interface: ClusteredSessionManager

Gets the policy for determining whether the servlet spec notifications related to session events are allowed to be emitted on the local cluster node.

Specified by:

getNotificationPolicy in interface ClusteredSessionManager<O extends OutgoingDistributableSessionData>

getReplicationTrigger

public org.jboss.metadata.web.jboss.ReplicationTrigger getReplicationTrigger()

Description copied from interface: ClusteredSessionManager

Gets the policy controlling whether session attribute reads and writes mark the session/attribute as needing replication.

Specified by:

getReplicationTrigger in interface ClusteredSessionManager<O extends OutgoingDistributableSessionData>

Specified by:

getReplicationTrigger in interface DistributableSessionManagerMBean

Returns:

SET, SET_AND_GET, SET_AND_NON_PRIMITIVE_GET or null if this has not yet been configured.

getUseJK

public boolean getUseJK()

Description copied from interface: DistributableSessionManagerMBean

Gets whether JK is being used and special handling of a jvmRoute portion of session ids is needed.

Specified by:

getUseJK in interface DistributableSessionManagerMBean

getDistributedCacheManager

public DistributedCacheManager<O> getDistributedCacheManager()

Description copied from interface: ClusteredSessionManager

Gets the DistributedCacheManager through which we interact with the distributed cache.

Specified by:

getDistributedCacheManager in interface ClusteredSessionManager<O extends OutgoingDistributableSessionData>

isPassivationEnabled

public boolean isPassivationEnabled()

Description copied from interface: LocalDistributableSessionManager

Gets whether the webapp is configured for passivation.

Specified by:

isPassivationEnabled in interface LocalDistributableSessionManager

Specified by:

isPassivationEnabled in interface DistributableSessionManagerMBean

Returns:

true if passivation is enabled

getEngineName

public String getEngineName()

Description copied from interface: LocalDistributableSessionManager

Returns the name of the session manager's engine. The engine name should be the consistent on all nodes.

Specified by:

getEngineName in interface LocalDistributableSessionManager

Returns:

an engine name.

getApplicationClassResolver

public org.jboss.marshalling.ClassResolver getApplicationClassResolver()

Description copied from interface: LocalDistributableSessionManager

Get the classloader able to load application classes.

Specified by:

getApplicationClassResolver in interface LocalDistributableSessionManager

Returns:

the classloader. Will not return null

getReplicationConfig

public org.jboss.metadata.web.jboss.ReplicationConfig getReplicationConfig()

Description copied from interface: LocalDistributableSessionManager

Gets the web application metadata.

Specified by:

getReplicationConfig in interface LocalDistributableSessionManager

Returns:

the metadata. will not return null

notifyRemoteInvalidation

public void notifyRemoteInvalidation(String realId)

Description copied from interface: LocalDistributableSessionManager

Notifies the manager that a session in the distributed cache has been invalidated

Specified by:

notifyRemoteInvalidation in interface LocalDistributableSessionManager

Parameters:

realId - the session id excluding any jvmRoute

notifyLocalAttributeModification

public void notifyLocalAttributeModification(String realId)

Description copied from interface: LocalDistributableSessionManager

Callback from the distributed cache notifying of a local modification to a session's attributes. Meant for use with FIELD granularity, where the session may not be aware of modifications.

Specified by:

notifyLocalAttributeModification in interface LocalDistributableSessionManager

Parameters:

realId - the session id excluding any jvmRoute

sessionActivated

public void sessionActivated()

Description copied from interface: LocalDistributableSessionManager

Notification that a previously passivated session has been activated.

Specified by:

sessionActivated in interface LocalDistributableSessionManager

sessionChangedInDistributedCache

public boolean sessionChangedInDistributedCache(String realId,
                                       String dataOwner,
                                       int distributedVersion,
                                       long timestamp,
                                       DistributableSessionMetadata metadata)

Description copied from interface: LocalDistributableSessionManager

Callback from the distributed cache to notify us that a session has been modified remotely.

Specified by:

sessionChangedInDistributedCache in interface LocalDistributableSessionManager

Parameters:

realId - the session id, without any trailing jvmRoute

dataOwner - the owner of the session. Can be null if the owner is unknown.

distributedVersion - the session's version per the distributed cache

timestamp - the session's timestamp per the distributed cache

metadata - the session's metadata per the distributed cache

processExpirationPassivation

protected void processExpirationPassivation()

Specified by:

processExpirationPassivation in class AbstractSessionManager

parse

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

Specified by:

parse in interface SessionManager

Overrides:

parse in class AbstractSessionManager

createSessionId

public String createSessionId(String realId,
                     String jvmRoute)

Specified by:

createSessionId in interface SessionManager

Overrides:

createSessionId in class AbstractSessionManager

getTotalActiveSessions

protected int getTotalActiveSessions()

Description copied from class: AbstractSessionManager

Get the total number of active sessions

Specified by:

getTotalActiveSessions in class AbstractSessionManager