ZkClient (zookeeper client wrapper 2.2.0 API)

java.lang.Object
- com.github.zkclient.ZkClient

所有已实现的接口:

IZkClient, Closeable, AutoCloseable, org.apache.zookeeper.Watcher
```
public class ZkClient
extends Object
implements org.apache.zookeeper.Watcher, IZkClient
```
Zookeeper client
The client is thread-safety

嵌套类概要
- 从接口继承的嵌套类/接口 org.apache.zookeeper.Watcher
  org.apache.zookeeper.Watcher.Event
- 从接口继承的嵌套类/接口 com.github.zkclient.IZkClient
  IZkClient.DataUpdater

字段概要

字段
限定符和类型字段和说明

protected ZkConnection _connection
- 从接口继承的字段 com.github.zkclient.IZkClient
  DEFAULT_CONNECTION_TIMEOUT, DEFAULT_SESSION_TIMEOUT

字段
限定符和类型	字段和说明
`protected ZkConnection`	`_connection`

构造器概要

构造器
构造器和说明
`ZkClient(String connectString)` Create a client with default connection timeout and default session timeout
`ZkClient(String connectString, int connectionTimeout)` Create a client
`ZkClient(String connectString, int sessionTimeout, int connectionTimeout)` Create a client
`ZkClient(ZkConnection zkConnection, int connectionTimeout)` Create a client with special implementation

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`cas(String path, IZkClient.DataUpdater updater)` Updates data of an existing znode.
`void`	`close()` Close the client.
`void`	`connect(long maxMsToWaitUntilConnected, org.apache.zookeeper.Watcher watcher)` Connect to ZooKeeper.
`int`	`countChildren(String path)` Counts number of children for the given path.
`String`	`create(String path, byte[] data, org.apache.zookeeper.CreateMode mode)` Create a node.
`void`	`createEphemeral(String path)` Create an ephemeral node with empty data
`void`	`createEphemeral(String path, byte[] data)` Create an ephemeral node.
`String`	`createEphemeralSequential(String path, byte[] data)` Create an ephemeral, sequential node.
`void`	`createPersistent(String path)` Create a persistent node with empty data (null)
`void`	`createPersistent(String path, boolean createParents)` Create a persistent node with empty data (null) If the createParents is true, neither `ZkNodeExistsException` nor `ZkNoNodeException` were throwed.
`void`	`createPersistent(String path, byte[] data)` Create a persistent node.
`String`	`createPersistentSequential(String path, byte[] data)` Create a persistent, sequental node.
`boolean`	`delete(String path)` delete a node
`boolean`	`deleteRecursive(String path)` delete a node with all children
`boolean`	`exists(String path)` check the node exists
`protected boolean`	`exists(String path, boolean watch)`
`List<String>`	`getChildren(String path)` get the children for the node
`protected List<String>`	`getChildren(String path, boolean watch)`
`long`	`getCreationTime(String path)` get the node creation time (unix milliseconds)
`ZkLock`	`getEventLock()` Returns a mutex all zookeeper events are synchronized aginst.
`org.apache.zookeeper.ZooKeeper`	`getZooKeeper()` get the inner zookeeper client
`boolean`	`isConnected()` check the connecting state of zookeeper client
`List<?>`	`multi(Iterable<?> ops)` multi operation for zookeeper 3.4.x
`int`	`numberOfListeners()` all watcher number in this connection
`void`	`process(org.apache.zookeeper.WatchedEvent event)`
`byte[]`	`readData(String path)` read the data for the node
`byte[]`	`readData(String path, boolean returnNullIfPathNotExists)` read the data for the node
`byte[]`	`readData(String path, org.apache.zookeeper.data.Stat stat)` read the data and stat for the node
`protected byte[]`	`readData(String path, org.apache.zookeeper.data.Stat stat, boolean watch)`
`<E> E`	`retryUntilConnected(Callable<E> callable)`
`void`	`setCurrentState(org.apache.zookeeper.Watcher.Event.KeeperState currentState)`
`List<String>`	`subscribeChildChanges(String path, IZkChildListener listener)` subscribe the changing for children
`void`	`subscribeDataChanges(String path, IZkDataListener listener)` subscribe the data changing for the node
`void`	`subscribeStateChanges(IZkStateListener listener)` subscribe the connection state
`void`	`unsubscribeAll()` unsubscribe all listeners for all path and connection state
`void`	`unsubscribeChildChanges(String path, IZkChildListener childListener)` unsubscribe the child listener
`void`	`unsubscribeDataChanges(String path, IZkDataListener dataListener)` unsubscribe the data changing for the node
`void`	`unsubscribeStateChanges(IZkStateListener stateListener)` unsubscribe the connection state
`boolean`	`waitForKeeperState(org.apache.zookeeper.Watcher.Event.KeeperState keeperState, long time, TimeUnit timeUnit)` wait some time for the state
`boolean`	`waitUntilConnected()` wait for the connected state.
`boolean`	`waitUntilConnected(long time, TimeUnit timeUnit)` wait for the connected state
`boolean`	`waitUntilExists(String path, TimeUnit timeUnit, long time)` wait some unit until the node exists
`List<String>`	`watchForChilds(String path)`
`void`	`watchForData(String path)`
`org.apache.zookeeper.data.Stat`	`writeData(String path, byte[] object)` write the data for the node
`org.apache.zookeeper.data.Stat`	`writeData(String path, byte[] data, int expectedVersion)` write the data for the node

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - _connection
```
protected ZkConnection _connection
```
- 构造器详细资料
  - ZkClient
```
public ZkClient(String connectString)
```
    Create a client with default connection timeout and default session timeout
    
    参数:
    
    connectString - zookeeper connection string comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If the optional chroot suffix is used the example would look like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" where the client would be rooted at "/app/a" and all paths would be relative to this root - ie getting/setting/etc... "/foo/bar" would result in operations being run on "/app/a/foo/bar" (from the server perspective).
    
    另请参阅:
    
    IZkClient.DEFAULT_CONNECTION_TIMEOUT, IZkClient.DEFAULT_SESSION_TIMEOUT
  - ZkClient
```
public ZkClient(String connectString,
                int connectionTimeout)
```
    Create a client
    
    参数:
    
    connectString - zookeeper connection string comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If the optional chroot suffix is used the example would look like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" where the client would be rooted at "/app/a" and all paths would be relative to this root - ie getting/setting/etc... "/foo/bar" would result in operations being run on "/app/a/foo/bar" (from the server perspective).
    
    connectionTimeout - connection timeout in milliseconds
  - ZkClient
```
public ZkClient(String connectString,
                int sessionTimeout,
                int connectionTimeout)
```
    Create a client
    
    参数:
    
    connectString - zookeeper connection string comma separated host:port pairs, each corresponding to a zk server. e.g. "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002" If the optional chroot suffix is used the example would look like: "127.0.0.1:3000,127.0.0.1:3001,127.0.0.1:3002/app/a" where the client would be rooted at "/app/a" and all paths would be relative to this root - ie getting/setting/etc... "/foo/bar" would result in operations being run on "/app/a/foo/bar" (from the server perspective).
    
    sessionTimeout - session timeout in milliseconds
    
    connectionTimeout - connection timeout in milliseconds
  - ZkClient
```
public ZkClient(ZkConnection zkConnection,
                int connectionTimeout)
```
    Create a client with special implementation
    
    参数:
    
    zkConnection - special client
    
    connectionTimeout - connection timeout in milliseconds
- 方法详细资料
  - subscribeChildChanges
```
public List<String> subscribeChildChanges(String path,
                                          IZkChildListener listener)
```
    从接口复制的说明: IZkClient
    
    subscribe the changing for children
    
    指定者:
    
    subscribeChildChanges 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    listener - the listener
    
    返回:
    
    the children list or null if the node not exists
    
    另请参阅:
    
    IZkChildListener
  - unsubscribeChildChanges
```
public void unsubscribeChildChanges(String path,
                                    IZkChildListener childListener)
```
    从接口复制的说明: IZkClient
    
    unsubscribe the child listener
    
    指定者:
    
    unsubscribeChildChanges 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    childListener - the listener
  - subscribeDataChanges
```
public void subscribeDataChanges(String path,
                                 IZkDataListener listener)
```
    从接口复制的说明: IZkClient
    
    subscribe the data changing for the node
    
    指定者:
    
    subscribeDataChanges 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    listener - the data changing listener
    
    另请参阅:
    
    IZkDataListener
  - unsubscribeDataChanges
```
public void unsubscribeDataChanges(String path,
                                   IZkDataListener dataListener)
```
    从接口复制的说明: IZkClient
    
    unsubscribe the data changing for the node
    
    指定者:
    
    unsubscribeDataChanges 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    dataListener - the data changing listener
  - subscribeStateChanges
```
public void subscribeStateChanges(IZkStateListener listener)
```
    从接口复制的说明: IZkClient
    
    subscribe the connection state
    
    指定者:
    
    subscribeStateChanges 在接口中 IZkClient
    
    参数:
    
    listener - the connection listener
    
    另请参阅:
    
    IZkStateListener
  - unsubscribeStateChanges
```
public void unsubscribeStateChanges(IZkStateListener stateListener)
```
    从接口复制的说明: IZkClient
    
    unsubscribe the connection state
    
    指定者:
    
    unsubscribeStateChanges 在接口中 IZkClient
    
    参数:
    
    stateListener - the connection listener
  - unsubscribeAll
```
public void unsubscribeAll()
```
    从接口复制的说明: IZkClient
    
    unsubscribe all listeners for all path and connection state
    
    指定者:
    
    unsubscribeAll 在接口中 IZkClient
  - createPersistent
```
public void createPersistent(String path)
```
    从接口复制的说明: IZkClient
    
    Create a persistent node with empty data (null)
    
    指定者:
    
    createPersistent 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    另请参阅:
    
    IZkClient.createPersistent(String, boolean)
  - createPersistent
```
public void createPersistent(String path,
                             boolean createParents)
```
    从接口复制的说明: IZkClient
    
    Create a persistent node with empty data (null)
    If the createParents is true, neither ZkNodeExistsException nor ZkNoNodeException were throwed.
    
    指定者:
    
    createPersistent 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    createParents - if true all parent dirs are created as well and no ZkNodeExistsException is thrown in case the path already exists
  - createPersistent
```
public void createPersistent(String path,
                             byte[] data)
```
    从接口复制的说明: IZkClient
    
    Create a persistent node.
    
    指定者:
    
    createPersistent 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    data - node data
  - createPersistentSequential
```
public String createPersistentSequential(String path,
                                         byte[] data)
```
    从接口复制的说明: IZkClient
    
    Create a persistent, sequental node.
    
    指定者:
    
    createPersistentSequential 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    data - node data
    
    返回:
    
    create node's path
  - createEphemeral
```
public void createEphemeral(String path)
```
    从接口复制的说明: IZkClient
    
    Create an ephemeral node with empty data
    
    指定者:
    
    createEphemeral 在接口中 IZkClient
    
    参数:
    
    path - zk path
  - create
```
public String create(String path,
                     byte[] data,
                     org.apache.zookeeper.CreateMode mode)
```
    从接口复制的说明: IZkClient
    
    Create a node.
    
    指定者:
    
    create 在接口中 IZkClient
    
    参数:
    
    path - zk path
    
    data - node data
    
    mode - create mode CreateMode
    
    返回:
    
    created path
  - createEphemeral
```
public void createEphemeral(String path,
                            byte[] data)
```
    从接口复制的说明: IZkClient
    
    Create an ephemeral node.
    
    指定者:
    
    createEphemeral 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    data - node data
  - createEphemeralSequential
```
public String createEphemeralSequential(String path,
                                        byte[] data)
```
    从接口复制的说明: IZkClient
    
    Create an ephemeral, sequential node.
    
    指定者:
    
    createEphemeralSequential 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    data - the data for the node
    
    返回:
    
    created path
  - process
```
public void process(org.apache.zookeeper.WatchedEvent event)
```
    指定者:
    
    process 在接口中 org.apache.zookeeper.Watcher
  - getChildren
```
public List<String> getChildren(String path)
```
    从接口复制的说明: IZkClient
    
    get the children for the node
    
    指定者:
    
    getChildren 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    the children node names or null (then node not exists)
  - getChildren
```
protected List<String> getChildren(String path,
                                   boolean watch)
```
  - countChildren
```
public int countChildren(String path)
```
    从接口复制的说明: IZkClient
    
    Counts number of children for the given path.
    
    指定者:
    
    countChildren 在接口中 IZkClient
    
    参数:
    
    path - zk path
    
    返回:
    
    number of children or 0 if path does not exist.
  - exists
```
protected boolean exists(String path,
                         boolean watch)
```
  - exists
```
public boolean exists(String path)
```
    从接口复制的说明: IZkClient
    
    check the node exists
    
    指定者:
    
    exists 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    true if the node exists
  - deleteRecursive
```
public boolean deleteRecursive(String path)
```
    从接口复制的说明: IZkClient
    
    delete a node with all children
    
    指定者:
    
    deleteRecursive 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    true if all deleted; otherwise false
  - waitUntilExists
```
public boolean waitUntilExists(String path,
                               TimeUnit timeUnit,
                               long time)
                        throws ZkInterruptedException
```
    从接口复制的说明: IZkClient
    
    wait some unit until the node exists
    
    指定者:
    
    waitUntilExists 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    timeUnit - the time unit
    
    time - some time
    
    返回:
    
    true if the node exists
    
    抛出:
    
    ZkInterruptedException
  - waitUntilConnected
```
public boolean waitUntilConnected()
                           throws ZkInterruptedException
```
    从接口复制的说明: IZkClient
    wait for the connected state.
```
     waitForKeeperState(KeeperState.SyncConnected, Integer.MAX_VALUE, TimeUnit.MILLISECONDS);
 
```
    指定者:
    
    waitUntilConnected 在接口中 IZkClient
    
    返回:
    
    true if the client connects the server
    
    抛出:
    
    ZkInterruptedException - the thread was interrupted
    
    另请参阅:
    
    IZkClient.waitForKeeperState(org.apache.zookeeper.Watcher.Event.KeeperState, long, java.util.concurrent.TimeUnit)
  - waitUntilConnected
```
public boolean waitUntilConnected(long time,
                                  TimeUnit timeUnit)
                           throws ZkInterruptedException
```
    从接口复制的说明: IZkClient
    
    wait for the connected state
    
    指定者:
    
    waitUntilConnected 在接口中 IZkClient
    
    参数:
    
    time - soem time
    
    timeUnit - the time unit
    
    返回:
    
    true if the client connects the server before the end time
    
    抛出:
    
    ZkInterruptedException
  - waitForKeeperState
```
public boolean waitForKeeperState(org.apache.zookeeper.Watcher.Event.KeeperState keeperState,
                                  long time,
                                  TimeUnit timeUnit)
                           throws ZkInterruptedException
```
    从接口复制的说明: IZkClient
    
    wait some time for the state
    
    指定者:
    
    waitForKeeperState 在接口中 IZkClient
    
    参数:
    
    keeperState - the state
    
    time - some time
    
    timeUnit - the time unit
    
    返回:
    
    true if the connection state is the keeperState before the end time
    
    抛出:
    
    ZkInterruptedException
  - retryUntilConnected
```
public <E> E retryUntilConnected(Callable<E> callable)
```
    类型参数:
    
    E - the runtime type of result
    
    参数:
    
    callable - the callable object
    
    返回:
    
    result of Callable
    
    抛出:
    
    ZkInterruptedException - if operation was interrupted, or a required reconnection got interrupted
    
    IllegalArgumentException - if called from anything except the ZooKeeper event thread
    
    ZkException - if any ZooKeeper exception occurred
    
    RuntimeException - if any other exception occurs from invoking the Callable
  - setCurrentState
```
public void setCurrentState(org.apache.zookeeper.Watcher.Event.KeeperState currentState)
```
  - getEventLock
```
public ZkLock getEventLock()
```
    Returns a mutex all zookeeper events are synchronized aginst. So in case you need to do something without getting any zookeeper event interruption synchronize against this mutex. Also all threads waiting on this mutex object will be notified on an event.
    
    返回:
    
    the mutex.
  - delete
```
public boolean delete(String path)
```
    从接口复制的说明: IZkClient
    
    delete a node
    
    指定者:
    
    delete 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    true if deleted; otherwise false
  - readData
```
public byte[] readData(String path)
```
    从接口复制的说明: IZkClient
    
    read the data for the node
    
    指定者:
    
    readData 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    the data for the node
    
    另请参阅:
    
    IZkClient.readData(String, boolean)
  - readData
```
public byte[] readData(String path,
                       boolean returnNullIfPathNotExists)
```
    从接口复制的说明: IZkClient
    
    read the data for the node
    
    指定者:
    
    readData 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    returnNullIfPathNotExists - if true no ZkNoNodeException thrown
    
    返回:
    
    the data for the node
  - readData
```
public byte[] readData(String path,
                       org.apache.zookeeper.data.Stat stat)
```
    从接口复制的说明: IZkClient
    
    read the data and stat for the node
    
    指定者:
    
    readData 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    stat - the stat for the node
    
    返回:
    
    the data for the node
    
    另请参阅:
    
    IZkClient.readData(String, boolean)
  - readData
```
protected byte[] readData(String path,
                          org.apache.zookeeper.data.Stat stat,
                          boolean watch)
```
  - writeData
```
public org.apache.zookeeper.data.Stat writeData(String path,
                                                byte[] object)
```
    从接口复制的说明: IZkClient
    
    write the data for the node
    
    指定者:
    
    writeData 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    object - the data for the node
    
    返回:
    
    the stat for the node
  - cas
```
public void cas(String path,
                IZkClient.DataUpdater updater)
```
    从接口复制的说明: IZkClient
    
    Updates data of an existing znode. The current content of the znode is passed to the IZkClient.DataUpdater that is passed into this method, which returns the new content. The new content is only written back to ZooKeeper if nobody has modified the given znode in between. If a concurrent change has been detected the new data of the znode is passed to the updater once again until the new contents can be successfully written back to ZooKeeper.
    
    指定者:
    
    cas 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    updater - Updater that creates the new contents.
  - writeData
```
public org.apache.zookeeper.data.Stat writeData(String path,
                                                byte[] data,
                                                int expectedVersion)
```
    从接口复制的说明: IZkClient
    
    write the data for the node
    
    指定者:
    
    writeData 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    data - the data for the node
    
    expectedVersion - the version for the node
    
    返回:
    
    the stat for the node
    
    另请参阅:
    
    IZkClient.cas(String, com.github.zkclient.IZkClient.DataUpdater)
  - watchForData
```
public void watchForData(String path)
```
  - watchForChilds
```
public List<String> watchForChilds(String path)
```
  - connect
```
public void connect(long maxMsToWaitUntilConnected,
                    org.apache.zookeeper.Watcher watcher)
```
    从接口复制的说明: IZkClient
    
    Connect to ZooKeeper.
    
    指定者:
    
    connect 在接口中 IZkClient
    
    参数:
    
    maxMsToWaitUntilConnected - max waiting time(ms) until connected
    
    watcher - default watcher
  - getCreationTime
```
public long getCreationTime(String path)
```
    从接口复制的说明: IZkClient
    
    get the node creation time (unix milliseconds)
    
    指定者:
    
    getCreationTime 在接口中 IZkClient
    
    参数:
    
    path - the path for the node
    
    返回:
    
    the unix milliseconds or -1 if node not exists
  - close
```
public void close()
           throws ZkInterruptedException
```
    从接口复制的说明: IZkClient
    
    Close the client.
    
    指定者:
    
    close 在接口中 IZkClient
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
    
    抛出:
    
    ZkInterruptedException - if interrupted while closing
  - numberOfListeners
```
public int numberOfListeners()
```
    从接口复制的说明: IZkClient
    
    all watcher number in this connection
    
    指定者:
    
    numberOfListeners 在接口中 IZkClient
    
    返回:
    
    watcher number
  - multi
```
public List<?> multi(Iterable<?> ops)
```
    从接口复制的说明: IZkClient
    
    multi operation for zookeeper 3.4.x
    
    指定者:
    
    multi 在接口中 IZkClient
    
    参数:
    
    ops - operations
    
    返回:
    
    op result
    
    另请参阅:
    
    ZooKeeper.multi(Iterable), Op, OpResult
  - getZooKeeper
```
public org.apache.zookeeper.ZooKeeper getZooKeeper()
```
    从接口复制的说明: IZkClient
    
    get the inner zookeeper client
    
    指定者:
    
    getZooKeeper 在接口中 IZkClient
    
    返回:
    
    the inner zookeeper client
  - isConnected
```
public boolean isConnected()
```
    从接口复制的说明: IZkClient
    
    check the connecting state of zookeeper client
    
    指定者:
    
    isConnected 在接口中 IZkClient
    
    返回:
    
    true if connected

类 ZkClient

嵌套类概要

从接口继承的嵌套类/接口 org.apache.zookeeper.Watcher

从接口继承的嵌套类/接口 com.github.zkclient.IZkClient

字段概要

从接口继承的字段 com.github.zkclient.IZkClient

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

_connection

构造器详细资料

ZkClient

ZkClient

ZkClient

ZkClient

方法详细资料

subscribeChildChanges

unsubscribeChildChanges

subscribeDataChanges

unsubscribeDataChanges

subscribeStateChanges

unsubscribeStateChanges

unsubscribeAll

createPersistent

createPersistent

createPersistent

createPersistentSequential

createEphemeral

create

createEphemeral

createEphemeralSequential

process

getChildren

getChildren

countChildren

exists

exists

deleteRecursive

waitUntilExists

waitUntilConnected

waitUntilConnected

waitForKeeperState

retryUntilConnected

setCurrentState

getEventLock

delete

readData

readData

readData

readData

writeData

cas

writeData

watchForData

watchForChilds

connect

getCreationTime

close

numberOfListeners

multi

getZooKeeper

isConnected