org.lable.oss.uniqueid.zookeeper

Class SynchronizedGeneratorIdentity

java.lang.Object

org.lable.oss.uniqueid.zookeeper.SynchronizedGeneratorIdentity

All Implemented Interfaces:

Closeable, AutoCloseable, GeneratorIdentityHolder

public class SynchronizedGeneratorIdentity
extends Object
implements GeneratorIdentityHolder

Implementation of GeneratorIdentityHolder that holds and reacquires when necessary a claim to a generator-ID. When getGeneratorId() is called the generator-ID currently held by this object will be returned. There is no guarantee that the same ID is returned on subsequent calls. Generator IDs should not be cached or reused.

See Also:

basedOn(String, String, Long), basedOn(String, String, Supplier, Supplier)

Constructor Summary

Constructors

Constructor and Description
SynchronizedGeneratorIdentity(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection, String zNode, int clusterId, Supplier<Duration> claimDurationSupplier, Supplier<Duration> acquisitionTimeoutSupplier)

Method Summary

Modifier and Type	Method and Description
static SynchronizedGeneratorIdentity	basedOn(String quorum, String znode, Long claimDuration) Create a new SynchronizedGeneratorIdentity instance.
static SynchronizedGeneratorIdentity	basedOn(String quorum, String znode, Supplier<Duration> claimDurationSupplier, Supplier<Duration> acquisitionTimeoutSupplier) Create a new SynchronizedGeneratorIdentity instance.
void	close()
int	getClusterId()
int	getGeneratorId()
String	getZNode()
void	relinquishGeneratorIdClaim()

Methods inherited from class java.lang.Object

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

Constructor Detail

SynchronizedGeneratorIdentity

public SynchronizedGeneratorIdentity(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection,
                                     String zNode,
                                     int clusterId,
                                     Supplier<Duration> claimDurationSupplier,
                                     Supplier<Duration> acquisitionTimeoutSupplier)

Method Detail

basedOn

public static SynchronizedGeneratorIdentity basedOn(String quorum,
                                                    String znode,
                                                    Supplier<Duration> claimDurationSupplier,
                                                    Supplier<Duration> acquisitionTimeoutSupplier)
                                             throws IOException

Create a new SynchronizedGeneratorIdentity instance.

By using a Supplier instead of static longs for the claim duration and the acquisition timeout, these values can be dynamically reconfigured at runtime.

Parameters:

quorum - Addresses of the ZooKeeper quorum (comma-separated).

znode - Root znode of the ZooKeeper resource-pool.

claimDurationSupplier - Provides the amount of time a claim to a generator-ID should be held.

acquisitionTimeoutSupplier - Provides the amount of time the process of acquiring a generator-ID may take. May be null to indicate that the process may wait indefinitely.

Returns:

A SynchronizedGeneratorIdentity instance.

Throws:

IOException

basedOn

public static SynchronizedGeneratorIdentity basedOn(String quorum,
                                                    String znode,
                                                    Long claimDuration)
                                             throws IOException

Create a new SynchronizedGeneratorIdentity instance.

Parameters:

quorum - Addresses of the ZooKeeper quorum (comma-separated).

znode - Root znode of the ZooKeeper resource-pool.

claimDuration - How long a claim to a generator-ID should be held, in milliseconds.

Returns:

A SynchronizedGeneratorIdentity instance.

Throws:

IOException

getClusterId

public int getClusterId()
                 throws GeneratorException

Specified by:

getClusterId in interface GeneratorIdentityHolder

Throws:

GeneratorException

getGeneratorId

public int getGeneratorId()
                   throws GeneratorException

Specified by:

getGeneratorId in interface GeneratorIdentityHolder

Throws:

GeneratorException

getZNode

public String getZNode()

relinquishGeneratorIdClaim

public void relinquishGeneratorIdClaim()

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException