org.nuxeo.ecm.core.api

Class LockHelper

java.lang.Object

org.nuxeo.ecm.core.api.LockHelper

public class LockHelper
extends Object

Utilities to work with locks

Since:

9.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_LOCK
static String	LOCK
static int	NB_TRY
static int	SLEEP_DURATION

Method Summary

Modifier and Type	Method and Description
static void	doAtomically(String key, Runnable runnable) Runs a Runnable atomically, in a cluster-wide critical section.
static <R> R	doAtomically(String key, Supplier<R> supplier) Runs a Supplier atomically, in a cluster-wide critical section.
protected static boolean	tryLock(String key, KeyValueStore kvStore)
protected static void	unlock(String key, KeyValueStore kvStore)

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_LOCK

public static final String DOCUMENT_LOCK

See Also:

Constant Field Values

LOCK

public static final String LOCK

See Also:

Constant Field Values

NB_TRY

public static final int NB_TRY

See Also:

Constant Field Values

SLEEP_DURATION

public static final int SLEEP_DURATION

See Also:

Constant Field Values

Method Detail

doAtomically

public static void doAtomically(String key,
                                Runnable runnable)
                         throws ConcurrentUpdateException

Runs a Runnable atomically, in a cluster-wide critical section.

Parameters:

key - the key used to determine atomicity

runnable - the runnable

Throws:

ConcurrentUpdateException

doAtomically

public static <R> R doAtomically(String key,
                                 Supplier<R> supplier)
                          throws ConcurrentUpdateException

Runs a Supplier atomically, in a cluster-wide critical section.

Parameters:

key - the key used to determine atomicity

supplier - the supplier

Returns:

the result of the function

Throws:

ConcurrentUpdateException

tryLock

protected static boolean tryLock(String key,
                                 KeyValueStore kvStore)
                          throws InterruptedException

Throws:

InterruptedException

unlock

protected static void unlock(String key,
                             KeyValueStore kvStore)