org.jboss.as.clustering.web.infinispan

Class DistributedCacheManager<T extends OutgoingDistributableSessionData>

java.lang.Object

org.jboss.as.clustering.web.infinispan.DistributedCacheManager<T>

All Implemented Interfaces:

DistributedCacheManager<T>, SessionOwnershipSupport

public class DistributedCacheManager<T extends OutgoingDistributableSessionData>
extends Object
implements DistributedCacheManager<T>, SessionOwnershipSupport

Distributed cache manager implementation using Infinispan.

Author:

Paul Ferraro

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.as.clustering.web.SessionOwnershipSupport

SessionOwnershipSupport.LockResult

Constructor Summary

Constructors

Constructor and Description
DistributedCacheManager(LocalDistributableSessionManager manager, org.infinispan.Cache<String,Map<Object,Object>> cache, Registry<String,Void> registry, SharedLocalYieldingClusterLockManager lockManager, SessionAttributeStorage<T> attributeStorage, BatchingManager batchingManager, CacheInvoker invoker)

Method Summary

Methods

Modifier and Type	Method and Description
SessionOwnershipSupport.LockResult	acquireSessionOwnership(String sessionId, boolean newLock) Attempt to take ownership of the session identified by the given id.
void	activated(org.infinispan.notifications.cachelistener.event.CacheEntryActivatedEvent<String,Map<Object,Object>> event)
void	evictSession(String sessionId) Evict a session from the in-memory portion of the distributed cache, on this node only.
void	evictSession(String sessionId, String dataOwner) Evict a non-locally-active session from the in-memory portion of the distributed cache, on this node only.
BatchingManager	getBatchingManager() Gets the BatchingManager.
IncomingDistributableSessionData	getSessionData(String sessionId, boolean initialLoad) Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given session.
IncomingDistributableSessionData	getSessionData(String sessionId, String dataOwner, boolean includeAttributes) Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given session.
Map<String,String>	getSessionIds() Gets the ids of all sessions in the underlying cache.
SessionOwnershipSupport	getSessionOwnershipSupport() Returns the session ownership support for this distributed cache manager.
boolean	isLocal(String sessionId) Indicates whether a session with the specified identifier will cache locally.
boolean	isPassivationEnabled() Gets whether the underlying cache supports passivation.
String	locate(String sessionId) Returns the jvm route of a node on which the specified session id is cached.
void	modified(org.infinispan.notifications.cachelistener.event.CacheEntryModifiedEvent<String,Map<Object,Object>> event)
void	relinquishSessionOwnership(String sessionId, boolean remove) Releases ownership of a session, thus making it possible for other nodes to acquire it.
void	removed(org.infinispan.notifications.cachelistener.event.CacheEntryRemovedEvent<String,Map<Object,Object>> event)
void	removeSession(String sessionId) Globally remove a session from the distributed cache.
void	removeSessionLocal(String sessionId) Remove a session from the distributed cache on this node only.
void	removeSessionLocal(String sessionId, String dataOwner) Remove a non-locally active session from the distributed cache, but on this node only.
void	sessionCreated(String sessionId) Notification to the distributed cache that a session has been newly created.
void	setForceSynchronous(boolean forceSynchronous) Toggles whether or not to force cache into synchronous mode.
void	start() Starts the distributed caching layer.
void	stop() Stops the distributed caching layer.
void	storeSessionData(T sessionData) Store or update a session in the distributed cache.

Methods inherited from class java.lang.Object

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

Constructor Detail

DistributedCacheManager

public DistributedCacheManager(LocalDistributableSessionManager manager,
                       org.infinispan.Cache<String,Map<Object,Object>> cache,
                       Registry<String,Void> registry,
                       SharedLocalYieldingClusterLockManager lockManager,
                       SessionAttributeStorage<T> attributeStorage,
                       BatchingManager batchingManager,
                       CacheInvoker invoker)

Method Detail

start

public void start()

Starts the distributed caching layer.

Specified by:

start in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

See Also:

DistributedCacheManager.start()

stop

public void stop()

Stops the distributed caching layer.

Specified by:

stop in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

See Also:

DistributedCacheManager.stop()

getBatchingManager

public BatchingManager getBatchingManager()

Gets the BatchingManager.

Specified by:

getBatchingManager in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

See Also:

DistributedCacheManager.getBatchingManager()

sessionCreated

public void sessionCreated(String sessionId)

Notification to the distributed cache that a session has been newly created.

Specified by:

sessionCreated in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session id with any appended jvmRoute info removed

See Also:

DistributedCacheManager.sessionCreated(String)

storeSessionData

public void storeSessionData(T sessionData)

Store or update a session in the distributed cache.

Specified by:

storeSessionData in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionData - the session

See Also:

DistributedCacheManager.storeSessionData(org.jboss.as.clustering.web.OutgoingDistributableSessionData)

getSessionData

public IncomingDistributableSessionData getSessionData(String sessionId,
                                              boolean initialLoad)

Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given session.

Specified by:

getSessionData in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

initialLoad - true if this is the first access of this session's data on this node

Returns:

the session data

See Also:

DistributedCacheManager.getSessionData(String, boolean)

getSessionData

public IncomingDistributableSessionData getSessionData(String sessionId,
                                              String dataOwner,
                                              boolean includeAttributes)

Get the IncomingDistributableSessionData that encapsulates the distributed cache's information about the given session.

Specified by:

getSessionData in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

dataOwner - identifier of node where the session is active; null if locally active or location where active is unknown

includeAttributes - should IncomingDistributableSessionData.providesSessionAttributes() return true?

Returns:

the session data

See Also:

DistributedCacheManager.getSessionData(String, boolean)

removeSession

public void removeSession(String sessionId)

Globally remove a session from the distributed cache.

Specified by:

removeSession in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

See Also:

DistributedCacheManager.removeSession(String)

removeSessionLocal

public void removeSessionLocal(String sessionId)

Remove a session from the distributed cache on this node only.

Specified by:

removeSessionLocal in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

See Also:

DistributedCacheManager.removeSessionLocal(String)

removeSessionLocal

public void removeSessionLocal(String sessionId,
                      String dataOwner)

Remove a non-locally active session from the distributed cache, but on this node only.

Specified by:

removeSessionLocal in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

dataOwner - identifier of node where the session is active

See Also:

DistributedCacheManager.removeSession(String)

evictSession

public void evictSession(String sessionId)

Evict a session from the in-memory portion of the distributed cache, on this node only.

Specified by:

evictSession in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

See Also:

DistributedCacheManager.evictSession(String)

evictSession

public void evictSession(String sessionId,
                String dataOwner)

Evict a non-locally-active session from the in-memory portion of the distributed cache, on this node only.

Specified by:

evictSession in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - the session's id, excluding any jvmRoute

dataOwner - identifier of node where the session is active

See Also:

DistributedCacheManager.evictSession(String, String)

getSessionIds

public Map<String,String> getSessionIds()

Gets the ids of all sessions in the underlying cache.

Specified by:

getSessionIds in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Returns:

Map containing all of the session ids of sessions in the cache (with any jvmRoute removed) as keys, and the identifier of the data owner for the session as value (or a null value if buddy replication is not enabled.) Will not return null.

See Also:

DistributedCacheManager.getSessionIds()

isPassivationEnabled

public boolean isPassivationEnabled()

Gets whether the underlying cache supports passivation.

Specified by:

isPassivationEnabled in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

See Also:

DistributedCacheManager.isPassivationEnabled()

setForceSynchronous

public void setForceSynchronous(boolean forceSynchronous)

Toggles whether or not to force cache into synchronous mode.

Specified by:

setForceSynchronous in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

forceSynchronous - true, if cache should force synchronous mode, false otherwise

See Also:

DistributedCacheManager.setForceSynchronous(boolean)

getSessionOwnershipSupport

public SessionOwnershipSupport getSessionOwnershipSupport()

Returns the session ownership support for this distributed cache manager.

Specified by:

getSessionOwnershipSupport in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Returns:

the session ownership support, or null if session ownership is not supported.

See Also:

DistributedCacheManager.getSessionOwnershipSupport()

acquireSessionOwnership

public SessionOwnershipSupport.LockResult acquireSessionOwnership(String sessionId,
                                                         boolean newLock)
                                                           throws TimeoutException,
                                                                  InterruptedException

Description copied from interface: SessionOwnershipSupport

Attempt to take ownership of the session identified by the given id.

Specified by:

acquireSessionOwnership in interface SessionOwnershipSupport

Parameters:

sessionId - the session's id, excluding any jvmRoute

newLock - true if the caller knows this is a new session that doesn't exist elsewhere in the cluster, and thus acquiring ownership does not require any cluster-wide call

Returns:

the result of the attempt

Throws:

TimeoutException

InterruptedException

relinquishSessionOwnership

public void relinquishSessionOwnership(String sessionId,
                              boolean remove)

Description copied from interface: SessionOwnershipSupport

Releases ownership of a session, thus making it possible for other nodes to acquire it.

Specified by:

relinquishSessionOwnership in interface SessionOwnershipSupport

Parameters:

sessionId - the session's id, excluding any jvmRoute

remove - true if this release is associated with a session removal, in which case the distributed cache manager can stop tracking ownership

isLocal

public boolean isLocal(String sessionId)

Indicates whether a session with the specified identifier will cache locally.

Specified by:

isLocal in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - a session identifier

Returns:

true, if a session with the specified identifier will cache locally, false otherwise.

See Also:

DistributedCacheManager.isLocal(String)

locate

public String locate(String sessionId)

Returns the jvm route of a node on which the specified session id is cached.

Specified by:

locate in interface DistributedCacheManager<T extends OutgoingDistributableSessionData>

Parameters:

sessionId - a session identifier

Returns:

the jvm route of a node

See Also:

DistributedCacheManager.locate(String)

removed

public void removed(org.infinispan.notifications.cachelistener.event.CacheEntryRemovedEvent<String,Map<Object,Object>> event)

modified

public void modified(org.infinispan.notifications.cachelistener.event.CacheEntryModifiedEvent<String,Map<Object,Object>> event)

activated

public void activated(org.infinispan.notifications.cachelistener.event.CacheEntryActivatedEvent<String,Map<Object,Object>> event)