org.jboss.as.clustering.web

Interface SessionOwnershipSupport

All Known Implementing Classes:

DistributedCacheManager

public interface SessionOwnershipSupport

Author:

Paul Ferraro

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionOwnershipSupport.LockResult Result of a lock call

Method Summary

Methods

Modifier and Type	Method and Description
SessionOwnershipSupport.LockResult	acquireSessionOwnership(String realId, boolean newLock) Attempt to take ownership of the session identified by the given id.
void	relinquishSessionOwnership(String realId, boolean remove) Releases ownership of a session, thus making it possible for other nodes to acquire it.

Method Detail

acquireSessionOwnership

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

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

Parameters:

realId - 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

void relinquishSessionOwnership(String realId,
                              boolean remove)

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

Parameters:

realId - 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