org.adroitlogic.x.api.clustering.locks

Interface XClusterLock

All Known Implementing Classes:

ClusterLock

public interface XClusterLock

The interface for distributed locks. This lock is not reentrant. Therefore, whenever a thread has acquired a lock, no other thread can acquire the same lock until the acquired thread release the lock.

Since:

17.01

Author:

Imesha Sudasingha

Method Summary

Modifier and Type	Method and Description
void	acquire() Acquires the cluster lock.
boolean	acquire(long time, TimeUnit timeUnit) Acquire the lock - blocks until it's available or the given time expires.
String	getLockPath() Get the path used for acquiring the distributed lock.
boolean	isAcquiredInThisProcess() Returns true if the mutex is acquired by a thread in this JVM
void	release() Perform one release of the mutex if the calling thread is the same thread that acquired it.
boolean	tryAcquire() Tries to acquire the lock when called.

Method Detail

acquire

void acquire()
      throws Exception

Acquires the cluster lock. This is a blocking call, where the call will wait till the lock is acquired.

Throws:

Exception - in connection interruptions and underlying distributed coordination provider's errors

tryAcquire

boolean tryAcquire()
            throws Exception

Tries to acquire the lock when called. If unable to acquire the lock, returns immediately without blocking

Returns:

true, if the lock was acquired.

Throws:

Exception - in zookeeper errors and connection errors

acquire

boolean acquire(long time,
                TimeUnit timeUnit)
         throws Exception

Acquire the lock - blocks until it's available or the given time expires.

Parameters:

time - time to wait

timeUnit - time unit

Returns:

true if succeeded

Throws:

Exception - connection interruptions

release

void release()
      throws Exception

Perform one release of the mutex if the calling thread is the same thread that acquired it. If the thread had made multiple calls to acquire, the mutex will still be held when this method returns.

Throws:

Exception - interruptions, current thread does not own the lock

UnreliableLockException - if the connection was lost/session expired while the lock was acquired and before being released

isAcquiredInThisProcess

boolean isAcquiredInThisProcess()

Returns true if the mutex is acquired by a thread in this JVM

Returns:

true/false

getLockPath

String getLockPath()

Get the path used for acquiring the distributed lock.

Returns:

the path used to create the distributed lock