org.lable.oss.uniqueid.zookeeper

Class ResourceClaim

java.lang.Object

org.lable.oss.uniqueid.zookeeper.ResourceClaim

All Implemented Interfaces:

Closeable, AutoCloseable, org.lable.oss.dynamicconfig.zookeeper.ZooKeeperConnectionObserver

Direct Known Subclasses:

ExpiringResourceClaim

public class ResourceClaim
extends Object
implements org.lable.oss.dynamicconfig.zookeeper.ZooKeeperConnectionObserver, Closeable

Represents a claim on resource (represented by an int) from a finite pool of resources negotiated through a queueing protocol facilitated by a ZooKeeper-quorum.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceClaim.State Internal state of this ResourceClaim.

Field Summary

Fields

Modifier and Type	Field and Description
protected ResourceClaim.State	state

Method Summary

Modifier and Type	Method and Description
static ResourceClaim	claim(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection, int poolSize, String znode) Claim a resource.
static ResourceClaim	claim(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection, int poolSize, String znode, Duration timeout) Claim a resource.
void	close() Relinquish the claim to this resource, and release it back to the resource pool.
void	close(boolean nodeAlreadyDeleted)
void	connected()
void	disconnected()
int	get() Get the claimed resource.
String	getConfiguredZNode()

Methods inherited from class java.lang.Object

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

Field Detail

state

protected ResourceClaim.State state

Method Detail

claim

public static ResourceClaim claim(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection,
                                  int poolSize,
                                  String znode)
                           throws IOException

Claim a resource.

Parameters:

zooKeeperConnection - ZooKeeper connection to use.

poolSize - Size of the resource pool.

znode - Root znode of the ZooKeeper resource-pool.

Returns:

A resource claim.

Throws:

IOException

claim

public static ResourceClaim claim(org.lable.oss.dynamicconfig.zookeeper.MonitoringZookeeperConnection zooKeeperConnection,
                                  int poolSize,
                                  String znode,
                                  Duration timeout)
                           throws IOException

Claim a resource.

Parameters:

zooKeeperConnection - ZooKeeper connection to use.

poolSize - Size of the resource pool.

znode - Root znode of the ZooKeeper resource-pool.

timeout - Time out if the process takes longer than this.

Returns:

A resource claim.

Throws:

IOException

get

public int get()

Get the claimed resource.

Returns:

The resource claimed.

Throws:

IllegalStateException - Thrown when the claim is no longer held.

close

public void close()

Relinquish the claim to this resource, and release it back to the resource pool.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

close

public void close(boolean nodeAlreadyDeleted)

getConfiguredZNode

public String getConfiguredZNode()

disconnected

public void disconnected()

Specified by:

disconnected in interface org.lable.oss.dynamicconfig.zookeeper.ZooKeeperConnectionObserver

connected

public void connected()

Specified by:

connected in interface org.lable.oss.dynamicconfig.zookeeper.ZooKeeperConnectionObserver