org.jboss.as.clustering.lock

Interface LocalLockHandler

public interface LocalLockHandler

Provides local lock coordination for an AbstractClusterLockSupport.

Version:

$Revision: 86130 $

Author:

Brian Stansberry

Method Summary

Methods

Modifier and Type	Method and Description
ClusterNode	getLocalNode(ClusterNode localNode)
ClusterNode	getLockHolder(Serializable lockName) Gets the node the holds the given lock on this node, or null if no node holds the lock on this node.
void	lockFromCluster(Serializable lockName, ClusterNode caller, long timeout) Try to acquire the local lock within the given timeout.
void	setLocalNode(ClusterNode localNode)
void	unlockFromCluster(Serializable lockName, ClusterNode caller) Release the lock.

Method Detail

getLockHolder

ClusterNode getLockHolder(Serializable lockName)

Gets the node the holds the given lock on this node, or null if no node holds the lock on this node.

Parameters:

lockName -

Returns:

lockFromCluster

void lockFromCluster(Serializable lockName,
                   ClusterNode caller,
                   long timeout)
                     throws TimeoutException,
                            InterruptedException

Try to acquire the local lock within the given timeout. If this method returns successfully, the caller has acquired the lock.

Parameters:

lockName - the name of the lock.

caller - the node making the request

timeout - number of ms the caller will accept waiting before the lock acquisition should be considered a failure. A value less than one means wait as long as necessary.

Throws:

TimeoutException - if the lock could not be acquired within the specified timeout

InterruptedException

unlockFromCluster

void unlockFromCluster(Serializable lockName,
                     ClusterNode caller)

Release the lock.

Parameters:

lockName - the name of the lock.

caller - the node making the request

getLocalNode

ClusterNode getLocalNode(ClusterNode localNode)

setLocalNode

void setLocalNode(ClusterNode localNode)