com.spotify.helios.servicescommon.coordination

Interface ZooKeeperClient

All Known Implementing Classes:

DefaultZooKeeperClient, ReportingZooKeeperClient

public interface ZooKeeperClient

Exists because the Curator library makes things ununit-testable without this. Also it avoids having to catch Exception at call-sites.

Method Summary

Modifier and Type	Method and Description
void	close()
void	create(String path)
void	createAndSetData(String path, byte[] data)
void	createWithMode(String path, org.apache.zookeeper.CreateMode mode)
void	delete(String path)
void	delete(String path, int version)
void	deleteRecursive(String path)
void	ensurePath(String path)
void	ensurePath(String path, boolean excludingLast)
void	ensurePathAndSetData(String path, byte[] data) Ensure a path exists.
org.apache.zookeeper.data.Stat	exists(String path)
List<org.apache.zookeeper.data.ACL>	getAcl(String path)
List<String>	getChildren(String path)
org.apache.curator.framework.listen.Listenable<org.apache.curator.framework.state.ConnectionStateListener>	getConnectionStateListenable()
org.apache.curator.framework.CuratorFramework	getCuratorFramework()
byte[]	getData(String path)
Node	getNode(String path)
org.apache.zookeeper.ZooKeeper.States	getState()
List<String>	listRecursive(String path)
<T> PersistentPathChildrenCache<T>	pathChildrenCache(String path, Path snapshotFile, com.fasterxml.jackson.databind.JavaType valueType)
org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode	persistentEphemeralNode(String path, org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode mode, byte[] data)
void	setAcl(String path, List<org.apache.zookeeper.data.ACL> aclList)
void	setData(String path, byte[] bytes)
void	start()
org.apache.zookeeper.data.Stat	stat(String path)
Collection<org.apache.curator.framework.api.transaction.CuratorTransactionResult>	transaction(List<ZooKeeperOperation> operations)
Collection<org.apache.curator.framework.api.transaction.CuratorTransactionResult>	transaction(ZooKeeperOperation... operations)

Method Detail

ensurePath

void ensurePath(String path)
         throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

ensurePath

void ensurePath(String path,
                boolean excludingLast)
         throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

ensurePathAndSetData

void ensurePathAndSetData(String path,
                          byte[] data)
                   throws org.apache.zookeeper.KeeperException

Ensure a path exists. Any node in the path that does not exist will be created. If the base of the path does not exist it will be created with the supplied data.

Parameters:

path - The path to ensure exists.

data - The data to write at the base of the path, if it does not exist.

Throws:

org.apache.zookeeper.KeeperException

getData

byte[] getData(String path)
        throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

getChildren

List<String> getChildren(String path)
                  throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

delete

void delete(String path)
     throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

delete

void delete(String path,
            int version)
     throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

setData

void setData(String path,
             byte[] bytes)
      throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

createAndSetData

void createAndSetData(String path,
                      byte[] data)
               throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

createWithMode

void createWithMode(String path,
                    org.apache.zookeeper.CreateMode mode)
             throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

stat

org.apache.zookeeper.data.Stat stat(String path)
                             throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

deleteRecursive

void deleteRecursive(String path)
              throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

listRecursive

List<String> listRecursive(String path)
                    throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

create

void create(String path)
     throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

pathChildrenCache

<T> PersistentPathChildrenCache<T> pathChildrenCache(String path,
                                                     Path snapshotFile,
                                                     com.fasterxml.jackson.databind.JavaType valueType)
                                              throws IOException,
                                                     InterruptedException

Throws:

IOException

InterruptedException

transaction

Collection<org.apache.curator.framework.api.transaction.CuratorTransactionResult> transaction(List<ZooKeeperOperation> operations)
                                                                                       throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

transaction

Collection<org.apache.curator.framework.api.transaction.CuratorTransactionResult> transaction(ZooKeeperOperation... operations)
                                                                                       throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

getNode

Node getNode(String path)
      throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

exists

org.apache.zookeeper.data.Stat exists(String path)
                               throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

getConnectionStateListenable

org.apache.curator.framework.listen.Listenable<org.apache.curator.framework.state.ConnectionStateListener> getConnectionStateListenable()

getState

org.apache.zookeeper.ZooKeeper.States getState()
                                        throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

start

void start()

close

void close()

persistentEphemeralNode

org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode persistentEphemeralNode(String path,
                                                                                           org.apache.curator.framework.recipes.nodes.PersistentEphemeralNode.Mode mode,
                                                                                           byte[] data)

getCuratorFramework

org.apache.curator.framework.CuratorFramework getCuratorFramework()

setAcl

void setAcl(String path,
            List<org.apache.zookeeper.data.ACL> aclList)
     throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException

getAcl

List<org.apache.zookeeper.data.ACL> getAcl(String path)
                                    throws org.apache.zookeeper.KeeperException

Throws:

org.apache.zookeeper.KeeperException