Uses of Interface
org.apache.curator.framework.CuratorFramework

Packages that use CuratorFramework

Package	Description
async
discovery
framework
leader
locking
org.apache.curator.framework
org.apache.curator.framework.api
org.apache.curator.framework.imps
org.apache.curator.framework.recipes
org.apache.curator.framework.recipes.atomic
org.apache.curator.framework.recipes.barriers
org.apache.curator.framework.recipes.cache
org.apache.curator.framework.recipes.leader
org.apache.curator.framework.recipes.locks
org.apache.curator.framework.recipes.nodes
org.apache.curator.framework.recipes.queue
org.apache.curator.framework.recipes.shared
org.apache.curator.framework.recipes.watch
org.apache.curator.framework.schema
org.apache.curator.framework.state
org.apache.curator.x.async
org.apache.curator.x.async.details
org.apache.curator.x.discovery
org.apache.curator.x.discovery.details

Uses of CuratorFramework in async

Methods in async with parameters of type CuratorFramework

Modifier and Type	Method	Description
static void	AsyncExamples.create(CuratorFramework client, String path, byte[] payload)
static void	AsyncExamples.createThenWatch(CuratorFramework client, String path)
static void	AsyncExamples.createThenWatchSimple(CuratorFramework client, String path)
static AsyncCuratorFramework	AsyncExamples.wrap(CuratorFramework client)

Uses of CuratorFramework in discovery

Constructors in discovery with parameters of type CuratorFramework

Modifier	Constructor	Description
	ExampleServer(CuratorFramework client, String path, String serviceName, String description)

Uses of CuratorFramework in framework

Methods in framework that return CuratorFramework

Modifier and Type	Method	Description
static CuratorFramework	CreateClientExamples.createSimple(String connectionString)
static CuratorFramework	CreateClientExamples.createWithOptions(String connectionString, RetryPolicy retryPolicy, int connectionTimeoutMs, int sessionTimeoutMs)

Methods in framework with parameters of type CuratorFramework

Modifier and Type	Method	Description
static void	CrudExamples.create(CuratorFramework client, String path, byte[] payload)
static void	CrudExamples.createEphemeral(CuratorFramework client, String path, byte[] payload)
static String	CrudExamples.createEphemeralSequential(CuratorFramework client, String path, byte[] payload)
static void	CrudExamples.createIdempotent(CuratorFramework client, String path, byte[] payload)
static void	CrudExamples.delete(CuratorFramework client, String path)
static void	CrudExamples.deleteIdempotent(CuratorFramework client, String path, int currentVersion)
static void	CrudExamples.guaranteedDelete(CuratorFramework client, String path)
static void	CrudExamples.setData(CuratorFramework client, String path, byte[] payload)
static void	CrudExamples.setDataAsync(CuratorFramework client, String path, byte[] payload)
static void	CrudExamples.setDataAsyncWithCallback(CuratorFramework client, BackgroundCallback callback, String path, byte[] payload)
static void	CrudExamples.setDataIdempotent(CuratorFramework client, String path, byte[] payload, int currentVersion)
static Collection<CuratorTransactionResult>	TransactionExamples.transaction(CuratorFramework client)
static List<String>	CrudExamples.watchedGetChildren(CuratorFramework client, String path)
static List<String>	CrudExamples.watchedGetChildren(CuratorFramework client, String path, org.apache.zookeeper.Watcher watcher)

Uses of CuratorFramework in leader

Methods in leader with parameters of type CuratorFramework

Modifier and Type	Method	Description
void	ExampleClient.takeLeadership(CuratorFramework client)

Constructors in leader with parameters of type CuratorFramework

Modifier	Constructor	Description
	ExampleClient(CuratorFramework client, String path, String name)

Uses of CuratorFramework in locking

Constructors in locking with parameters of type CuratorFramework

Modifier	Constructor	Description
	ExampleClientThatLocks(CuratorFramework client, String lockPath, FakeLimitedResource resource, String clientName)

Uses of CuratorFramework in org.apache.curator.framework

Subinterfaces of CuratorFramework in org.apache.curator.framework

Modifier and Type	Interface	Description
interface	WatcherRemoveCuratorFramework	A CuratorFramework facade that tracks watchers created and allows a one-shot removal of all watchers

Methods in org.apache.curator.framework that return CuratorFramework

Modifier and Type	Method	Description
CuratorFramework	CuratorFrameworkFactory.Builder.build()	Apply the current values and build a new CuratorFramework
static CuratorFramework	CuratorFrameworkFactory.newClient(String connectString, int sessionTimeoutMs, int connectionTimeoutMs, RetryPolicy retryPolicy)	Create a new client
static CuratorFramework	CuratorFrameworkFactory.newClient(String connectString, int sessionTimeoutMs, int connectionTimeoutMs, RetryPolicy retryPolicy, org.apache.zookeeper.client.ZKClientConfig zkClientConfig)	Create a new client
static CuratorFramework	CuratorFrameworkFactory.newClient(String connectString, RetryPolicy retryPolicy)	Create a new client with default session timeout and default connection timeout
CuratorFramework	CuratorFramework.nonNamespaceView()	Deprecated. Since 2.9.0 - use usingNamespace(java.lang.String) passing null
CuratorFramework	CuratorFramework.usingNamespace(String newNamespace)	Returns a facade of the current instance that uses the specified namespace or no namespace if newNamespace is null.

Constructors in org.apache.curator.framework with parameters of type CuratorFramework

Modifier	Constructor	Description
	EnsureContainers(CuratorFramework client, String path)

Uses of CuratorFramework in org.apache.curator.framework.api

Methods in org.apache.curator.framework.api with parameters of type CuratorFramework

Modifier and Type	Method	Description
void	CuratorListener.eventReceived(CuratorFramework client, CuratorEvent event)	Called when a background task has completed or a watch has triggered
void	BackgroundCallback.processResult(CuratorFramework client, CuratorEvent event)	Called when the async background operation completes

Uses of CuratorFramework in org.apache.curator.framework.imps

Classes in org.apache.curator.framework.imps that implement CuratorFramework

Modifier and Type	Class	Description
class	CuratorFrameworkBase	This is the base class of all CuratorFrameworks, it is public for private usages (a.k.a.
final class	CuratorFrameworkImpl

Methods in org.apache.curator.framework.imps that return CuratorFramework

Modifier and Type	Method	Description
final CuratorFramework	CuratorFrameworkBase.nonNamespaceView()
CuratorFramework	CuratorFrameworkImpl.usingNamespace(String newNamespace)

Uses of CuratorFramework in org.apache.curator.framework.recipes

Methods in org.apache.curator.framework.recipes with parameters of type CuratorFramework

Modifier and Type	Method	Description
static Future<?>	AfterConnectionEstablished.execute(CuratorFramework client, Runnable runAfterConnection)	Spawns a new new background thread that will block until a connection is available and then execute the 'runAfterConnection' logic

Uses of CuratorFramework in org.apache.curator.framework.recipes.atomic

Constructors in org.apache.curator.framework.recipes.atomic with parameters of type CuratorFramework

Modifier	Constructor	Description
	DistributedAtomicInteger(CuratorFramework client, String counterPath, RetryPolicy retryPolicy)	Creates in optimistic mode only - i.e.
	DistributedAtomicInteger(CuratorFramework client, String counterPath, RetryPolicy retryPolicy, PromotedToLock promotedToLock)	Creates in mutex promotion mode.
	DistributedAtomicLong(CuratorFramework client, String counterPath, RetryPolicy retryPolicy)	Creates in optimistic mode only - i.e.
	DistributedAtomicLong(CuratorFramework client, String counterPath, RetryPolicy retryPolicy, PromotedToLock promotedToLock)	Creates in mutex promotion mode.
	DistributedAtomicValue(CuratorFramework client, String path, RetryPolicy retryPolicy)	Creates in optimistic mode only - i.e.
	DistributedAtomicValue(CuratorFramework client, String path, RetryPolicy retryPolicy, PromotedToLock promotedToLock)	Creates in mutex promotion mode.

Uses of CuratorFramework in org.apache.curator.framework.recipes.barriers

Constructors in org.apache.curator.framework.recipes.barriers with parameters of type CuratorFramework

Modifier	Constructor	Description
	DistributedBarrier(CuratorFramework client, String barrierPath)
	DistributedDoubleBarrier(CuratorFramework client, String barrierPath, int memberQty)	Creates the barrier abstraction.

Uses of CuratorFramework in org.apache.curator.framework.recipes.cache

Methods in org.apache.curator.framework.recipes.cache that return CuratorFramework

Modifier and Type	Method	Description
CuratorFramework	NodeCache.getClient()	Deprecated.

Methods in org.apache.curator.framework.recipes.cache with parameters of type CuratorFramework

Modifier and Type	Method	Description
static CuratorCacheBridgeBuilder	CuratorCache.bridgeBuilder(CuratorFramework client, String path)	Start a Curator Cache Bridge builder.
static CuratorCache	CuratorCache.build(CuratorFramework client, String path, CuratorCache.Options... options)	Return a Curator Cache for the given path with the given options using a standard storage instance
static CuratorCacheBuilder	CuratorCache.builder(CuratorFramework client, String path)	Start a Curator Cache builder
void	PathChildrenCacheListener.childEvent(CuratorFramework client, PathChildrenCacheEvent event)	Called when a change has occurred
void	TreeCacheListener.childEvent(CuratorFramework client, TreeCacheEvent event)	Called when a change has occurred
CuratorCacheListenerBuilder	CuratorCacheListenerBuilder.forPathChildrenCache(String rootPath, CuratorFramework client, PathChildrenCacheListener listener)	Bridge listener.
CuratorCacheListenerBuilder	CuratorCacheListenerBuilder.forTreeCache(CuratorFramework client, TreeCacheListener listener)	Bridge listener.
static TreeCache.Builder	TreeCache.newBuilder(CuratorFramework client, String path)	Deprecated. Create a TreeCache builder for the given client and path to configure advanced options.

Constructors in org.apache.curator.framework.recipes.cache with parameters of type CuratorFramework

Modifier	Constructor	Description
	NodeCache(CuratorFramework client, String path)	Deprecated.
	NodeCache(CuratorFramework client, String path, boolean dataIsCompressed)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, boolean cacheData)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, boolean cacheData, boolean dataIsCompressed, ExecutorService executorService)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, boolean cacheData, boolean dataIsCompressed, ThreadFactory threadFactory)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, boolean cacheData, boolean dataIsCompressed, CloseableExecutorService executorService)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, boolean cacheData, ThreadFactory threadFactory)	Deprecated.
	PathChildrenCache(CuratorFramework client, String path, PathChildrenCacheMode mode)	Deprecated. use PathChildrenCache(CuratorFramework, String, boolean) instead
	PathChildrenCache(CuratorFramework client, String path, PathChildrenCacheMode mode, ThreadFactory threadFactory)	Deprecated. use PathChildrenCache(CuratorFramework, String, boolean, ThreadFactory) instead
	TreeCache(CuratorFramework client, String path)	Deprecated. Create a TreeCache for the given client and path with default options.

Uses of CuratorFramework in org.apache.curator.framework.recipes.leader

Methods in org.apache.curator.framework.recipes.leader with parameters of type CuratorFramework

Modifier and Type	Method	Description
void	LeaderSelectorListenerAdapter.stateChanged(CuratorFramework client, ConnectionState newState)
void	LeaderSelectorListener.takeLeadership(CuratorFramework client)	Called when your instance has been granted leadership.

Constructors in org.apache.curator.framework.recipes.leader with parameters of type CuratorFramework

Modifier	Constructor	Description
	LeaderLatch(CuratorFramework client, String latchPath)
	LeaderLatch(CuratorFramework client, String latchPath, String id)
	LeaderLatch(CuratorFramework client, String latchPath, String id, LeaderLatch.CloseMode closeMode)
	LeaderSelector(CuratorFramework client, String leaderPath, ExecutorService executorService, LeaderSelectorListener listener)
	LeaderSelector(CuratorFramework client, String leaderPath, ThreadFactory threadFactory, Executor executor, LeaderSelectorListener listener)	Deprecated. This constructor was poorly thought out.
	LeaderSelector(CuratorFramework client, String leaderPath, LeaderSelectorListener listener)
	LeaderSelector(CuratorFramework client, String leaderPath, CloseableExecutorService executorService, LeaderSelectorListener listener)

Uses of CuratorFramework in org.apache.curator.framework.recipes.locks

Methods in org.apache.curator.framework.recipes.locks with parameters of type CuratorFramework

Modifier and Type	Method	Description
static void	Revoker.attemptRevoke(CuratorFramework client, String path)	Utility to mark a lock for revocation.
String	LockInternalsDriver.createsTheLock(CuratorFramework client, String path, byte[] lockNodeBytes)
String	StandardLockInternalsDriver.createsTheLock(CuratorFramework client, String path, byte[] lockNodeBytes)
static Collection<String>	LockInternals.getParticipantNodes(CuratorFramework client, String basePath, String lockName, LockInternalsSorter sorter)
static List<String>	LockInternals.getSortedChildren(CuratorFramework client, String basePath, String lockName, LockInternalsSorter sorter)
PredicateResults	LockInternalsDriver.getsTheLock(CuratorFramework client, List<String> children, String sequenceNodeName, int maxLeases)
PredicateResults	StandardLockInternalsDriver.getsTheLock(CuratorFramework client, List<String> children, String sequenceNodeName, int maxLeases)

Constructors in org.apache.curator.framework.recipes.locks with parameters of type CuratorFramework

Modifier	Constructor	Description
	InterProcessMultiLock(CuratorFramework client, List<String> paths)	Creates a multi lock of InterProcessMutexs
	InterProcessMutex(CuratorFramework client, String path)
	InterProcessMutex(CuratorFramework client, String path, LockInternalsDriver driver)
	InterProcessReadWriteLock(CuratorFramework client, String basePath)
	InterProcessReadWriteLock(CuratorFramework client, String basePath, byte[] lockData)
	InterProcessSemaphore(CuratorFramework client, String path, int maxLeases)	Deprecated.
	InterProcessSemaphore(CuratorFramework client, String path, SharedCountReader count)	Deprecated.
	InterProcessSemaphoreMutex(CuratorFramework client, String path)
	InterProcessSemaphoreV2(CuratorFramework client, String path, int maxLeases)
	InterProcessSemaphoreV2(CuratorFramework client, String path, SharedCountReader count)
	ReadLock(CuratorFramework client, String basePath, byte[] lockData, InterProcessReadWriteLock.WriteLock writeLock)
	WriteLock(CuratorFramework client, String basePath, byte[] lockData)

Uses of CuratorFramework in org.apache.curator.framework.recipes.nodes

Constructors in org.apache.curator.framework.recipes.nodes with parameters of type CuratorFramework

Modifier	Constructor	Description
	GroupMember(CuratorFramework client, String membershipPath, String thisId)
	GroupMember(CuratorFramework client, String membershipPath, String thisId, byte[] payload)
	PersistentEphemeralNode(CuratorFramework client, PersistentEphemeralNode.Mode mode, String basePath, byte[] initData)	Deprecated.
	PersistentNode(CuratorFramework givenClient, org.apache.zookeeper.CreateMode mode, boolean useProtection, String basePath, byte[] initData)
	PersistentNode(CuratorFramework givenClient, org.apache.zookeeper.CreateMode mode, boolean useProtection, String basePath, byte[] initData, boolean useParentCreation)
	PersistentNode(CuratorFramework givenClient, org.apache.zookeeper.CreateMode mode, boolean useProtection, String basePath, byte[] initData, long ttl, boolean useParentCreation)
	PersistentTtlNode(CuratorFramework client, String path, long ttlMs, byte[] initData)
	PersistentTtlNode(CuratorFramework client, String path, long ttlMs, byte[] initData, boolean useParentCreation)
	PersistentTtlNode(CuratorFramework client, ScheduledExecutorService executorService, String path, long ttlMs, byte[] initData, String childNodeName, int touchScheduleFactor)
	PersistentTtlNode(CuratorFramework client, ScheduledExecutorService executorService, String path, long ttlMs, byte[] initData, String childNodeName, int touchScheduleFactor, boolean useParentCreation)

Uses of CuratorFramework in org.apache.curator.framework.recipes.queue

Methods in org.apache.curator.framework.recipes.queue with parameters of type CuratorFramework

Modifier and Type	Method	Description
T	QueueAllocator.allocateQueue(CuratorFramework client, String queuePath)
static <T> QueueBuilder<T>	QueueBuilder.builder(CuratorFramework client, QueueConsumer<T> consumer, QueueSerializer<T> serializer, String queuePath)	Allocate a new builder
void	BlockingQueueConsumer.stateChanged(CuratorFramework client, ConnectionState newState)

Constructors in org.apache.curator.framework.recipes.queue with parameters of type CuratorFramework

Modifier	Constructor	Description
	QueueSharder(CuratorFramework client, QueueAllocator<U,T> queueAllocator, String queuePath, String leaderPath, QueueSharderPolicies policies)
	SimpleDistributedQueue(CuratorFramework client, String path)

Uses of CuratorFramework in org.apache.curator.framework.recipes.shared

Constructors in org.apache.curator.framework.recipes.shared with parameters of type CuratorFramework

Modifier	Constructor	Description
	SharedCount(CuratorFramework client, String path, int seedValue)
protected	SharedCount(CuratorFramework client, String path, SharedValue sv)
	SharedValue(CuratorFramework client, String path, byte[] seedValue)

Uses of CuratorFramework in org.apache.curator.framework.recipes.watch

Constructors in org.apache.curator.framework.recipes.watch with parameters of type CuratorFramework

Modifier	Constructor	Description
	PersistentWatcher(CuratorFramework client, String basePath, boolean recursive)

Uses of CuratorFramework in org.apache.curator.framework.schema

Methods in org.apache.curator.framework.schema with parameters of type CuratorFramework

Modifier and Type	Method	Description
static String	SchemaSet.getNamedPath(CuratorFramework client, String name)	Utility to return a ZNode path for the given name

Uses of CuratorFramework in org.apache.curator.framework.state

Methods in org.apache.curator.framework.state with parameters of type CuratorFramework

Modifier and Type	Method	Description
UnaryListenerManager<ConnectionStateListener>	ConnectionStateListenerManagerFactory.newManager(CuratorFramework client)	Create a new listener manager
void	CircuitBreakingConnectionStateListener.stateChanged(CuratorFramework client, ConnectionState newState)
void	ConnectionStateListener.stateChanged(CuratorFramework client, ConnectionState newState)	Called when there is a state change in the connection

Constructors in org.apache.curator.framework.state with parameters of type CuratorFramework

Modifier	Constructor	Description
	CircuitBreakingConnectionStateListener(CuratorFramework client, ConnectionStateListener listener, RetryPolicy retryPolicy)
	CircuitBreakingConnectionStateListener(CuratorFramework client, ConnectionStateListener listener, RetryPolicy retryPolicy, ScheduledExecutorService service)
	ConnectionStateManager(CuratorFramework client, ThreadFactory threadFactory, int sessionTimeoutMs, int sessionExpirationPercent)
	ConnectionStateManager(CuratorFramework client, ThreadFactory threadFactory, int sessionTimeoutMs, int sessionExpirationPercent, ConnectionStateListenerManagerFactory managerFactory)

Uses of CuratorFramework in org.apache.curator.x.async

Methods in org.apache.curator.x.async that return CuratorFramework

Modifier and Type	Method	Description
CuratorFramework	AsyncCuratorFramework.unwrap()	Returns the client that was originally passed to AsyncCuratorFramework.wrap(org.apache.curator.framework.CuratorFramework)

Methods in org.apache.curator.x.async with parameters of type CuratorFramework

Modifier and Type	Method	Description
static AsyncCuratorFramework	AsyncCuratorFramework.wrap(CuratorFramework client)	Takes an old-style Curator instance and returns a new async instance that wraps it.

Uses of CuratorFramework in org.apache.curator.x.async.details

Methods in org.apache.curator.x.async.details that return CuratorFramework

Modifier and Type	Method	Description
CuratorFramework	AsyncCuratorFrameworkImpl.unwrap()

Constructors in org.apache.curator.x.async.details with parameters of type CuratorFramework

Modifier	Constructor	Description
	AsyncCuratorFrameworkImpl(CuratorFramework client)

Uses of CuratorFramework in org.apache.curator.x.discovery

Methods in org.apache.curator.x.discovery with parameters of type CuratorFramework

Modifier and Type	Method	Description
ServiceDiscoveryBuilder<T>	ServiceDiscoveryBuilder.client(CuratorFramework client)	Required - set the client to use

Uses of CuratorFramework in org.apache.curator.x.discovery.details

Methods in org.apache.curator.x.discovery.details with parameters of type CuratorFramework

Modifier and Type	Method	Description
void	ServiceCacheImpl.childEvent(CuratorFramework client, PathChildrenCacheEvent event)

Constructors in org.apache.curator.x.discovery.details with parameters of type CuratorFramework

Modifier	Constructor	Description
	ServiceDiscoveryImpl(CuratorFramework client, String basePath, InstanceSerializer<T> serializer, ServiceInstance<T> thisInstance, boolean watchInstances)
	ServiceDiscoveryImpl(CuratorFramework client, DiscoveryPathConstructor pathConstructor, InstanceSerializer<T> serializer, ServiceInstance<T> thisInstance, boolean watchInstances)