dlock

Class DLockUtil

java.lang.Object

dlock.DLockUtil

public class DLockUtil
extends Object

Utilities for managing distributed locks.

Field Summary

Fields

Modifier and Type	Field and Description
static String	LOCK_SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
DLockUtil()

Method Summary

Modifier and Type	Method and Description
static void	getEntryLock(com.gemstone.gemfire.cache.Region aRegion, Object key) Given a region and a key, get a lock on the key's entry in the region.
static void	getLock(Object name) Executes #getLock(Region,Object,long) with timeoutMs set to Long.MAX_VALUE.
static void	getLock(Object name, long timeoutMs) Gets a lock on the object with the specified name.
static com.gemstone.gemfire.distributed.DistributedLockService	getLockService() Returns a DistributedLockService with name LOCK_SERVICE_NAME.
static boolean	hasLock(Object name) Answers whether this thread has the lock for the object with the specified name.
static void	unlock(Object name) Unlocks the object with the specified name.
static void	unlockEntryLock(com.gemstone.gemfire.cache.Region aRegion, Object key) Given a region and a key, unlock the entry lock for that key.

Methods inherited from class java.lang.Object

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

Field Detail

LOCK_SERVICE_NAME

public static final String LOCK_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

DLockUtil

public DLockUtil()

Method Detail

getLockService

public static com.gemstone.gemfire.distributed.DistributedLockService getLockService()

Returns a DistributedLockService with name LOCK_SERVICE_NAME. Creates one if it doesn't already exist.

getLock

public static void getLock(Object name)

Executes #getLock(Region,Object,long) with timeoutMs set to Long.MAX_VALUE.

getEntryLock

public static void getEntryLock(com.gemstone.gemfire.cache.Region aRegion,
                                Object key)

Given a region and a key, get a lock on the key's entry in the region.

unlockEntryLock

public static void unlockEntryLock(com.gemstone.gemfire.cache.Region aRegion,
                                   Object key)

Given a region and a key, unlock the entry lock for that key.

getLock

public static void getLock(Object name,
                           long timeoutMs)

Gets a lock on the object with the specified name. Waits timeoutMs milliseconds for the lock to be established before timing out.

Throws:

HydraRuntimeException - if this thread already locked the object or if the attempt is interrupted or times out or if there is a cache exception.

unlock

public static void unlock(Object name)

Unlocks the object with the specified name.

Throws:

HydraRuntimeException - if this thread does have the lock on the object or if there is a cache exception.

hasLock

public static boolean hasLock(Object name)

Answers whether this thread has the lock for the object with the specified name.

Throws:

HydraRuntimeException - if there is a cache exception.