ClusterServiceImpl.ClusterLockHelper (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.runtime.cluster.ClusterServiceImpl.ClusterLockHelper

Enclosing class:: ClusterServiceImpl

public static class ClusterServiceImpl.ClusterLockHelper
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`protected Duration`	`duration`
`static String`	`KV_STORE_NAME`
`protected KeyValueStore`	`kvStore`
`protected String`	`nodeId`
`protected Duration`	`pollDelay`

Constructor Summary

Constructors
Constructor Description

ClusterLockHelper(String nodeId, Duration duration, Duration pollDelay)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected String`	`getLock(String key)`
`void`	`runAtomically(String key, Runnable runnable)`	Runs a `Runnable` atomically in a cluster-wide critical section, outside a transaction.
`protected void`	`runAtomicallyInternal(String key, Runnable runnable)`	Runs a `Runnable` atomically, in a cluster-wide critical section.
`protected void`	`runInSeparateTransaction(Runnable runnable)`	Runs a `Runnable` outside the current transaction (committing and finally restarting it if needed).
`protected String`	`tryLock(String key)`
`protected void`	`unLock(String key, String lockInfo)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KV_STORE_NAME

public static final String KV_STORE_NAME

See Also:: Constant Field Values

nodeId
```
protected final String nodeId
```

duration
```
protected final Duration duration
```

pollDelay
```
protected final Duration pollDelay
```

kvStore
```
protected final KeyValueStore kvStore
```

Constructor Detail

ClusterLockHelper

public ClusterLockHelper(String nodeId,
                         Duration duration,
                         Duration pollDelay)

Method Detail
- runAtomically
```
public void runAtomically(String key,
                          Runnable runnable)
```
  Runs a Runnable atomically in a cluster-wide critical section, outside a transaction.
- runInSeparateTransaction
```
protected void runInSeparateTransaction(Runnable runnable)
```
  Runs a Runnable outside the current transaction (committing and finally restarting it if needed).
  
  Implementation Requirements:
  
  this is different from TransactionHelper.runWithoutTransaction(Runnable) because that one, in some implementations, may keep the current transaction and start the runnable in a new thread. Here we don't want a new thread or a risk of deadlock, so we just commit the original transaction.
- runAtomicallyInternal
```
protected void runAtomicallyInternal(String key,
                                     Runnable runnable)
```
  Runs a Runnable atomically, in a cluster-wide critical section.
- tryLock
```
protected String tryLock(String key)
```
- unLock
```
protected void unLock(String key,
                      String lockInfo)
```
- getLock
```
protected String getLock(String key)
```