com.ibm.etcd.client.utils

Class PersistentLeaseKey

java.lang.Object

com.google.common.util.concurrent.internal.InternalFutureFailureAccess

com.google.common.util.concurrent.AbstractFuture<com.google.protobuf.ByteString>

com.ibm.etcd.client.utils.PersistentLeaseKey

All Implemented Interfaces:

com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.ByteString>, AutoCloseable, Future<com.google.protobuf.ByteString>

public class PersistentLeaseKey
extends com.google.common.util.concurrent.AbstractFuture<com.google.protobuf.ByteString>
implements AutoCloseable

Etcd key-value bound to a PersistentLease. If the key already exists its value won't be changed but it will be associated with the provided lease. If it doesn't already exist or is deleted by someone else, it will be (re)-created with a provided default value.

Can be optionally associated with a RangeCache within whose range the key lies. Doing so helps to ensure local state consistency between the two.

Closing the PersistentLeaseKey will always delete the associated key-value.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.common.util.concurrent.SettableFuture<Object>	closeFuture
protected com.google.protobuf.ByteString	key
protected boolean	leaseActive
protected ListenerObserver<PersistentLease.LeaseState>	stateObserver
protected com.google.common.util.concurrent.ListenableFuture<?>	updateFuture

Constructor Summary

Constructors

Constructor and Description
PersistentLeaseKey(EtcdClient client, com.google.protobuf.ByteString key, com.google.protobuf.ByteString defaultValue, RangeCache rangeCache) Create a PersistentLeaseKey associated with the provided client's session lease.
PersistentLeaseKey(EtcdClient client, PersistentLease lease, com.google.protobuf.ByteString key, com.google.protobuf.ByteString defaultValue, RangeCache rangeCache)

Method Summary

Modifier and Type	Method and Description
void	close() Closing deletes the key.
com.google.common.util.concurrent.ListenableFuture<?>	closeWithFuture()
protected void	interruptTask()
protected boolean	isActive() Deprecated.
protected void	leaseStateChanged(boolean c, PersistentLease.LeaseState newState, Throwable t)
protected void	putKey(long leaseId)
void	setDefaultValue(com.google.protobuf.ByteString value) Sets value to use if keyvalue has to be recreated, value of key on server isn't otherwise changed
void	start()
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.ByteString>	startWithFuture()

Methods inherited from class com.google.common.util.concurrent.AbstractFuture

addListener, afterDone, cancel, get, get, isCancelled, isDone, pendingToString, set, setException, setFuture, toString, tryInternalFastPathGetFailure, wasInterrupted

Methods inherited from class java.lang.Object

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

Field Detail

key

protected final com.google.protobuf.ByteString key

stateObserver

protected final ListenerObserver<PersistentLease.LeaseState> stateObserver

leaseActive

protected boolean leaseActive

updateFuture

protected com.google.common.util.concurrent.ListenableFuture<?> updateFuture

closeFuture

protected com.google.common.util.concurrent.SettableFuture<Object> closeFuture

Constructor Detail

PersistentLeaseKey

public PersistentLeaseKey(EtcdClient client,
                          PersistentLease lease,
                          com.google.protobuf.ByteString key,
                          com.google.protobuf.ByteString defaultValue,
                          RangeCache rangeCache)

Parameters:

client -

lease - if null will use client's session lease

key -

defaultValue -

rangeCache - optional, may be null

PersistentLeaseKey

public PersistentLeaseKey(EtcdClient client,
                          com.google.protobuf.ByteString key,
                          com.google.protobuf.ByteString defaultValue,
                          RangeCache rangeCache)

Create a PersistentLeaseKey associated with the provided client's session lease.

Parameters:

client -

key -

defaultValue -

rangeCache - optional, may be null

Method Detail

leaseStateChanged

protected void leaseStateChanged(boolean c,
                                 PersistentLease.LeaseState newState,
                                 Throwable t)

isActive

@Deprecated
protected boolean isActive()

Deprecated.

start

public void start()

startWithFuture

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.ByteString> startWithFuture()

Returns:

a future completed when the key is created and associated with the lease

setDefaultValue

public void setDefaultValue(com.google.protobuf.ByteString value)

Sets value to use if keyvalue has to be recreated, value of key on server isn't otherwise changed

Parameters:

value - must not be null

putKey

protected void putKey(long leaseId)

interruptTask

protected void interruptTask()

Overrides:

interruptTask in class com.google.common.util.concurrent.AbstractFuture<com.google.protobuf.ByteString>

close

public void close()

Closing deletes the key.

Specified by:

close in interface AutoCloseable

closeWithFuture

public com.google.common.util.concurrent.ListenableFuture<?> closeWithFuture()

Returns:

future completes when key is verified deleted