com.github.zkclient

接口 IZkClient

所有超级接口:

AutoCloseable, Closeable

所有已知实现类:

ZkClient

public interface IZkClient
extends Closeable

zookeeper client wrapper

从以下版本开始:

2.0

作者:

adyliu (imxylz@gmail.com)

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	IZkClient.DataUpdater A CAS operation

字段概要

字段

限定符和类型	字段和说明
static int	DEFAULT_CONNECTION_TIMEOUT
static int	DEFAULT_SESSION_TIMEOUT

方法概要

限定符和类型	方法和说明
void	cas(String path, IZkClient.DataUpdater updater) Updates data of an existing znode.
void	close() Close the client.
void	connect(long timeout, 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
List<String>	getChildren(String path) get the children for the node
long	getCreationTime(String path) get the node creation time (unix milliseconds)
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
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
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
org.apache.zookeeper.data.Stat	writeData(String path, byte[] data) write the data for the node
org.apache.zookeeper.data.Stat	writeData(String path, byte[] data, int expectedVersion) write the data for the node

字段详细资料

DEFAULT_CONNECTION_TIMEOUT

static final int DEFAULT_CONNECTION_TIMEOUT

另请参阅:

常量字段值

DEFAULT_SESSION_TIMEOUT

static final int DEFAULT_SESSION_TIMEOUT

另请参阅:

常量字段值

方法详细资料

close

void close()

Close the client.

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Closeable

抛出:

ZkInterruptedException - if interrupted while closing

connect

void connect(long timeout,
             org.apache.zookeeper.Watcher watcher)

Connect to ZooKeeper.

参数:

timeout - max waiting time(ms) until connected

watcher - default watcher

抛出:

ZkInterruptedException - if the connection timed out due to thread interruption

ZkTimeoutException - if the connection timed out

IllegalStateException - if the connection timed out due to thread interruption

countChildren

int countChildren(String path)

Counts number of children for the given path.

参数:

path - zk path

返回:

number of children or 0 if path does not exist.

create

String create(String path,
              byte[] data,
              org.apache.zookeeper.CreateMode mode)

Create a node.

参数:

path - zk path

data - node data

mode - create mode CreateMode

返回:

created path

抛出:

IllegalArgumentException - if called from anything except the ZooKeeper event thread

ZkException - if any ZooKeeper exception occurred

createEphemeral

void createEphemeral(String path)

Create an ephemeral node with empty data

参数:

path - zk path

抛出:

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

createEphemeral

void createEphemeral(String path,
                     byte[] data)

Create an ephemeral node.

参数:

path - the path for the node

data - node data

抛出:

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

createEphemeralSequential

String createEphemeralSequential(String path,
                                 byte[] data)

Create an ephemeral, sequential node.

参数:

path - the path for the node

data - the data for the node

返回:

created path

抛出:

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

createPersistent

void createPersistent(String path)

Create a persistent node with empty data (null)

参数:

path - the path for the node

抛出:

ZkNodeExistsException - if the node exists

ZkNoNodeException - if the parent node not exists

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 - any other exception

另请参阅:

createPersistent(String, boolean)

createPersistent

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.

参数:

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

抛出:

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 - any other exception

createPersistent

void createPersistent(String path,
                      byte[] data)

Create a persistent node.

参数:

path - the path for the node

data - node data

抛出:

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 - any other exception

createPersistentSequential

String createPersistentSequential(String path,
                                  byte[] data)

Create a persistent, sequental node.

参数:

path - the path for the node

data - node data

返回:

create node's path

抛出:

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 - any other exception

delete

boolean delete(String path)

delete a node

参数:

path - the path for the node

返回:

true if deleted; otherwise false

deleteRecursive

boolean deleteRecursive(String path)

delete a node with all children

参数:

path - the path for the node

返回:

true if all deleted; otherwise false

exists

boolean exists(String path)

check the node exists

参数:

path - the path for the node

返回:

true if the node exists

getChildren

List<String> getChildren(String path)

get the children for the node

参数:

path - the path for the node

返回:

the children node names or null (then node not exists)

getCreationTime

long getCreationTime(String path)

get the node creation time (unix milliseconds)

参数:

path - the path for the node

返回:

the unix milliseconds or -1 if node not exists

numberOfListeners

int numberOfListeners()

all watcher number in this connection

返回:

watcher number

readData

byte[] readData(String path)

read the data for the node

参数:

path - the path for the node

返回:

the data for the node

抛出:

ZkNoNodeException - if the node not exists

另请参阅:

readData(String, boolean)

readData

byte[] readData(String path,
                boolean returnNullIfPathNotExists)

read the data for the node

参数:

path - the path for the node

returnNullIfPathNotExists - if true no ZkNoNodeException thrown

返回:

the data for the node

readData

byte[] readData(String path,
                org.apache.zookeeper.data.Stat stat)

read the data and stat for the node

参数:

path - the path for the node

stat - the stat for the node

返回:

the data for the node

另请参阅:

readData(String, boolean)

subscribeChildChanges

List<String> subscribeChildChanges(String path,
                                   IZkChildListener listener)

subscribe the changing for children

参数:

path - the path for the node

listener - the listener

返回:

the children list or null if the node not exists

另请参阅:

IZkChildListener

subscribeDataChanges

void subscribeDataChanges(String path,
                          IZkDataListener listener)

subscribe the data changing for the node

参数:

path - the path for the node

listener - the data changing listener

另请参阅:

IZkDataListener

subscribeStateChanges

void subscribeStateChanges(IZkStateListener listener)

subscribe the connection state

参数:

listener - the connection listener

另请参阅:

IZkStateListener

unsubscribeAll

void unsubscribeAll()

unsubscribe all listeners for all path and connection state

unsubscribeChildChanges

void unsubscribeChildChanges(String path,
                             IZkChildListener childListener)

unsubscribe the child listener

参数:

path - the path for the node

childListener - the listener

unsubscribeDataChanges

void unsubscribeDataChanges(String path,
                            IZkDataListener dataListener)

unsubscribe the data changing for the node

参数:

path - the path for the node

dataListener - the data changing listener

unsubscribeStateChanges

void unsubscribeStateChanges(IZkStateListener stateListener)

unsubscribe the connection state

参数:

stateListener - the connection listener

cas

void cas(String path,
         IZkClient.DataUpdater updater)

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.

参数:

path - the path for the node

updater - Updater that creates the new contents.

waitForKeeperState

boolean waitForKeeperState(org.apache.zookeeper.Watcher.Event.KeeperState keeperState,
                           long time,
                           TimeUnit timeUnit)

wait some time for the state

参数:

keeperState - the state

time - some time

timeUnit - the time unit

返回:

true if the connection state is the keeperState before the end time

waitUntilConnected

boolean waitUntilConnected()
                    throws ZkInterruptedException

wait for the connected state.

     waitForKeeperState(KeeperState.SyncConnected, Integer.MAX_VALUE, TimeUnit.MILLISECONDS);
 

返回:

true if the client connects the server

抛出:

ZkInterruptedException - the thread was interrupted

另请参阅:

waitForKeeperState(org.apache.zookeeper.Watcher.Event.KeeperState, long, java.util.concurrent.TimeUnit)

waitUntilConnected

boolean waitUntilConnected(long time,
                           TimeUnit timeUnit)

wait for the connected state

参数:

time - soem time

timeUnit - the time unit

返回:

true if the client connects the server before the end time

waitUntilExists

boolean waitUntilExists(String path,
                        TimeUnit timeUnit,
                        long time)

wait some unit until the node exists

参数:

path - the path for the node

timeUnit - the time unit

time - some time

返回:

true if the node exists

writeData

org.apache.zookeeper.data.Stat writeData(String path,
                                         byte[] data)

write the data for the node

参数:

path - the path for the node

data - the data for the node

返回:

the stat for the node

writeData

org.apache.zookeeper.data.Stat writeData(String path,
                                         byte[] data,
                                         int expectedVersion)

write the data for the node

参数:

path - the path for the node

data - the data for the node

expectedVersion - the version for the node

返回:

the stat for the node

另请参阅:

cas(String, com.github.zkclient.IZkClient.DataUpdater)

multi

List<?> multi(Iterable<?> ops)

multi operation for zookeeper 3.4.x

参数:

ops - operations

返回:

op result

另请参阅:

ZooKeeper.multi(Iterable), Op, OpResult

getZooKeeper

org.apache.zookeeper.ZooKeeper getZooKeeper()

get the inner zookeeper client

返回:

the inner zookeeper client

isConnected

boolean isConnected()

check the connecting state of zookeeper client

返回:

true if connected