kim.sesame.framework.locks.zookeeper

类 ZookeeperLockRegistry

java.lang.Object

kim.sesame.framework.locks.zookeeper.ZookeeperLockRegistry

所有已实现的接口:

ExpirableLockRegistry, LockRegistry, org.springframework.beans.factory.DisposableBean

public class ZookeeperLockRegistry
extends Object
implements ExpirableLockRegistry, org.springframework.beans.factory.DisposableBean

ExpirableLockRegistry implementation using Zookeeper, or more specifically, Curator InterProcessMutex.

从以下版本开始:

4.2

作者:

Gary Russell, Artem Bilan, Vedran Pavic

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	ZookeeperLockRegistry.KeyToPathStrategy Strategy to convert a lock key (e.g. aggregation correlation id) to a Zookeeper path.

字段概要

从接口继承的字段 kim.sesame.framework.locks.ExpirableLockRegistry

DEFAULT_EXPIRE_UNUSED_OLDER_THEN_TIME

构造器概要

构造器

构造器和说明
ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client) Construct a lock registry using the default ZookeeperLockRegistry.KeyToPathStrategy which simple appends the key to '/SpringIntegration-LockRegistry/'.
ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client, String root) Construct a lock registry using the default ZookeeperLockRegistry.KeyToPathStrategy which simple appends the key to '<root>/'.
ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client, ZookeeperLockRegistry.KeyToPathStrategy keyToPath) Construct a lock registry using the supplied ZookeeperLockRegistry.KeyToPathStrategy.

方法概要

限定符和类型	方法和说明
void	destroy()
void	expireUnusedOlderThan(long age) Remove locks last acquired more than 'age' ago that are not currently locked.
Lock	obtain(Object lockKey) Obtains the lock associated with the parameter object.
void	setMutexTaskExecutor(org.springframework.core.task.AsyncTaskExecutor mutexTaskExecutor) Set an AsyncTaskExecutor to use when establishing (and testing) the connection with Zookeeper.

从类继承的方法 java.lang.Object

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

从接口继承的方法 kim.sesame.framework.locks.ExpirableLockRegistry

getDefaultExpireUnusedOlderThanTime

构造器详细资料

ZookeeperLockRegistry

public ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client)

Construct a lock registry using the default ZookeeperLockRegistry.KeyToPathStrategy which simple appends the key to '/SpringIntegration-LockRegistry/'.

参数:

client - the CuratorFramework.

ZookeeperLockRegistry

public ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client,
                             String root)

Construct a lock registry using the default ZookeeperLockRegistry.KeyToPathStrategy which simple appends the key to '<root>/'.

参数:

client - the CuratorFramework.

root - the path root (no trailing /).

ZookeeperLockRegistry

public ZookeeperLockRegistry(org.apache.curator.framework.CuratorFramework client,
                             ZookeeperLockRegistry.KeyToPathStrategy keyToPath)

Construct a lock registry using the supplied ZookeeperLockRegistry.KeyToPathStrategy.

参数:

client - the CuratorFramework.

keyToPath - the implementation of ZookeeperLockRegistry.KeyToPathStrategy.

方法详细资料

setMutexTaskExecutor

public void setMutexTaskExecutor(org.springframework.core.task.AsyncTaskExecutor mutexTaskExecutor)

Set an AsyncTaskExecutor to use when establishing (and testing) the connection with Zookeeper. This must be performed asynchronously so the Lock.tryLock(long, TimeUnit) contract can be honored. While an executor is used internally, an external executor may be required in some environments, for example those that require the use of a WorkManagerTaskExecutor.

参数:

mutexTaskExecutor - the executor.

从以下版本开始:

4.2.10

obtain

public Lock obtain(Object lockKey)

从接口复制的说明: LockRegistry

Obtains the lock associated with the parameter object.

指定者:

obtain 在接口中 LockRegistry

参数:

lockKey - The object with which the lock is associated.

返回:

The associated lock.

expireUnusedOlderThan

public void expireUnusedOlderThan(long age)

Remove locks last acquired more than 'age' ago that are not currently locked. Expiry is not supported if the ZookeeperLockRegistry.KeyToPathStrategy is bounded (returns a finite number of paths). With such a ZookeeperLockRegistry.KeyToPathStrategy, the overhead of tracking when a lock is obtained is avoided.

指定者:

expireUnusedOlderThan 在接口中 ExpirableLockRegistry

参数:

age - the time since the lock was last obtained.

destroy

public void destroy()
             throws Exception

指定者:

destroy 在接口中 org.springframework.beans.factory.DisposableBean

抛出:

Exception