Interface LockRegistry

All Known Subinterfaces:

ExpirableLockRegistry, RenewableLockRegistry

All Known Implementing Classes:

DefaultLockRegistry, HazelcastLockRegistry, JdbcLockRegistry, PassThruLockRegistry, RedisLockRegistry, ZookeeperLockRegistry

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface LockRegistry

Strategy for maintaining a registry of shared locks.

Since:

2.1.1

Author:

Oleg Zhurakousky, Gary Russell, Artem Bilan

Method Summary

Modifier and Type	Method	Description
default <T, E extends Throwable> T	executeLocked(Object lockKey, Duration waitLockDuration, CheckedCallable<T,E> callable)	Perform the provided task when the lock for the key is locked.
default <E extends Throwable> void	executeLocked(Object lockKey, Duration waitLockDuration, CheckedRunnable<E> runnable)	Perform the provided task when the lock for the key is locked.
default <T, E extends Throwable> T	executeLocked(Object lockKey, CheckedCallable<T,E> callable)	Perform the provided task when the lock for the key is locked.
default <E extends Throwable> void	executeLocked(Object lockKey, CheckedRunnable<E> runnable)	Perform the provided task when the lock for the key is locked.
Lock	obtain(Object lockKey)	Obtain the lock associated with the parameter object.

Method Details

obtain

Lock obtain(Object lockKey)

Obtain the lock associated with the parameter object.

Parameters:

lockKey - The object with which the lock is associated.

Returns:

The associated lock.

executeLocked

default <E extends Throwable> void executeLocked(Object lockKey,
 CheckedRunnable<E> runnable)
                                          throws E,
InterruptedException

Perform the provided task when the lock for the key is locked.

Type Parameters:

E - type of exception runnable throws

Parameters:

lockKey - the lock key to use

runnable - the CheckedRunnable to execute within a lock

Throws:

InterruptedException - from a lock operation

E

Since:

6.2

executeLocked

default <T, E extends Throwable> T executeLocked(Object lockKey,
 CheckedCallable<T,E> callable)
                                          throws E,
InterruptedException

Perform the provided task when the lock for the key is locked.

Type Parameters:

T - type of callable result

E - type of exception callable throws

Parameters:

lockKey - the lock key to use

callable - the CheckedCallable to execute within a lock

Returns:

the result of callable

Throws:

InterruptedException - from a lock operation

E

Since:

6.2

executeLocked

default <E extends Throwable> void executeLocked(Object lockKey,
 Duration waitLockDuration,
 CheckedRunnable<E> runnable)
                                          throws E,
InterruptedException,
TimeoutException

Perform the provided task when the lock for the key is locked.

Type Parameters:

E - type of exception runnable throws

Parameters:

lockKey - the lock key to use

waitLockDuration - the Duration for Lock.tryLock(long, TimeUnit)

runnable - the CheckedRunnable to execute within a lock

Throws:

InterruptedException - from a lock operation

TimeoutException - when Lock.tryLock(long, TimeUnit) has elapsed

E

Since:

6.2

executeLocked

default <T, E extends Throwable> T executeLocked(Object lockKey,
 Duration waitLockDuration,
 CheckedCallable<T,E> callable)
                                          throws E,
InterruptedException,
TimeoutException

Perform the provided task when the lock for the key is locked.

Type Parameters:

E - type of exception callable throws

Parameters:

lockKey - the lock key to use

waitLockDuration - the Duration for Lock.tryLock(long, TimeUnit)

callable - the CheckedCallable to execute within a lock

Throws:

InterruptedException - from a lock operation

TimeoutException - when Lock.tryLock(long, TimeUnit) has elapsed

E

Since:

6.2