org.jboss.as.web.session

Class ClusteredSession<O extends OutgoingDistributableSessionData>

java.lang.Object

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

All Implemented Interfaces:

javax.servlet.http.HttpSession, org.apache.catalina.Session

public abstract class ClusteredSession<O extends OutgoingDistributableSessionData>
extends Object
implements javax.servlet.http.HttpSession, org.apache.catalina.Session

Abstract base class for session clustering based on StandardSession. Different session replication strategies can be implemented by subclasses.

Version:

$Revision: 109139 $

Author:

Ben Wang, Brian Stansberry

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ACTIVITY_CHECK
protected static Class<?>[]	containerEventTypes The method signature for the fireContainerEvent method.
protected static String[]	excludedAttributes Set of attribute names which are not allowed to be replicated/persisted.
protected static String	info Descriptive information describing this Session implementation.
protected static org.jboss.logging.Logger	log
protected static Set<String>	replicationExcludes Set containing all members of excludedAttributes.
protected static javax.servlet.http.HttpSessionContext	sessionContext The dummy HTTP session context used for servlet spec compliance.
protected static org.apache.catalina.util.StringManager	sm The string manager for this package.

Fields inherited from interface org.apache.catalina.Session

SESSION_ACTIVATED_EVENT, SESSION_CREATED_EVENT, SESSION_DESTROYED_EVENT, SESSION_ID_CHANGED_EVENT, SESSION_PASSIVATED_EVENT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClusteredSession(ClusteredSessionManager<O> manager) Creates a new ClusteredSession.

Method Summary

Methods

Modifier and Type	Method and Description
void	access()
void	addSessionListener(org.apache.catalina.SessionListener listener)
protected boolean	canAttributeBeReplicated(Object attribute) Returns whether the attribute's type is one that can be replicated.
void	endAccess()
protected void	establishDistributedCacheManager() Gets a reference to the JBossCacheService.
void	expire()
void	expire(boolean notify, boolean localCall, boolean localOnly, ClusteredSessionNotificationCause cause) Expires the session, notifying listeners and possibly the manager.
Object	getAttribute(String name)
protected Object	getAttributeInternal(String name)
Enumeration<String>	getAttributeNames()
protected Map<String,Object>	getAttributesInternal()
String	getAuthType()
long	getCreationTime()
long	getCreationTimeInternal() Gets the sessions creation time, skipping any validity check.
protected DistributedCacheManager<O>	getDistributedCacheManager()
String	getId()
String	getIdInternal()
long	getLastAccessedTime()
long	getLastAccessedTimeInternal()
long	getLastReplicated() Gets the time processSessionReplication() was last called, or 0 if it has never been called.
org.apache.catalina.Manager	getManager()
protected ClusteredSessionManager<O>	getManagerInternal()
int	getMaxInactiveInterval()
long	getMaxUnreplicatedInterval() Gets the maximum period in ms after which a request accessing this session will trigger replication of its timestamp, even if the request doesn't otherwise modify the session.
boolean	getMustReplicateTimestamp()
boolean	getNeedsPostReplicateActivation() Gets whether the session needs to notify HttpSessionActivationListeners that it has been activated following replication.
Object	getNote(String name)
Iterator<String>	getNoteNames()
protected abstract O	getOutgoingSessionData()
Principal	getPrincipal()
String	getRealId() Gets the session id with any appended jvmRoute info removed.
javax.servlet.ServletContext	getServletContext()
javax.servlet.http.HttpSession	getSession()
javax.servlet.http.HttpSessionContext	getSessionContext() Deprecated.
protected DistributableSessionMetadata	getSessionMetadata()
protected long	getSessionTimestamp()
Object	getValue(String name) Deprecated.
String[]	getValueNames() Deprecated.
protected int	getVersion()
void	invalidate() Invalidates this session and unbinds any objects bound to it.
protected boolean	isFullReplicationNeeded()
protected boolean	isGetDirty(Object attribute)
protected boolean	isMutable(Object attribute)
boolean	isNew()
boolean	isOutdated() Check to see if the session data is still valid.
protected boolean	isSessionAttributeMapDirty()
boolean	isSessionDirty()
protected boolean	isSessionMetadataDirty()
boolean	isValid() Overrides the superclass method to call @ #isValid(boolean) isValid(true)} .
boolean	isValid(boolean expireIfInvalid) Returns whether the current session is still valid, but only calls expire for timed-out sessions if expireIfInvalid is true.
boolean	isValidInternal() Return the isValid flag for this session without any expiration check.
void	notifyDidActivate(ClusteredSessionNotificationCause cause) Inform any HttpSessionActivationListener that the session has been activated.
void	notifyWillPassivate(ClusteredSessionNotificationCause cause) Inform any HttpSessionActivationListener that the session will passivate.
protected void	populateAttributes(Map<String,Object> distributedCacheAttributes) Extension point for subclasses to load the attribute map from the distributed cache.
void	processSessionReplication() Increment our version and propagate ourself to the distributed cache.
void	putValue(String name, Object value) Deprecated.
void	recycle()
void	removeAttribute(String name)
protected abstract Object	removeAttributeInternal(String name, boolean localCall, boolean localOnly)
protected Map<String,Object>	removeExcludedAttributes(Map<String,Object> attributes) Removes any attribute whose name is found in excludedAttributes from attributes and returns a Map of all such attributes.
void	removeMyself() Remove myself from the distributed cache.
void	removeMyselfLocal() Remove myself from the local instance of the distributed cache.
void	removeNote(String name)
void	removeSessionListener(org.apache.catalina.SessionListener listener)
void	removeValue(String name) Deprecated.
void	resetIdWithRouteInfo(String id) This is called specifically for failover case using mod_jk where the new session has this node name in there.
protected void	sessionAttributesDirty()
void	setAttribute(String name, Object value)
protected abstract Object	setAttributeInternal(String name, Object value)
void	setAuthType(String authType)
void	setCreationTime(long time) Set the creation time for this session.
protected void	setDistributedCacheManager(DistributedCacheManager<O> distributedCacheManager)
protected void	setHasActivationListener(boolean hasListener)
void	setId(String id) Overrides the superclass method to also set the realId property.
void	setManager(org.apache.catalina.Manager manager)
void	setMaxInactiveInterval(int interval) Overrides the superclass to calculate maxUnreplicatedInterval.
void	setMaxUnreplicatedInterval(long interval) Sets the maximum period in ms after which a request accessing this session will trigger replication of its timestamp, even if the request doesn't otherwise modify the session.
void	setNew(boolean isNew)
void	setNote(String name, Object value)
void	setPrincipal(Principal principal) Set the authenticated Principal that is associated with this Session.
void	setValid(boolean isValid)
boolean	setVersionFromDistributedCache(int version) Update our version due to changes in the distributed cache.
void	tellNew(ClusteredSessionNotificationCause cause) Inform any HttpSessionListener of the creation of this session
String	toString()
void	update(IncomingDistributableSessionData sessionData)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.catalina.Session

getInfo

Field Detail

ACTIVITY_CHECK

protected static final boolean ACTIVITY_CHECK

info

protected static final String info

Descriptive information describing this Session implementation.

See Also:

Constant Field Values

excludedAttributes

protected static final String[] excludedAttributes

Set of attribute names which are not allowed to be replicated/persisted.

replicationExcludes

protected static final Set<String> replicationExcludes

Set containing all members of excludedAttributes.

containerEventTypes

protected static final Class<?>[] containerEventTypes

The method signature for the fireContainerEvent method.

log

protected static final org.jboss.logging.Logger log

sessionContext

protected static javax.servlet.http.HttpSessionContext sessionContext

The dummy HTTP session context used for servlet spec compliance.

sm

protected static final org.apache.catalina.util.StringManager sm

The string manager for this package.

Constructor Detail

ClusteredSession

protected ClusteredSession(ClusteredSessionManager<O> manager)

Creates a new ClusteredSession.

Parameters:

manager - the manager for this session

Method Detail

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface org.apache.catalina.Session

setAuthType

public void setAuthType(String authType)

Specified by:

setAuthType in interface org.apache.catalina.Session

getCreationTime

public long getCreationTime()

Specified by:

getCreationTime in interface javax.servlet.http.HttpSession

Specified by:

getCreationTime in interface org.apache.catalina.Session

setCreationTime

public void setCreationTime(long time)

Set the creation time for this session. This method is called by the Manager when an existing Session instance is reused.

Specified by:

setCreationTime in interface org.apache.catalina.Session

Parameters:

time - The new creation time

getId

public String getId()

Specified by:

getId in interface javax.servlet.http.HttpSession

Specified by:

getId in interface org.apache.catalina.Session

getIdInternal

public String getIdInternal()

Specified by:

getIdInternal in interface org.apache.catalina.Session

setId

public void setId(String id)

Overrides the superclass method to also set the realId property.

Specified by:

setId in interface org.apache.catalina.Session

getLastAccessedTime

public long getLastAccessedTime()

Specified by:

getLastAccessedTime in interface javax.servlet.http.HttpSession

Specified by:

getLastAccessedTime in interface org.apache.catalina.Session

getLastAccessedTimeInternal

public long getLastAccessedTimeInternal()

Specified by:

getLastAccessedTimeInternal in interface org.apache.catalina.Session

getManager

public org.apache.catalina.Manager getManager()

Specified by:

getManager in interface org.apache.catalina.Session

setManager

public void setManager(org.apache.catalina.Manager manager)

Specified by:

setManager in interface org.apache.catalina.Session

getMaxInactiveInterval

public int getMaxInactiveInterval()

Specified by:

getMaxInactiveInterval in interface javax.servlet.http.HttpSession

Specified by:

getMaxInactiveInterval in interface org.apache.catalina.Session

setMaxInactiveInterval

public void setMaxInactiveInterval(int interval)

Overrides the superclass to calculate maxUnreplicatedInterval.

Specified by:

setMaxInactiveInterval in interface javax.servlet.http.HttpSession

Specified by:

setMaxInactiveInterval in interface org.apache.catalina.Session

getPrincipal

public Principal getPrincipal()

Specified by:

getPrincipal in interface org.apache.catalina.Session

setPrincipal

public void setPrincipal(Principal principal)

Set the authenticated Principal that is associated with this Session. This provides an Authenticator with a means to cache a previously authenticated Principal, and avoid potentially expensive Realm.authenticate() calls on every request.

Specified by:

setPrincipal in interface org.apache.catalina.Session

Parameters:

principal - The new Principal, or null if none

access

public void access()

Specified by:

access in interface org.apache.catalina.Session

endAccess

public void endAccess()

Specified by:

endAccess in interface org.apache.catalina.Session

isNew

public boolean isNew()

Specified by:

isNew in interface javax.servlet.http.HttpSession

setNew

public void setNew(boolean isNew)

Specified by:

setNew in interface org.apache.catalina.Session

isValid

public boolean isValid()

Overrides the superclass method to call @ #isValid(boolean) isValid(true)} .

Specified by:

isValid in interface org.apache.catalina.Session

setValid

public void setValid(boolean isValid)

Specified by:

setValid in interface org.apache.catalina.Session

invalidate

public void invalidate()

Invalidates this session and unbinds any objects bound to it. Overridden here to remove across the cluster instead of just expiring.

Specified by:

invalidate in interface javax.servlet.http.HttpSession

Throws:

IllegalStateException - if this method is called on an invalidated session

expire

public void expire()

Specified by:

expire in interface org.apache.catalina.Session

recycle

public void recycle()

Specified by:

recycle in interface org.apache.catalina.Session

addSessionListener

public void addSessionListener(org.apache.catalina.SessionListener listener)

Specified by:

addSessionListener in interface org.apache.catalina.Session

removeSessionListener

public void removeSessionListener(org.apache.catalina.SessionListener listener)

Specified by:

removeSessionListener in interface org.apache.catalina.Session

getNote

public Object getNote(String name)

Specified by:

getNote in interface org.apache.catalina.Session

getNoteNames

public Iterator<String> getNoteNames()

Specified by:

getNoteNames in interface org.apache.catalina.Session

setNote

public void setNote(String name,
           Object value)

Specified by:

setNote in interface org.apache.catalina.Session

removeNote

public void removeNote(String name)

Specified by:

removeNote in interface org.apache.catalina.Session

getSession

public javax.servlet.http.HttpSession getSession()

Specified by:

getSession in interface org.apache.catalina.Session

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.http.HttpSession

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface javax.servlet.http.HttpSession

getAttributeNames

public Enumeration<String> getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.http.HttpSession

setAttribute

public void setAttribute(String name,
                Object value)

Specified by:

setAttribute in interface javax.servlet.http.HttpSession

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface javax.servlet.http.HttpSession

getSessionContext

@Deprecated
public javax.servlet.http.HttpSessionContext getSessionContext()

Deprecated.

Specified by:

getSessionContext in interface javax.servlet.http.HttpSession

getValue

@Deprecated
public Object getValue(String name)

Deprecated.

Specified by:

getValue in interface javax.servlet.http.HttpSession

getValueNames

@Deprecated
public String[] getValueNames()

Deprecated.

Specified by:

getValueNames in interface javax.servlet.http.HttpSession

putValue

@Deprecated
public void putValue(String name,
                       Object value)

Deprecated.

Specified by:

putValue in interface javax.servlet.http.HttpSession

removeValue

@Deprecated
public void removeValue(String name)

Deprecated.

Specified by:

removeValue in interface javax.servlet.http.HttpSession

getRealId

public String getRealId()

Gets the session id with any appended jvmRoute info removed.

See Also:

#getUseJK()

getMustReplicateTimestamp

public boolean getMustReplicateTimestamp()

update

public void update(IncomingDistributableSessionData sessionData)

processSessionReplication

public void processSessionReplication()

Increment our version and propagate ourself to the distributed cache.

removeMyself

public void removeMyself()

Remove myself from the distributed cache.

removeMyselfLocal

public void removeMyselfLocal()

Remove myself from the local instance of the distributed cache.

getCreationTimeInternal

public long getCreationTimeInternal()

Gets the sessions creation time, skipping any validity check.

Returns:

the creation time

getLastReplicated

public long getLastReplicated()

Gets the time processSessionReplication() was last called, or 0 if it has never been called.

getMaxUnreplicatedInterval

public long getMaxUnreplicatedInterval()

Gets the maximum period in ms after which a request accessing this session will trigger replication of its timestamp, even if the request doesn't otherwise modify the session. A value of -1 means no limit.

setMaxUnreplicatedInterval

public void setMaxUnreplicatedInterval(long interval)

Sets the maximum period in ms after which a request accessing this session will trigger replication of its timestamp, even if the request doesn't otherwise modify the session. A value of -1 means no limit.

resetIdWithRouteInfo

public void resetIdWithRouteInfo(String id)

This is called specifically for failover case using mod_jk where the new session has this node name in there. As a result, it is safe to just replace the id since the backend store is using the "real" id without the node name.

Parameters:

id -

setVersionFromDistributedCache

public boolean setVersionFromDistributedCache(int version)

Update our version due to changes in the distributed cache.

Parameters:

version - the distributed cache version

Returns:

true

isOutdated

public boolean isOutdated()

Check to see if the session data is still valid. Outdated here means that the in-memory data is not in sync with one in the data store.

Returns:

isSessionDirty

public boolean isSessionDirty()

tellNew

public void tellNew(ClusteredSessionNotificationCause cause)

Inform any HttpSessionListener of the creation of this session

isValid

public boolean isValid(boolean expireIfInvalid)

Returns whether the current session is still valid, but only calls expire for timed-out sessions if expireIfInvalid is true.

Parameters:

expireIfInvalid - true if sessions that have been timed out should be expired

expire

public void expire(boolean notify,
          boolean localCall,
          boolean localOnly,
          ClusteredSessionNotificationCause cause)

Expires the session, notifying listeners and possibly the manager.

NOTE: The manager will only be notified of the expiration if localCall is true ; otherwise it is the responsibility of the caller to notify the manager that the session is expired. (In the case of JBossCacheManager, it is the manager itself that makes such a call, so it of course is aware).

Parameters:

notify - whether servlet spec listeners should be notified

localCall - true if this call originated due to local activity (such as a session invalidation in user code or an expiration by the local background processing thread); false if the expiration originated due to some kind of event notification from the cluster.

localOnly - true if the expiration should not be announced to the cluster, false if other cluster nodes should be made aware of the expiration. Only meaningful if localCall is true.

cause - the cause of the expiration

notifyWillPassivate

public void notifyWillPassivate(ClusteredSessionNotificationCause cause)

Inform any HttpSessionActivationListener that the session will passivate.

Parameters:

cause - cause of the notification (e.g. ClusteredSessionNotificationCause.REPLICATION or ClusteredSessionNotificationCause.PASSIVATION

notifyDidActivate

public void notifyDidActivate(ClusteredSessionNotificationCause cause)

Inform any HttpSessionActivationListener that the session has been activated.

Parameters:

cause - cause of the notification (e.g. ClusteredSessionNotificationCause.REPLICATION or ClusteredSessionNotificationCause.PASSIVATION

getNeedsPostReplicateActivation

public boolean getNeedsPostReplicateActivation()

Gets whether the session needs to notify HttpSessionActivationListeners that it has been activated following replication.

toString

public String toString()

Overrides:

toString in class Object

setAttributeInternal

protected abstract Object setAttributeInternal(String name,
                          Object value)

removeAttributeInternal

protected abstract Object removeAttributeInternal(String name,
                             boolean localCall,
                             boolean localOnly)

getOutgoingSessionData

protected abstract O getOutgoingSessionData()

getAttributeInternal

protected Object getAttributeInternal(String name)

populateAttributes

protected void populateAttributes(Map<String,Object> distributedCacheAttributes)

Extension point for subclasses to load the attribute map from the distributed cache.

getAttributesInternal

protected final Map<String,Object> getAttributesInternal()

getManagerInternal

protected final ClusteredSessionManager<O> getManagerInternal()

getDistributedCacheManager

protected final DistributedCacheManager<O> getDistributedCacheManager()

setDistributedCacheManager

protected final void setDistributedCacheManager(DistributedCacheManager<O> distributedCacheManager)

canAttributeBeReplicated

protected boolean canAttributeBeReplicated(Object attribute)

Returns whether the attribute's type is one that can be replicated.

Parameters:

attribute - the attribute

Returns:

true if attribute is null, Serializable or an array of primitives.

removeExcludedAttributes

protected final Map<String,Object> removeExcludedAttributes(Map<String,Object> attributes)

Removes any attribute whose name is found in excludedAttributes from attributes and returns a Map of all such attributes.

Parameters:

attributes - source map from which excluded attributes are to be removed.

Returns:

Map that contains any attributes removed from attributes, or null if no attributes were removed.

isGetDirty

protected final boolean isGetDirty(Object attribute)

isMutable

protected boolean isMutable(Object attribute)

establishDistributedCacheManager

protected void establishDistributedCacheManager()

Gets a reference to the JBossCacheService.

sessionAttributesDirty

protected final void sessionAttributesDirty()

setHasActivationListener

protected final void setHasActivationListener(boolean hasListener)

getVersion

protected int getVersion()

getSessionTimestamp

protected long getSessionTimestamp()

isSessionMetadataDirty

protected boolean isSessionMetadataDirty()

getSessionMetadata

protected DistributableSessionMetadata getSessionMetadata()

isSessionAttributeMapDirty

protected boolean isSessionAttributeMapDirty()

isFullReplicationNeeded

protected boolean isFullReplicationNeeded()

isValidInternal

public boolean isValidInternal()

Return the isValid flag for this session without any expiration check.

Specified by:

isValidInternal in interface org.apache.catalina.Session