com.atlassian.beehive.simple

Class SimpleClusterLockService

java.lang.Object

com.atlassian.beehive.simple.SimpleClusterLockService

All Implemented Interfaces:

ClusterLockService, ManagedClusterLockService

public class SimpleClusterLockService
extends Object
implements ManagedClusterLockService

Simple implementation of ClusterLockService that works for a single node application.

Certain cross product libraries (eg SAL and AO) will depend on having an implementation of ClusterLockService, and this one can used by applications that only run as a single node.

Constructor Summary

Constructors

Constructor and Description
SimpleClusterLockService()

Method Summary

Modifier and Type	Method and Description
Collection<com.atlassian.beehive.simple.SingleNodeLock>	getAllKnownClusterLocks() Returns all the cluster locks that are currently known to this cluster lock service.
ClusterLock	getLockForName(String lockName) Returns the cluster-wide lock for the given name.
Collection<ClusterLockStatus>	getStatusesOfAllHeldClusterLocks() Returns lock status of every cluster lock being held.

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleClusterLockService

public SimpleClusterLockService()

Method Detail

getAllKnownClusterLocks

public Collection<com.atlassian.beehive.simple.SingleNodeLock> getAllKnownClusterLocks()

Description copied from interface: ManagedClusterLockService

Returns all the cluster locks that are currently known to this cluster lock service.

The specifics are mostly left up to the implementation, with the following caveats:

• It MUST include all locks that are currently locked by this node.
• It SHOULD include all locks that are still strongly referenced outside of the cluster lock service, if possible. Implementations that are unable to comply with this requirement MUST clearly document that limitation.
• It MAY include locks that were previously accessed but are no longer in use, even those that are no longer strongly referenced outside of the cluster lock service.
• It MAY include locks that have not been accessed by this node but are still known to the service through the activity of other nodes within the cluster.

Consumers MUST NOT rely on this method for the correctness of their locking behaviour. This information is intended for instrumentation and other similar management concerns, only.

Specified by:

getAllKnownClusterLocks in interface ManagedClusterLockService

Returns:

all cluster locks that are currently known to this service, in no particular order

getStatusesOfAllHeldClusterLocks

@Nonnull
public Collection<ClusterLockStatus> getStatusesOfAllHeldClusterLocks()

Description copied from interface: ManagedClusterLockService

Returns lock status of every cluster lock being held.

This is intended to provide additional information about misbehaving locks and thus this method should return the most up-to-date and non-cached data.

Consumers must be aware that not all implementations can return a valid update time of the locks.

Specified by:

getStatusesOfAllHeldClusterLocks in interface ManagedClusterLockService

Returns:

a collection of cluster lock statuses, in no particular order

getLockForName

public ClusterLock getLockForName(@Nonnull
                                  String lockName)

Description copied from interface: ClusterLockService

Returns the cluster-wide lock for the given name.

Specified by:

getLockForName in interface ClusterLockService

Parameters:

lockName - the globally unique lock identifier

Returns:

the cluster-wide lock for the given name.