CuratorFramework (Curator Framework 4.0.1 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Subinterfaces:

WatcherRemoveCuratorFramework

All Known Implementing Classes:

CuratorFrameworkImpl
```
public interface CuratorFramework
extends java.io.Closeable
```
Zookeeper framework-style client

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`blockUntilConnected()`	Block until a connection to ZooKeeper is available.
`boolean`	`blockUntilConnected(int maxWaitTime, java.util.concurrent.TimeUnit units)`	Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded
`ExistsBuilder`	`checkExists()`	Start an exists builder
`void`	`clearWatcherReferences(org.apache.zookeeper.Watcher watcher)`	Deprecated. As of ZooKeeper 3.5 Curators recipes will handle removing watcher references when they are no longer used. If you write your own recipe, follow the example of Curator recipes and use `newWatcherRemoveCuratorFramework()` calling `WatcherRemoveCuratorFramework.removeWatchers()` when closing your instance.
`void`	`close()`	Stop the client
`CreateBuilder`	`create()`	Start a create builder
`void`	`createContainers(java.lang.String path)`	Create all nodes in the specified path as containers if they don't already exist
`DeleteBuilder`	`delete()`	Start a delete builder
`GetACLBuilder`	`getACL()`	Start a get ACL builder
`GetChildrenBuilder`	`getChildren()`	Start a get children builder
`GetConfigBuilder`	`getConfig()`	Start a getConfig builder
`ConnectionStateErrorPolicy`	`getConnectionStateErrorPolicy()`	Return the configured error policy
`Listenable<ConnectionStateListener>`	`getConnectionStateListenable()`	Returns the listenable interface for the Connect State
`Listenable<CuratorListener>`	`getCuratorListenable()`	Returns the listenable interface for events
`org.apache.zookeeper.server.quorum.flexible.QuorumVerifier`	`getCurrentConfig()`	Current maintains a cached view of the Zookeeper quorum config.
`GetDataBuilder`	`getData()`	Start a get data builder
`java.lang.String`	`getNamespace()`	Return the current namespace or "" if none
`SchemaSet`	`getSchemaSet()`	Return this instance's schema set
`CuratorFrameworkState`	`getState()`	Returns the state of this instance
`Listenable<UnhandledErrorListener>`	`getUnhandledErrorListenable()`	Returns the listenable interface for unhandled errors
`org.apache.curator.CuratorZookeeperClient`	`getZookeeperClient()`	Return the managed zookeeper client
`CuratorTransaction`	`inTransaction()`	Deprecated. use `transaction()` instead
`boolean`	`isStarted()`	Deprecated. use `getState()` instead
`boolean`	`isZk34CompatibilityMode()`	Return true if this instance is running in ZK 3.4.x compatibility mode
`org.apache.curator.utils.EnsurePath`	`newNamespaceAwareEnsurePath(java.lang.String path)`	Deprecated. Since 2.9.0 - prefer `CreateBuilderMain.creatingParentContainersIfNeeded()`, `ExistsBuilder.creatingParentContainersIfNeeded()` or `createContainers(String)`
`WatcherRemoveCuratorFramework`	`newWatcherRemoveCuratorFramework()`	Returns a facade of the current instance that tracks watchers created and allows a one-shot removal of all watchers via `WatcherRemoveCuratorFramework.removeWatchers()`
`CuratorFramework`	`nonNamespaceView()`	Deprecated. Since 2.9.0 - use `usingNamespace(java.lang.String)` passing `null`
`ReconfigBuilder`	`reconfig()`	Start a reconfig builder
`SetACLBuilder`	`setACL()`	Start a set ACL builder
`SetDataBuilder`	`setData()`	Start a set data builder
`void`	`start()`	Start the client.
`SyncBuilder`	`sync()`	Start a sync builder.
`void`	`sync(java.lang.String path, java.lang.Object backgroundContextObject)`	Deprecated. use `sync()` instead
`CuratorMultiTransaction`	`transaction()`	Start a transaction builder
`TransactionOp`	`transactionOp()`	Allocate an operation that can be used with `transaction()`.
`CuratorFramework`	`usingNamespace(java.lang.String newNamespace)`	Returns a facade of the current instance that uses the specified namespace or no namespace if `newNamespace` is `null`.
`RemoveWatchesBuilder`	`watches()`	Start a remove watches builder.

- Method Detail
  - start
```
void start()
```
    Start the client. Most mutator methods will not work until the client is started
  - close
```
void close()
```
    Stop the client
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
  - getState
```
CuratorFrameworkState getState()
```
    Returns the state of this instance
    
    Returns:
    
    state
  - isStarted
```
@Deprecated
boolean isStarted()
```
    Deprecated. use getState() instead
    
    Return true if the client is started, not closed, etc.
    
    Returns:
    
    true/false
  - create
```
CreateBuilder create()
```
    Start a create builder
    
    Returns:
    
    builder object
  - delete
```
DeleteBuilder delete()
```
    Start a delete builder
    
    Returns:
    
    builder object
  - checkExists
```
ExistsBuilder checkExists()
```
    Start an exists builder
    The builder will return a Stat object as if org.apache.zookeeper.ZooKeeper.exists() were called. Thus, a null means that it does not exist and an actual Stat object means it does exist.
    
    Returns:
    
    builder object
  - getData
```
GetDataBuilder getData()
```
    Start a get data builder
    
    Returns:
    
    builder object
  - setData
```
SetDataBuilder setData()
```
    Start a set data builder
    
    Returns:
    
    builder object
  - getChildren
```
GetChildrenBuilder getChildren()
```
    Start a get children builder
    
    Returns:
    
    builder object
  - getACL
```
GetACLBuilder getACL()
```
    Start a get ACL builder
    
    Returns:
    
    builder object
  - setACL
```
SetACLBuilder setACL()
```
    Start a set ACL builder
    
    Returns:
    
    builder object
  - reconfig
```
ReconfigBuilder reconfig()
```
    Start a reconfig builder
    
    Returns:
    
    builder object
  - getConfig
```
GetConfigBuilder getConfig()
```
    Start a getConfig builder
    
    Returns:
    
    builder object
  - inTransaction
```
CuratorTransaction inTransaction()
```
    Deprecated. use transaction() instead
    
    Start a transaction builder
    
    Returns:
    
    builder object
  - transaction
```
CuratorMultiTransaction transaction()
```
    Start a transaction builder
    
    Returns:
    
    builder object
  - transactionOp
```
TransactionOp transactionOp()
```
    Allocate an operation that can be used with transaction(). NOTE: CuratorOp instances created by this builder are reusable.
    
    Returns:
    
    operation builder
  - sync
```
@Deprecated
void sync(java.lang.String path,
          java.lang.Object backgroundContextObject)
```
    Deprecated. use sync() instead
    
    Perform a sync on the given path - syncs are always in the background
    
    Parameters:
    
    path - the path
    
    backgroundContextObject - optional context
  - createContainers
```
void createContainers(java.lang.String path)
               throws java.lang.Exception
```
    Create all nodes in the specified path as containers if they don't already exist
    
    Parameters:
    
    path - path to create
    
    Throws:
    
    java.lang.Exception - errors
  - sync
```
SyncBuilder sync()
```
    Start a sync builder. Note: sync is ALWAYS in the background even if you don't use one of the background() methods
    
    Returns:
    
    builder object
  - watches
```
RemoveWatchesBuilder watches()
```
    Start a remove watches builder.
    
    Returns:
    
    builder object
  - getConnectionStateListenable
```
Listenable<ConnectionStateListener> getConnectionStateListenable()
```
    Returns the listenable interface for the Connect State
    
    Returns:
    
    listenable
  - getCuratorListenable
```
Listenable<CuratorListener> getCuratorListenable()
```
    Returns the listenable interface for events
    
    Returns:
    
    listenable
  - getUnhandledErrorListenable
```
Listenable<UnhandledErrorListener> getUnhandledErrorListenable()
```
    Returns the listenable interface for unhandled errors
    
    Returns:
    
    listenable
  - nonNamespaceView
```
@Deprecated
CuratorFramework nonNamespaceView()
```
    Deprecated. Since 2.9.0 - use usingNamespace(java.lang.String) passing null
    
    Returns a facade of the current instance that does _not_ automatically pre-pend the namespace to all paths
    
    Returns:
    
    facade
  - usingNamespace
```
CuratorFramework usingNamespace(java.lang.String newNamespace)
```
    Returns a facade of the current instance that uses the specified namespace or no namespace if newNamespace is null.
    
    Parameters:
    
    newNamespace - the new namespace or null for none
    
    Returns:
    
    facade
  - getNamespace
```
java.lang.String getNamespace()
```
    Return the current namespace or "" if none
    
    Returns:
    
    namespace
  - getZookeeperClient
```
org.apache.curator.CuratorZookeeperClient getZookeeperClient()
```
    Return the managed zookeeper client
    
    Returns:
    
    client
  - newNamespaceAwareEnsurePath
```
@Deprecated
org.apache.curator.utils.EnsurePath newNamespaceAwareEnsurePath(java.lang.String path)
```
    Deprecated. Since 2.9.0 - prefer CreateBuilderMain.creatingParentContainersIfNeeded(), ExistsBuilder.creatingParentContainersIfNeeded() or createContainers(String)
    
    Allocates an ensure path instance that is namespace aware
    
    Parameters:
    
    path - path to ensure
    
    Returns:
    
    new EnsurePath instance
  - clearWatcherReferences
```
@Deprecated
void clearWatcherReferences(org.apache.zookeeper.Watcher watcher)
```
    Deprecated. As of ZooKeeper 3.5 Curators recipes will handle removing watcher references when they are no longer used. If you write your own recipe, follow the example of Curator recipes and use newWatcherRemoveCuratorFramework() calling WatcherRemoveCuratorFramework.removeWatchers() when closing your instance.
    
    Curator can hold internal references to watchers that may inhibit garbage collection. Call this method on watchers you are no longer interested in.
    
    Parameters:
    
    watcher - the watcher
  - blockUntilConnected
```
boolean blockUntilConnected(int maxWaitTime,
                            java.util.concurrent.TimeUnit units)
                     throws java.lang.InterruptedException
```
    Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded
    
    Parameters:
    
    maxWaitTime - The maximum wait time. Specify a value <= 0 to wait indefinitely
    
    units - The time units for the maximum wait time.
    
    Returns:
    
    True if connection has been established, false otherwise.
    
    Throws:
    
    java.lang.InterruptedException - If interrupted while waiting
  - blockUntilConnected
```
void blockUntilConnected()
                  throws java.lang.InterruptedException
```
    Block until a connection to ZooKeeper is available. This method will not return until a connection is available or it is interrupted, in which case an InterruptedException will be thrown
    
    Throws:
    
    java.lang.InterruptedException - If interrupted while waiting
  - newWatcherRemoveCuratorFramework
```
WatcherRemoveCuratorFramework newWatcherRemoveCuratorFramework()
```
    Returns a facade of the current instance that tracks watchers created and allows a one-shot removal of all watchers via WatcherRemoveCuratorFramework.removeWatchers()
    
    Returns:
    
    facade
  - getConnectionStateErrorPolicy
```
ConnectionStateErrorPolicy getConnectionStateErrorPolicy()
```
    Return the configured error policy
    
    Returns:
    
    error policy
  - getCurrentConfig
```
org.apache.zookeeper.server.quorum.flexible.QuorumVerifier getCurrentConfig()
```
    Current maintains a cached view of the Zookeeper quorum config.
    
    Returns:
    
    the current config
  - getSchemaSet
```
SchemaSet getSchemaSet()
```
    Return this instance's schema set
    
    Returns:
    
    schema set
  - isZk34CompatibilityMode
```
boolean isZk34CompatibilityMode()
```
    Return true if this instance is running in ZK 3.4.x compatibility mode
    
    Returns:
    
    true/false

Interface CuratorFramework

Method Summary

Method Detail

start

close

getState

isStarted

create

delete

checkExists

getData

setData

getChildren

getACL

setACL

reconfig

getConfig

inTransaction

transaction

transactionOp

sync

createContainers

sync

watches

getConnectionStateListenable

getCuratorListenable

getUnhandledErrorListenable

nonNamespaceView

usingNamespace

getNamespace

getZookeeperClient

newNamespaceAwareEnsurePath

clearWatcherReferences

blockUntilConnected

blockUntilConnected

newWatcherRemoveCuratorFramework

getConnectionStateErrorPolicy

getCurrentConfig

getSchemaSet

isZk34CompatibilityMode