A B C D E F G H I L M N O P Q R S T V W

A

acquire() - Method in interface org.apache.curator.framework.recipes.locks.InterProcessLock

Acquire the mutex - blocking until it's available.

acquire(long, TimeUnit) - Method in interface org.apache.curator.framework.recipes.locks.InterProcessLock

Acquire the mutex - blocks until it's available or the given time expires.

acquire() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

Acquire the mutex - blocking until it's available.

acquire(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

Acquire the mutex - blocks until it's available or the given time expires.

acquire() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

Acquire the mutex - blocking until it's available.

acquire(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

Acquire the mutex - blocks until it's available or the given time expires.

acquire() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Acquire a lease.

acquire(int) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Acquire qty leases.

acquire(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Acquire a lease.

acquire(int, long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Acquire qty leases.

acquire() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreMutex

acquire(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreMutex

acquire() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Acquire a lease.

acquire(int) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Acquire qty leases.

acquire(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Acquire a lease.

acquire(int, long, TimeUnit) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Acquire qty leases.

add(Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Add delta to the current value and return the new value information.

add(Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Add delta to the current value and return the new value information.

add(T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Add delta to the current value and return the new value information.

addListener(LeaderLatchListener) - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Attaches a listener to this LeaderLatch

Attaching the same listener multiple times is a noop from the second time on.

addListener(LeaderLatchListener, Executor) - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Attaches a listener to this LeaderLatch

Attaching the same listener multiple times is a noop from the second time on.

addListener(SharedCountListener) - Method in class org.apache.curator.framework.recipes.shared.SharedCount

addListener(SharedCountListener, Executor) - Method in class org.apache.curator.framework.recipes.shared.SharedCount

addPath(String) - Method in class org.apache.curator.framework.recipes.locks.Reaper

Add a path (using Mode.REAP_INDEFINITELY) to be checked by the reaper.

addPath(String, Reaper.Mode) - Method in class org.apache.curator.framework.recipes.locks.Reaper

Add a path to be checked by the reaper.

AfterConnectionEstablished - Class in org.apache.curator.framework.recipes

Utility class to allow execution of logic once a ZooKeeper connection becomes available.

allocateQueue(CuratorFramework, String) - Method in interface org.apache.curator.framework.recipes.queue.QueueAllocator

AtomicStats - Class in org.apache.curator.framework.recipes.atomic

Debugging stats about operations

AtomicStats() - Constructor for class org.apache.curator.framework.recipes.atomic.AtomicStats

AtomicValue<T> - Interface in org.apache.curator.framework.recipes.atomic

Abstracts a value returned from one of the Atomics

attemptRevoke(CuratorFramework, String) - Static method in class org.apache.curator.framework.recipes.locks.Revoker

Utility to mark a lock for revocation.

autoRequeue() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

By default, when LeaderSelectorListener.takeLeadership(CuratorFramework) returns, this instance is not requeued.

await() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Causes the current thread to wait until this instance acquires leadership unless the thread is interrupted or closed.

await(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Causes the current thread to wait until this instance acquires leadership unless the thread is interrupted, the specified waiting time elapses or the instance is closed.

B

BlockingQueueConsumer<T> - Class in org.apache.curator.framework.recipes.queue

Utility - a queue consumer that provides behavior similar to a BlockingQueue

BlockingQueueConsumer(ConnectionStateListener) - Constructor for class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Creates with capacity of Integer.MAX_VALUE

BlockingQueueConsumer(ConnectionStateListener, int) - Constructor for class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

BlockingQueueConsumer(ConnectionStateListener, BlockingQueue<T>) - Constructor for class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Wrap the given blocking queue

build() - Method in class org.apache.curator.framework.recipes.atomic.PromotedToLock.Builder

Build the argument block

build() - Method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies.Builder

buildDelayQueue() - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Build a DistributedDelayQueue from the current builder values.

builder() - Static method in class org.apache.curator.framework.recipes.atomic.PromotedToLock

Allocate a new builder

builder(CuratorFramework, QueueConsumer<T>, QueueSerializer<T>, String) - Static method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Allocate a new builder

builder() - Static method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies

Allocate a new builder

buildIdQueue() - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Build a DistributedIdQueue from the current builder values

buildPriorityQueue(int) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Build a DistributedPriorityQueue from the current builder values.

buildQueue() - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Build a DistributedQueue from the current builder values

C

CachedAtomicInteger - Class in org.apache.curator.framework.recipes.atomic

Uses an DistributedAtomicNumber and allocates values in chunks for better performance

CachedAtomicInteger(DistributedAtomicInteger, int) - Constructor for class org.apache.curator.framework.recipes.atomic.CachedAtomicInteger

CachedAtomicLong - Class in org.apache.curator.framework.recipes.atomic

Uses an DistributedAtomicNumber and allocates values in chunks for better performance

CachedAtomicLong(DistributedAtomicLong, int) - Constructor for class org.apache.curator.framework.recipes.atomic.CachedAtomicLong

CancelLeadershipException - Exception in org.apache.curator.framework.recipes.leader

When thrown from ConnectionStateListener.stateChanged(CuratorFramework, ConnectionState), will cause LeaderSelector.interruptLeadership() to get called.

CancelLeadershipException() - Constructor for exception org.apache.curator.framework.recipes.leader.CancelLeadershipException

CancelLeadershipException(String) - Constructor for exception org.apache.curator.framework.recipes.leader.CancelLeadershipException

CancelLeadershipException(String, Throwable) - Constructor for exception org.apache.curator.framework.recipes.leader.CancelLeadershipException

CancelLeadershipException(Throwable) - Constructor for exception org.apache.curator.framework.recipes.leader.CancelLeadershipException

cancelStartTask() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

ChildData - Class in org.apache.curator.framework.recipes.cache

ChildData(String, Stat, byte[]) - Constructor for class org.apache.curator.framework.recipes.cache.ChildData

childEvent(CuratorFramework, PathChildrenCacheEvent) - Method in interface org.apache.curator.framework.recipes.cache.PathChildrenCacheListener

Called when a change has occurred

ChildReaper - Class in org.apache.curator.framework.recipes.locks

Utility to reap empty child nodes of a parent node.

ChildReaper(CuratorFramework, String, Reaper.Mode) - Constructor for class org.apache.curator.framework.recipes.locks.ChildReaper

ChildReaper(CuratorFramework, String, Reaper.Mode, int) - Constructor for class org.apache.curator.framework.recipes.locks.ChildReaper

ChildReaper(CuratorFramework, String, Reaper.Mode, ScheduledExecutorService, int) - Constructor for class org.apache.curator.framework.recipes.locks.ChildReaper

ChildReaper(CuratorFramework, String, Reaper.Mode, ScheduledExecutorService, int, String) - Constructor for class org.apache.curator.framework.recipes.locks.ChildReaper

clean() - Method in class org.apache.curator.framework.recipes.locks.LockInternals

Attempt to delete the lock node so that sequence numbers get reset

clear() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Clears the current data without beginning a new query and without generating any events for listeners.

clearAndRefresh() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Clear out current data and begin a new query on the path

clearDataBytes(String) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

As a memory optimization, you can clear the cached data bytes for a node.

clearDataBytes(String, int) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

As a memory optimization, you can clear the cached data bytes for a node.

close() - Method in class org.apache.curator.framework.recipes.cache.NodeCache

close() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Close/end the cache

close() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Remove this instance from the leadership election.

close(LeaderLatch.CloseMode) - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Remove this instance from the leadership election.

close() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Shutdown this selector and remove yourself from the leadership group

close() - Method in class org.apache.curator.framework.recipes.locks.ChildReaper

close() - Method in interface org.apache.curator.framework.recipes.locks.Lease

Releases the lease so that other clients/processes can acquire it

close() - Method in class org.apache.curator.framework.recipes.locks.Reaper

close() - Method in class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

close() - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

close() - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

close() - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

close() - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

close() - Method in class org.apache.curator.framework.recipes.queue.QueueSharder

close() - Method in class org.apache.curator.framework.recipes.shared.SharedCount

close() - Method in class org.apache.curator.framework.recipes.shared.SharedValue

compareAndSet(Integer, Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

compareAndSet(Long, Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

compareAndSet(T, T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Atomically sets the value to the given updated value if the current value == the expected value.

compareAndSet(byte[], byte[]) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Atomically sets the value to the given updated value if the current value == the expected value.

compareTo(ChildData) - Method in class org.apache.curator.framework.recipes.cache.ChildData

Note: this class has a natural ordering that is inconsistent with equals.

consumeMessage(T) - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

consumeMessage(T) - Method in interface org.apache.curator.framework.recipes.queue.QueueConsumer

Process a message from the queue

countHasChanged(SharedCountReader, int) - Method in interface org.apache.curator.framework.recipes.shared.SharedCountListener

Called when the shared value has changed

D

decrement() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Subtract 1 from the current value and return the new value information.

decrement() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Subtract 1 from the current value and return the new value information.

decrement() - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Subtract 1 from the current value and return the new value information.

deserialize(byte[]) - Method in interface org.apache.curator.framework.recipes.queue.QueueSerializer

Deserialize bytes into a queue item

DistributedAtomicInteger - Class in org.apache.curator.framework.recipes.atomic

A counter that attempts atomic increments.

DistributedAtomicInteger(CuratorFramework, String, RetryPolicy) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Creates in optimistic mode only - i.e.

DistributedAtomicInteger(CuratorFramework, String, RetryPolicy, PromotedToLock) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Creates in mutex promotion mode.

DistributedAtomicLong - Class in org.apache.curator.framework.recipes.atomic

A counter that attempts atomic increments.

DistributedAtomicLong(CuratorFramework, String, RetryPolicy) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Creates in optimistic mode only - i.e.

DistributedAtomicLong(CuratorFramework, String, RetryPolicy, PromotedToLock) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Creates in mutex promotion mode.

DistributedAtomicNumber<T> - Interface in org.apache.curator.framework.recipes.atomic

DistributedAtomicValue - Class in org.apache.curator.framework.recipes.atomic

A distributed value that attempts atomic sets.

DistributedAtomicValue(CuratorFramework, String, RetryPolicy) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Creates in optimistic mode only - i.e.

DistributedAtomicValue(CuratorFramework, String, RetryPolicy, PromotedToLock) - Constructor for class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Creates in mutex promotion mode.

DistributedBarrier - Class in org.apache.curator.framework.recipes.barriers

A barrier as described in the ZK recipes.

DistributedBarrier(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.barriers.DistributedBarrier

DistributedDelayQueue<T> - Class in org.apache.curator.framework.recipes.queue

A variation of the DistributedPriorityQueue that uses time as the priority.

DistributedDoubleBarrier - Class in org.apache.curator.framework.recipes.barriers

A double barrier as described in the ZK recipes.

DistributedDoubleBarrier(CuratorFramework, String, int) - Constructor for class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

Creates the barrier abstraction.

DistributedIdQueue<T> - Class in org.apache.curator.framework.recipes.queue

A version of DistributedQueue that allows IDs to be associated with queue items.

DistributedPriorityQueue<T> - Class in org.apache.curator.framework.recipes.queue

An implementation of the Distributed Priority Queue ZK recipe.

DistributedQueue<T> - Class in org.apache.curator.framework.recipes.queue

An implementation of the Distributed Queue ZK recipe.

DistributedQueue.ProcessType - Enum in org.apache.curator.framework.recipes.queue

drainTo(Collection<? super T>) - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Removes all available elements from this queue and adds them to the given collection.

E

element() - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Return the head of the queue without modifying the queue.

enter() - Method in class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

Enter the barrier and block until all members have entered

enter(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

Enter the barrier and block until all members have entered or the timeout has elapsed

equals(Object) - Method in class org.apache.curator.framework.recipes.cache.ChildData

equals(Object) - Method in class org.apache.curator.framework.recipes.leader.Participant

ErrorMode - Enum in org.apache.curator.framework.recipes.queue

Used when the queue is created with a QueueBuilder.lockPath(String).

execute(CuratorFramework, Runnable) - Static method in class org.apache.curator.framework.recipes.AfterConnectionEstablished

Spawns a new new background thread that will block until a connection is available and then execute the 'runAfterConnection' logic

executor(Executor) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Change the executor used.

F

finalFlushTime(int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Sets an amount of time to call DistributedQueue.flushPuts(long, TimeUnit) when the queue is closed.

fixForSorting(String, String) - Method in interface org.apache.curator.framework.recipes.locks.LockInternalsSorter

fixForSorting(String, String) - Method in class org.apache.curator.framework.recipes.locks.StandardLockInternalsDriver

flushPuts(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

flushPuts(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

flushPuts(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

flushPuts(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Wait until any pending puts are committed

flushPuts(long, TimeUnit) - Method in interface org.apache.curator.framework.recipes.queue.QueueBase

Wait until any pending puts are committed

forceSet(Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

forceSet(Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

forceSet(T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Forcibly sets the value of the counter without any guarantees of atomicity.

forceSet(byte[]) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Forcibly sets the value any guarantees of atomicity.

G

get() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

get() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

get() - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Returns the current value of the counter.

get() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Returns the current value of the counter.

getActualPath() - Method in class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

Returns the currently set path or null if the node does not exist

getChildren() - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

getChildrenForEntering() - Method in class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

getCount() - Method in class org.apache.curator.framework.recipes.shared.SharedCount

getCount() - Method in interface org.apache.curator.framework.recipes.shared.SharedCountReader

Return the current value of the count

getCreateMode(boolean) - Method in enum org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode

getCurrentData() - Method in class org.apache.curator.framework.recipes.cache.NodeCache

Return the current data.

getCurrentData() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Return the current data.

getCurrentData(String) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Return the current data for the given path.

getData() - Method in class org.apache.curator.framework.recipes.cache.ChildData

Returns the node data for this child when the cache mode is set to cache data.

getData() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent

getData() - Method in interface org.apache.curator.framework.recipes.locks.Lease

Return the data stored in the node for this lease

getDelay(String) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

getId() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Return this instance's participant Id

getId() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Return the ID that was set via LeaderSelector.setId(String)

getId() - Method in class org.apache.curator.framework.recipes.leader.Participant

Returns the ID set via LeaderSelector.setId(String)

getInitialData() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent

Special purpose method.

getItems() - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Return any currently queued items without removing them from the queue

getLastMessageCount() - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Return the most recent message count from the queue.

getLastMessageCount() - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

getLastMessageCount() - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Return the most recent message count from the queue.

getLastMessageCount() - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Return the most recent message count from the queue.

getLastMessageCount() - Method in interface org.apache.curator.framework.recipes.queue.QueueBase

Return the most recent message count from the queue.

getLeader() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Return the id for the current leader.

getLeader() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Return the id for the current leader.

getListenable() - Method in class org.apache.curator.framework.recipes.cache.NodeCache

Return the cache listenable

getListenable() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Return the cache listenable

getListenable() - Method in class org.apache.curator.framework.recipes.shared.SharedValue

Returns the listenable

getListenable() - Method in interface org.apache.curator.framework.recipes.shared.SharedValueReader

Returns the listenable

getLockNodeBytes() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

getOptimisticTimeMs() - Method in class org.apache.curator.framework.recipes.atomic.AtomicStats

Returns the time spent trying the operation with optimistic locks

getOptimisticTries() - Method in class org.apache.curator.framework.recipes.atomic.AtomicStats

Returns the number of optimistic locks used to perform the operation

getParticipantNodes() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

Return a sorted list of all current nodes participating in the lock

getParticipantNodes() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Return a list of all current nodes participating in the semaphore

getParticipantNodes(CuratorFramework, String, String, LockInternalsSorter) - Static method in class org.apache.curator.framework.recipes.locks.LockInternals

getParticipants() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Returns the set of current participants in the leader selection

getParticipants() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Returns the set of current participants in the leader selection

getPath() - Method in class org.apache.curator.framework.recipes.cache.ChildData

Returns the full path of the this child

getPromotedLockTries() - Method in class org.apache.curator.framework.recipes.atomic.AtomicStats

Returns the number of mutex locks used to perform the operation

getPromotedTimeMs() - Method in class org.apache.curator.framework.recipes.atomic.AtomicStats

Returns the time spent trying the operation with mutex locks

getPutListenerContainer() - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Return the manager for put listeners

getPutListenerContainer() - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

getPutListenerContainer() - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Return the manager for put listeners

getPutListenerContainer() - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Return the manager for put listeners

getPutListenerContainer() - Method in interface org.apache.curator.framework.recipes.queue.QueueBase

Return the manager for put listeners

getQueue() - Method in class org.apache.curator.framework.recipes.queue.QueueSharder

Return one of the managed queues - the selection method cannot be relied on.

getQueuePaths() - Method in class org.apache.curator.framework.recipes.queue.QueueSharder

Return the current set of shard paths

getShardQty() - Method in class org.apache.curator.framework.recipes.queue.QueueSharder

Return the current number of mananged queues

getSortedChildren(CuratorFramework, String, String, LockInternalsSorter) - Static method in class org.apache.curator.framework.recipes.locks.LockInternals

getSortedChildren(String, LockInternalsSorter, List<String>) - Static method in class org.apache.curator.framework.recipes.locks.LockInternals

getStat() - Method in class org.apache.curator.framework.recipes.cache.ChildData

Returns the stat data for this child

getState() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Returns this instances current state, this is the only way to verify that the object has been closed before closing again.

getStats() - Method in interface org.apache.curator.framework.recipes.atomic.AtomicValue

Returns debugging stats about the operation

getsTheLock(CuratorFramework, List<String>, String, int) - Method in class org.apache.curator.framework.recipes.locks.StandardLockInternalsDriver

getType() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent

getValue() - Method in class org.apache.curator.framework.recipes.shared.SharedValue

getValue() - Method in interface org.apache.curator.framework.recipes.shared.SharedValueReader

Return the current value of the count

H

handleException(Throwable) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Default behavior is just to log the exception

hashCode() - Method in class org.apache.curator.framework.recipes.cache.ChildData

hashCode() - Method in class org.apache.curator.framework.recipes.leader.Participant

hasLeadership() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Return true if leadership is currently held by this instance

hasLeadership() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Return true if leadership is currently held by this instance

I

increment() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Add 1 to the current value and return the new value information.

increment() - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Add 1 to the current value and return the new value information.

increment() - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Add 1 to the current value and return the new value information.

initialize(Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

initialize(Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

initialize(T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Atomic values are initially set to the equivalent of NULL in a database.

initialize(byte[]) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Atomic values are initially set to the equivalent of NULL in a database.

internalRequeue() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

InterProcessLock - Interface in org.apache.curator.framework.recipes.locks

InterProcessMultiLock - Class in org.apache.curator.framework.recipes.locks

A container that manages multiple locks as a single entity.

InterProcessMultiLock(CuratorFramework, List<String>) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

Creates a multi lock of InterProcessMutexs

InterProcessMultiLock(List<InterProcessLock>) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

Creates a multi lock of any type of inter process lock

InterProcessMutex - Class in org.apache.curator.framework.recipes.locks

A re-entrant mutex that works across JVMs.

InterProcessMutex(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessMutex

InterProcessReadWriteLock - Class in org.apache.curator.framework.recipes.locks

A re-entrant read/write mutex that works across JVMs.

InterProcessReadWriteLock(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock

InterProcessSemaphore - Class in org.apache.curator.framework.recipes.locks

Deprecated. Use InterProcessSemaphoreV2 instead of this class. It uses a better algorithm.

InterProcessSemaphore(CuratorFramework, String, int) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated.

InterProcessSemaphore(CuratorFramework, String, SharedCountReader) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated.

InterProcessSemaphoreMutex - Class in org.apache.curator.framework.recipes.locks

A NON re-entrant mutex that works across JVMs.

InterProcessSemaphoreMutex(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreMutex

InterProcessSemaphoreV2 - Class in org.apache.curator.framework.recipes.locks

A counting semaphore that works across JVMs.

InterProcessSemaphoreV2(CuratorFramework, String, int) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

InterProcessSemaphoreV2(CuratorFramework, String, SharedCountReader) - Constructor for class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

interruptLeadership() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Attempt to cancel and interrupt the current leadership if this instance has leadership

isAcquiredInThisProcess() - Method in interface org.apache.curator.framework.recipes.locks.InterProcessLock

Returns true if the mutex is acquired by a thread in this JVM

isAcquiredInThisProcess() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

isAcquiredInThisProcess() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

Returns true if the mutex is acquired by a thread in this JVM

isAcquiredInThisProcess() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreMutex

isLeader() - Method in interface org.apache.curator.framework.recipes.leader.LeaderLatchListener

This is called when the LeaderLatch's state goes from hasLeadership = false to hasLeadership = true.

isLeader() - Method in class org.apache.curator.framework.recipes.leader.Participant

Returns true if this participant is the current leader

isProtected() - Method in enum org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode

L

LeaderLatch - Class in org.apache.curator.framework.recipes.leader

Abstraction to select a "leader" amongst multiple contenders in a group of JMVs connected to a Zookeeper cluster.

LeaderLatch(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderLatch

LeaderLatch(CuratorFramework, String, String) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderLatch

LeaderLatch(CuratorFramework, String, String, LeaderLatch.CloseMode) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderLatch

LeaderLatch.CloseMode - Enum in org.apache.curator.framework.recipes.leader

How to handle listeners when the latch is closed

LeaderLatch.State - Enum in org.apache.curator.framework.recipes.leader

LeaderLatchListener - Interface in org.apache.curator.framework.recipes.leader

A LeaderLatchListener can be used to be notified asynchronously about when the state of the LeaderLatch has changed.

LeaderSelector - Class in org.apache.curator.framework.recipes.leader

Abstraction to select a "leader" amongst multiple contenders in a group of JMVs connected to a Zookeeper cluster.

LeaderSelector(CuratorFramework, String, LeaderSelectorListener) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderSelector

LeaderSelector(CuratorFramework, String, ThreadFactory, Executor, LeaderSelectorListener) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderSelector

Deprecated. This constructor was poorly thought out. Custom executor is useless. Use this version instead: LeaderSelector.LeaderSelector(CuratorFramework, String, ExecutorService, LeaderSelectorListener)

LeaderSelector(CuratorFramework, String, ExecutorService, LeaderSelectorListener) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderSelector

LeaderSelector(CuratorFramework, String, CloseableExecutorService, LeaderSelectorListener) - Constructor for class org.apache.curator.framework.recipes.leader.LeaderSelector

LeaderSelectorListener - Interface in org.apache.curator.framework.recipes.leader

Notification for leadership

LeaderSelectorListenerAdapter - Class in org.apache.curator.framework.recipes.leader

An implementation of LeaderSelectorListener that adds the recommended handling for connection state problems

LeaderSelectorListenerAdapter() - Constructor for class org.apache.curator.framework.recipes.leader.LeaderSelectorListenerAdapter

Lease - Interface in org.apache.curator.framework.recipes.locks

Represents an acquired lease from an InterProcessSemaphore.

leave() - Method in class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

Leave the barrier and block until all members have left

leave(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.barriers.DistributedDoubleBarrier

Leave the barrier and block until all members have left or the timeout has elapsed

LockInternals - Class in org.apache.curator.framework.recipes.locks

LockInternalsSorter - Interface in org.apache.curator.framework.recipes.locks

lockPath(String) - Method in class org.apache.curator.framework.recipes.atomic.PromotedToLock.Builder

Set the path for the mutex lock (required)

lockPath(String) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Without a lock set, queue items are removed before being sent to the queue consumer.

M

makeRevocable(RevocationListener<InterProcessMutex>) - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

makeRevocable(RevocationListener<InterProcessMutex>, Executor) - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

makeRevocable(RevocationListener<T>) - Method in interface org.apache.curator.framework.recipes.locks.Revocable

Make the lock revocable.

makeRevocable(RevocationListener<T>, Executor) - Method in interface org.apache.curator.framework.recipes.locks.Revocable

Make the lock revocable.

maxItems(int) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

By default, the various queues are unbounded.

maxQueues(int) - Method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies.Builder

Change the maximum number of queues to create.

MultiItem<T> - Interface in org.apache.curator.framework.recipes.queue

Abstraction for multiple items.

N

newExecutorService() - Static method in class org.apache.curator.framework.recipes.locks.Reaper

Allocate an executor service for the reaper

newQueueThreshold(int) - Method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies.Builder

Change the queue threshold.

next() - Method in class org.apache.curator.framework.recipes.atomic.CachedAtomicInteger

Returns the next value (incrementing by 1).

next() - Method in class org.apache.curator.framework.recipes.atomic.CachedAtomicLong

Returns the next value (incrementing by 1).

nextItem() - Method in interface org.apache.curator.framework.recipes.queue.MultiItem

Called repeatedly to get the items to add to the queue.

NodeCache - Class in org.apache.curator.framework.recipes.cache

A utility that attempts to keep the data from a node locally cached.

NodeCache(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.cache.NodeCache

NodeCache(CuratorFramework, String, boolean) - Constructor for class org.apache.curator.framework.recipes.cache.NodeCache

NodeCacheListener - Interface in org.apache.curator.framework.recipes.cache

nodeChanged() - Method in interface org.apache.curator.framework.recipes.cache.NodeCacheListener

Called when a change has occurred

notLeader() - Method in interface org.apache.curator.framework.recipes.leader.LeaderLatchListener

This is called when the LeaderLatch's state goes from hasLeadership = true to hasLeadership = false.

O

offer(byte[]) - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Inserts data into queue.

org.apache.curator.framework.recipes - package org.apache.curator.framework.recipes

org.apache.curator.framework.recipes.atomic - package org.apache.curator.framework.recipes.atomic

org.apache.curator.framework.recipes.barriers - package org.apache.curator.framework.recipes.barriers

org.apache.curator.framework.recipes.cache - package org.apache.curator.framework.recipes.cache

org.apache.curator.framework.recipes.leader - package org.apache.curator.framework.recipes.leader

org.apache.curator.framework.recipes.locks - package org.apache.curator.framework.recipes.locks

org.apache.curator.framework.recipes.nodes - package org.apache.curator.framework.recipes.nodes

org.apache.curator.framework.recipes.queue - package org.apache.curator.framework.recipes.queue

org.apache.curator.framework.recipes.shared - package org.apache.curator.framework.recipes.shared

P

Participant - Class in org.apache.curator.framework.recipes.leader

Describes a participant in a leadership selection

Participant(String, boolean) - Constructor for class org.apache.curator.framework.recipes.leader.Participant

PathChildrenCache - Class in org.apache.curator.framework.recipes.cache

A utility that attempts to keep all data from all children of a ZK path locally cached.

PathChildrenCache(CuratorFramework, String, PathChildrenCacheMode) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

Deprecated. use PathChildrenCache.PathChildrenCache(CuratorFramework, String, boolean) instead

PathChildrenCache(CuratorFramework, String, PathChildrenCacheMode, ThreadFactory) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

Deprecated. use PathChildrenCache.PathChildrenCache(CuratorFramework, String, boolean, ThreadFactory) instead

PathChildrenCache(CuratorFramework, String, boolean) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

PathChildrenCache(CuratorFramework, String, boolean, ThreadFactory) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

PathChildrenCache(CuratorFramework, String, boolean, boolean, ThreadFactory) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

PathChildrenCache(CuratorFramework, String, boolean, boolean, ExecutorService) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

PathChildrenCache(CuratorFramework, String, boolean, boolean, CloseableExecutorService) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCache

PathChildrenCache.StartMode - Enum in org.apache.curator.framework.recipes.cache

Method of priming cache on PathChildrenCache.start(StartMode)

PathChildrenCacheEvent - Class in org.apache.curator.framework.recipes.cache

POJO that abstracts a change to a path

PathChildrenCacheEvent(PathChildrenCacheEvent.Type, ChildData) - Constructor for class org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent

PathChildrenCacheEvent.Type - Enum in org.apache.curator.framework.recipes.cache

Type of change

PathChildrenCacheListener - Interface in org.apache.curator.framework.recipes.cache

Listener for PathChildrenCache changes

PathChildrenCacheMode - Enum in org.apache.curator.framework.recipes.cache

Deprecated. no longer used. Instead use either PathChildrenCache.PathChildrenCache(CuratorFramework, String, boolean) or PathChildrenCache.PathChildrenCache(CuratorFramework, String, boolean, ThreadFactory)

peek() - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Returns the data at the first element of the queue, or null if the queue is empty.

PersistentEphemeralNode - Class in org.apache.curator.framework.recipes.nodes

A persistent ephemeral node is an ephemeral node that attempts to stay present in ZooKeeper, even through connection and session interruptions.

PersistentEphemeralNode(CuratorFramework, PersistentEphemeralNode.Mode, String, byte[]) - Constructor for class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

PersistentEphemeralNode.Mode - Enum in org.apache.curator.framework.recipes.nodes

The mode for node creation

poll(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

poll() - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Attempts to remove the head of the queue and return it.

postValue() - Method in interface org.apache.curator.framework.recipes.atomic.AtomicValue

Returns the value of the counter after to the operation

preValue() - Method in interface org.apache.curator.framework.recipes.atomic.AtomicValue

Returns the value of the counter prior to the operation

processWithLockSafety(String, DistributedQueue.ProcessType) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

PromotedToLock - Class in org.apache.curator.framework.recipes.atomic

Abstraction of arguments for mutex promotion.

PromotedToLock.Builder - Class in org.apache.curator.framework.recipes.atomic

put(T, long) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Add an item into the queue.

put(T, long, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Same as DistributedDelayQueue.put(Object, long) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

put(T, String) - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

Put an item into the queue with the given Id

NOTE: if an upper bound was set via QueueBuilder.maxItems, this method will block until there is available space in the queue.

put(T, String, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

Same as DistributedIdQueue.put(Object, String) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

put(T, int) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Add an item into the queue.

put(T, int, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Same as DistributedPriorityQueue.put(Object, int) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

put(T) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Add an item into the queue.

put(T, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Same as DistributedQueue.put(Object) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

putCompleted(T) - Method in interface org.apache.curator.framework.recipes.queue.QueuePutListener

Notification that a single item put has completed

putInBackground(boolean) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

By default, messages are added in the background.

putMulti(MultiItem<T>, long) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Add a set of items with the same priority into the queue.

putMulti(MultiItem<T>, long, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Same as DistributedDelayQueue.putMulti(MultiItem, long) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

putMulti(MultiItem<T>, int) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Add a set of items with the same priority into the queue.

putMulti(MultiItem<T>, int, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Same as DistributedPriorityQueue.putMulti(MultiItem, int) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

putMulti(MultiItem<T>) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Add a set of items into the queue.

putMulti(MultiItem<T>, int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Same as DistributedQueue.putMulti(MultiItem) but allows a maximum wait time if an upper bound was set via QueueBuilder.maxItems.

putMultiCompleted(MultiItem<T>) - Method in interface org.apache.curator.framework.recipes.queue.QueuePutListener

Notification that a multi item put has completed

Q

QueueAllocator<U,T extends QueueBase<U>> - Interface in org.apache.curator.framework.recipes.queue

QueueBase<T> - Interface in org.apache.curator.framework.recipes.queue

QueueBuilder<T> - Class in org.apache.curator.framework.recipes.queue

The builder for both DistributedQueue and DistributedPriorityQueue

QueueConsumer<T> - Interface in org.apache.curator.framework.recipes.queue

Message Consumer

QueuePutListener<T> - Interface in org.apache.curator.framework.recipes.queue

Queue puts are done in the background.

QueueSafety<T> - Class in org.apache.curator.framework.recipes.queue

Parameter block for specifying queue safety with either DistributedQueue or DistributedPriorityQueue

QueueSafety(String, QueueConsumer<T>) - Constructor for class org.apache.curator.framework.recipes.queue.QueueSafety

QueueSerializer<T> - Interface in org.apache.curator.framework.recipes.queue

Helper to serialize/deserialize queue items

QueueSharder<U,T extends QueueBase<U>> - Class in org.apache.curator.framework.recipes.queue

A utility for shard a distributed queue.

QueueSharder(CuratorFramework, QueueAllocator<U, T>, String, String, QueueSharderPolicies) - Constructor for class org.apache.curator.framework.recipes.queue.QueueSharder

QueueSharderPolicies - Class in org.apache.curator.framework.recipes.queue

Various policies/options for sharding.

QueueSharderPolicies.Builder - Class in org.apache.curator.framework.recipes.queue

R

readLock() - Method in class org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock

Returns the lock used for reading.

reap(Reaper.PathHolder) - Method in class org.apache.curator.framework.recipes.locks.Reaper

Reaper - Class in org.apache.curator.framework.recipes.locks

Utility to clean up parent lock nodes so that they don't stay around as garbage

Reaper(CuratorFramework) - Constructor for class org.apache.curator.framework.recipes.locks.Reaper

Uses the default reaping threshold of 5 minutes and creates an internal thread pool

Reaper(CuratorFramework, int) - Constructor for class org.apache.curator.framework.recipes.locks.Reaper

Uses the given reaping threshold and creates an internal thread pool

Reaper(CuratorFramework, ScheduledExecutorService, int) - Constructor for class org.apache.curator.framework.recipes.locks.Reaper

Reaper(CuratorFramework, ScheduledExecutorService, int, String) - Constructor for class org.apache.curator.framework.recipes.locks.Reaper

Reaper.Mode - Enum in org.apache.curator.framework.recipes.locks

rebuild() - Method in class org.apache.curator.framework.recipes.cache.NodeCache

NOTE: this is a BLOCKING method.

rebuild() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

NOTE: this is a BLOCKING method.

rebuildNode(String) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

NOTE: this is a BLOCKING method.

release() - Method in interface org.apache.curator.framework.recipes.locks.InterProcessLock

Perform one release of the mutex.

release() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMultiLock

Perform one release of the mutex.

release() - Method in class org.apache.curator.framework.recipes.locks.InterProcessMutex

Perform one release of the mutex if the calling thread is the same thread that acquired it.

release() - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreMutex

remove(String) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

remove(String) - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

Remove any items with the given Id

remove() - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Attempts to remove the head of the queue and return it.

removeBarrier() - Method in class org.apache.curator.framework.recipes.barriers.DistributedBarrier

Utility to remove the barrier node

removeListener(LeaderLatchListener) - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Removes a given listener from this LeaderLatch

removeListener(SharedCountListener) - Method in class org.apache.curator.framework.recipes.shared.SharedCount

removePath(String) - Method in class org.apache.curator.framework.recipes.locks.Reaper

Stop reaping the given path

requeue() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Re-queue an attempt for leadership.

retryPolicy(RetryPolicy) - Method in class org.apache.curator.framework.recipes.atomic.PromotedToLock.Builder

Set the retry policy to use when an operation does not succeed

returnAll(Collection<Lease>) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Convenience method.

returnAll(Collection<Lease>) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Convenience method.

returnLease(Lease) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphore

Deprecated. Convenience method.

returnLease(Lease) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Convenience method.

Revocable<T> - Interface in org.apache.curator.framework.recipes.locks

Specifies locks that can be revoked

RevocationListener<T> - Interface in org.apache.curator.framework.recipes.locks

revocationRequested(T) - Method in interface org.apache.curator.framework.recipes.locks.RevocationListener

Called when a revocation request has been received.

Revoker - Class in org.apache.curator.framework.recipes.locks

S

schedule(Reaper.PathHolder, int) - Method in class org.apache.curator.framework.recipes.locks.Reaper

serialize(T) - Method in interface org.apache.curator.framework.recipes.queue.QueueSerializer

Turn a queue item into bytes

setBarrier() - Method in class org.apache.curator.framework.recipes.barriers.DistributedBarrier

Utility to set the barrier node

setCount(int) - Method in class org.apache.curator.framework.recipes.shared.SharedCount

Change the shared count value irrespective of its previous state

setData(byte[]) - Method in class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

Set data that ephemeral node should set in ZK also writes the data to the node

setErrorMode(ErrorMode) - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

setErrorMode(ErrorMode) - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

setErrorMode(ErrorMode) - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

setErrorMode(ErrorMode) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Used when the queue is created with a QueueBuilder.lockPath(String).

setErrorMode(ErrorMode) - Method in interface org.apache.curator.framework.recipes.queue.QueueBase

Used when the queue is created with a QueueBuilder.lockPath(String).

setId(String) - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Sets the ID to store for this leader.

setNodeData(byte[]) - Method in class org.apache.curator.framework.recipes.locks.InterProcessSemaphoreV2

Set the data to put for the node created by this semaphore.

setValue(byte[]) - Method in class org.apache.curator.framework.recipes.shared.SharedValue

Change the shared value value irrespective of its previous state

SharedCount - Class in org.apache.curator.framework.recipes.shared

Manages a shared integer.

SharedCount(CuratorFramework, String, int) - Constructor for class org.apache.curator.framework.recipes.shared.SharedCount

SharedCountListener - Interface in org.apache.curator.framework.recipes.shared

Listener for changes to a shared count

SharedCountReader - Interface in org.apache.curator.framework.recipes.shared

Abstracts a shared integer and allows listening for changes to its value

SharedValue - Class in org.apache.curator.framework.recipes.shared

Manages a shared value.

SharedValue(CuratorFramework, String, byte[]) - Constructor for class org.apache.curator.framework.recipes.shared.SharedValue

SharedValueListener - Interface in org.apache.curator.framework.recipes.shared

Listener for changes to a shared value

SharedValueReader - Interface in org.apache.curator.framework.recipes.shared

Abstracts a shared value and allows listening for changes to the value

SimpleDistributedQueue - Class in org.apache.curator.framework.recipes.queue

Drop in replacement for: org.apache.zookeeper.recipes.queue.DistributedQueue that is part of the ZooKeeper distribution

SimpleDistributedQueue(CuratorFramework, String) - Constructor for class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

size() - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Returns the number of currently queue items

sortChildren(List<String>) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

standardFixForSorting(String, String) - Static method in class org.apache.curator.framework.recipes.locks.StandardLockInternalsDriver

StandardLockInternalsDriver - Class in org.apache.curator.framework.recipes.locks

StandardLockInternalsDriver() - Constructor for class org.apache.curator.framework.recipes.locks.StandardLockInternalsDriver

start() - Method in class org.apache.curator.framework.recipes.cache.NodeCache

Start the cache.

start(boolean) - Method in class org.apache.curator.framework.recipes.cache.NodeCache

Same as NodeCache.start() but gives the option of doing an initial build

start() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Start the cache.

start(boolean) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Deprecated. use PathChildrenCache.start(StartMode)

start(PathChildrenCache.StartMode) - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCache

Start the cache.

start() - Method in class org.apache.curator.framework.recipes.leader.LeaderLatch

Add this instance to the leadership election and attempt to acquire leadership.

start() - Method in class org.apache.curator.framework.recipes.leader.LeaderSelector

Attempt leadership.

start() - Method in class org.apache.curator.framework.recipes.locks.ChildReaper

The reaper must be started

start() - Method in class org.apache.curator.framework.recipes.locks.Reaper

The reaper must be started

start() - Method in class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

You must call start() to initiate the persistent ephemeral node.

start() - Method in class org.apache.curator.framework.recipes.queue.DistributedDelayQueue

Start the queue.

start() - Method in class org.apache.curator.framework.recipes.queue.DistributedIdQueue

start() - Method in class org.apache.curator.framework.recipes.queue.DistributedPriorityQueue

Start the queue.

start() - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

Start the queue.

start() - Method in interface org.apache.curator.framework.recipes.queue.QueueBase

Start the queue.

start() - Method in class org.apache.curator.framework.recipes.queue.QueueSharder

The sharder must be started

start() - Method in class org.apache.curator.framework.recipes.shared.SharedCount

The shared count must be started before it can be used.

start() - Method in class org.apache.curator.framework.recipes.shared.SharedValue

The shared value must be started before it can be used.

stateChanged(CuratorFramework, ConnectionState) - Method in class org.apache.curator.framework.recipes.leader.LeaderSelectorListenerAdapter

stateChanged(CuratorFramework, ConnectionState) - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

subtract(Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

Subtract delta from the current value and return the new value information.

subtract(Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

Subtract delta from the current value and return the new value information.

subtract(T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Subtract delta from the current value and return the new value information.

succeeded() - Method in interface org.apache.curator.framework.recipes.atomic.AtomicValue

MUST be checked. Returns true if the operation succeeded.

T

take() - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Take the next item from the queue, blocking until there is an item available

take(int, TimeUnit) - Method in class org.apache.curator.framework.recipes.queue.BlockingQueueConsumer

Take the next item from the queue, waiting up to the specified time for an available item.

take() - Method in class org.apache.curator.framework.recipes.queue.SimpleDistributedQueue

Removes the head of the queue and returns it, blocks until it succeeds.

takeLeadership(CuratorFramework) - Method in interface org.apache.curator.framework.recipes.leader.LeaderSelectorListener

Called when your instance has been granted leadership.

threadFactory(ThreadFactory) - Method in class org.apache.curator.framework.recipes.queue.QueueBuilder

Change the thread factory used.

threadFactory(ThreadFactory) - Method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies.Builder

Change the thread factory that's used to create the sharder's thread

thresholdCheckMs(int) - Method in class org.apache.curator.framework.recipes.queue.QueueSharderPolicies.Builder

Change the threshold check.

timeout(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.atomic.PromotedToLock.Builder

Set the timeout to use when locking (optional)

toString() - Method in class org.apache.curator.framework.recipes.cache.ChildData

toString() - Method in class org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent

toString() - Method in class org.apache.curator.framework.recipes.leader.Participant

tryRemove(String) - Method in class org.apache.curator.framework.recipes.queue.DistributedQueue

trySet(Integer) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicInteger

trySet(Long) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicLong

trySet(T) - Method in interface org.apache.curator.framework.recipes.atomic.DistributedAtomicNumber

Attempt to atomically set the value to the given value.

trySet(byte[]) - Method in class org.apache.curator.framework.recipes.atomic.DistributedAtomicValue

Attempt to atomically set the value to the given value.

trySetCount(int) - Method in class org.apache.curator.framework.recipes.shared.SharedCount

Changes the shared count only if its value has not changed since this client last read it.

trySetValue(byte[]) - Method in class org.apache.curator.framework.recipes.shared.SharedValue

Changes the shared value only if its value has not changed since this client last read it.

V

valueHasChanged(SharedValueReader, byte[]) - Method in interface org.apache.curator.framework.recipes.shared.SharedValueListener

Called when the shared value has changed

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCache.StartMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCacheMode

Deprecated. Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.leader.LeaderLatch.CloseMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.leader.LeaderLatch.State

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.locks.Reaper.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.queue.DistributedQueue.ProcessType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.curator.framework.recipes.queue.ErrorMode

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCache.StartMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCacheEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.cache.PathChildrenCacheMode

Deprecated. Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.leader.LeaderLatch.CloseMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.leader.LeaderLatch.State

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.locks.Reaper.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.queue.DistributedQueue.ProcessType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.curator.framework.recipes.queue.ErrorMode

Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForInitialCreate(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode

Block until the either initial node creation initiated by PersistentEphemeralNode.start() succeeds or the timeout elapses.

waitOnBarrier() - Method in class org.apache.curator.framework.recipes.barriers.DistributedBarrier

Blocks until the barrier node comes into existence

waitOnBarrier(long, TimeUnit) - Method in class org.apache.curator.framework.recipes.barriers.DistributedBarrier

Blocks until the barrier no longer exists or the timeout elapses

writeLock() - Method in class org.apache.curator.framework.recipes.locks.InterProcessReadWriteLock

Returns the lock used for writing.

A B C D E F G H I L M N O P Q R S T V W