org.jboss.as.clustering.web

Interface LocalDistributableSessionManager

All Known Implementing Classes:

DistributableSessionManager

public interface LocalDistributableSessionManager

Callback interface to allow the distributed caching layer to invoke upon the local session manager.

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
org.jboss.marshalling.ClassResolver	getApplicationClassResolver() Get the classloader able to load application classes.
String	getContextName()
String	getEngineName() Returns the name of the session manager's engine.
String	getHostName()
String	getJvmRoute() Returns the jvm route of this node.
String	getName() Returns the unique name of this session manager.
org.jboss.metadata.web.jboss.ReplicationConfig	getReplicationConfig() Gets the web application metadata.
boolean	isPassivationEnabled() Gets whether the webapp is configured for passivation.
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
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.

Method Detail

isPassivationEnabled

boolean isPassivationEnabled()

Gets whether the webapp is configured for passivation.

Returns:

true if passivation is enabled

getName

String getName()

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

Returns:

a unique name

getHostName

String getHostName()

getContextName

String getContextName()

getEngineName

String getEngineName()

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

Returns:

an engine name.

getApplicationClassResolver

org.jboss.marshalling.ClassResolver getApplicationClassResolver()

Get the classloader able to load application classes.

Returns:

the classloader. Will not return null

getReplicationConfig

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

Gets the web application metadata.

Returns:

the metadata. will not return null

notifyRemoteInvalidation

void notifyRemoteInvalidation(String realId)

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

Parameters:

realId - the session id excluding any jvmRoute

notifyLocalAttributeModification

void notifyLocalAttributeModification(String realId)

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.

Parameters:

realId - the session id excluding any jvmRoute

sessionActivated

void sessionActivated()

Notification that a previously passivated session has been activated.

sessionChangedInDistributedCache

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.

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

getJvmRoute

String getJvmRoute()

Returns the jvm route of this node.

Returns:

a jvm route