Package org.apache.hadoop.util.curator

Class ZKCuratorManager

java.lang.Object

org.apache.hadoop.util.curator.ZKCuratorManager

@Private
public final class ZKCuratorManager
extends java.lang.Object

Helper class that provides utility methods specific to ZK operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZKCuratorManager.HadoopZookeeperFactory
class	ZKCuratorManager.SafeTransaction	Use curator transactions to ensure zk-operations are performed in an all or nothing fashion.

Constructor Summary

Constructors

Constructor	Description
ZKCuratorManager(Configuration config)

Method Summary

Modifier and Type	Method	Description
void	close()	Close the connection with ZooKeeper.
boolean	create(java.lang.String path)	Create a ZNode.
boolean	create(java.lang.String path, java.util.List<org.apache.zookeeper.data.ACL> zkAcl)	Create a ZNode.
void	createRootDirRecursively(java.lang.String path)	Utility function to ensure that the configured base znode exists.
void	createRootDirRecursively(java.lang.String path, java.util.List<org.apache.zookeeper.data.ACL> zkAcl)	Utility function to ensure that the configured base znode exists.
ZKCuratorManager.SafeTransaction	createTransaction(java.util.List<org.apache.zookeeper.data.ACL> fencingACL, java.lang.String fencingNodePath)
boolean	delete(java.lang.String path)	Delete a ZNode.
boolean	exists(java.lang.String path)	Check if a ZNode exists.
java.util.List<org.apache.zookeeper.data.ACL>	getACL(java.lang.String path)	Get ACLs for a ZNode.
java.util.List<java.lang.String>	getChildren(java.lang.String path)	Get children of a ZNode.
org.apache.curator.framework.CuratorFramework	getCurator()	Get the curator framework managing the ZooKeeper connection.
byte[]	getData(java.lang.String path)	Get the data in a ZNode.
byte[]	getData(java.lang.String path, org.apache.zookeeper.data.Stat stat)	Get the data in a ZNode.
static java.lang.String	getNodePath(java.lang.String root, java.lang.String nodeName)	Get the path for a ZNode.
java.lang.String	getStringData(java.lang.String path)	Get the data in a ZNode.
java.lang.String	getStringData(java.lang.String path, org.apache.zookeeper.data.Stat stat)	Get the data in a ZNode.
static java.util.List<org.apache.zookeeper.data.ACL>	getZKAcls(Configuration conf)	Utility method to fetch the ZK ACLs from the configuration.
static java.util.List<ZKUtil.ZKAuthInfo>	getZKAuths(Configuration conf)	Utility method to fetch ZK auth info from the configuration.
void	safeCreate(java.lang.String path, byte[] data, java.util.List<org.apache.zookeeper.data.ACL> acl, org.apache.zookeeper.CreateMode mode, java.util.List<org.apache.zookeeper.data.ACL> fencingACL, java.lang.String fencingNodePath)
void	safeDelete(java.lang.String path, java.util.List<org.apache.zookeeper.data.ACL> fencingACL, java.lang.String fencingNodePath)	Deletes the path.
void	safeSetData(java.lang.String path, byte[] data, int version, java.util.List<org.apache.zookeeper.data.ACL> fencingACL, java.lang.String fencingNodePath)
void	setData(java.lang.String path, byte[] data, int version)	Set data into a ZNode.
void	setData(java.lang.String path, java.lang.String data, int version)	Set data into a ZNode.
void	start()	Start the connection to the ZooKeeper ensemble.
void	start(java.util.List<org.apache.curator.framework.AuthInfo> authInfos)	Start the connection to the ZooKeeper ensemble.
void	start(java.util.List<org.apache.curator.framework.AuthInfo> authInfos, boolean sslEnabled)	Start the connection to the ZooKeeper ensemble.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZKCuratorManager

public ZKCuratorManager(Configuration config)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

getCurator

public org.apache.curator.framework.CuratorFramework getCurator()

Get the curator framework managing the ZooKeeper connection.

Returns:

Curator framework.

close

public void close()

Close the connection with ZooKeeper.

getZKAcls

public static java.util.List<org.apache.zookeeper.data.ACL> getZKAcls(Configuration conf)
                                                               throws java.io.IOException

Utility method to fetch the ZK ACLs from the configuration.

Parameters:

conf - configuration.

Returns:

acl list.

Throws:

java.io.IOException - if the Zookeeper ACLs configuration file cannot be read

getZKAuths

public static java.util.List<ZKUtil.ZKAuthInfo> getZKAuths(Configuration conf)
                                                    throws java.io.IOException

Utility method to fetch ZK auth info from the configuration.

Parameters:

conf - configuration.

Returns:

ZKAuthInfo List.

Throws:

java.io.IOException - if the Zookeeper ACLs configuration file cannot be read

ZKUtil.BadAuthFormatException - if the auth format is invalid

start

public void start()
           throws java.io.IOException

Start the connection to the ZooKeeper ensemble.

Throws:

java.io.IOException - If the connection cannot be started.

start

public void start(java.util.List<org.apache.curator.framework.AuthInfo> authInfos)
           throws java.io.IOException

Start the connection to the ZooKeeper ensemble.

Parameters:

authInfos - List of authentication keys.

Throws:

java.io.IOException - If the connection cannot be started.

start

public void start(java.util.List<org.apache.curator.framework.AuthInfo> authInfos,
                  boolean sslEnabled)
           throws java.io.IOException

Start the connection to the ZooKeeper ensemble.

Parameters:

authInfos - List of authentication keys.

sslEnabled - If the connection should be SSL/TLS encrypted.

Throws:

java.io.IOException - If the connection cannot be started.

getACL

public java.util.List<org.apache.zookeeper.data.ACL> getACL(java.lang.String path)
                                                     throws java.lang.Exception

Get ACLs for a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

The list of ACLs.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

getData

public byte[] getData(java.lang.String path)
               throws java.lang.Exception

Get the data in a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

The data in the ZNode.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

getData

public byte[] getData(java.lang.String path,
                      org.apache.zookeeper.data.Stat stat)
               throws java.lang.Exception

Get the data in a ZNode.

Parameters:

path - Path of the ZNode.

stat - stat.

Returns:

The data in the ZNode.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

getStringData

public java.lang.String getStringData(java.lang.String path)
                               throws java.lang.Exception

Get the data in a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

The data in the ZNode.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

getStringData

public java.lang.String getStringData(java.lang.String path,
                                      org.apache.zookeeper.data.Stat stat)
                               throws java.lang.Exception

Get the data in a ZNode.

Parameters:

path - Path of the ZNode.

stat - Output statistics of the ZNode.

Returns:

The data in the ZNode.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

setData

public void setData(java.lang.String path,
                    byte[] data,
                    int version)
             throws java.lang.Exception

Set data into a ZNode.

Parameters:

path - Path of the ZNode.

data - Data to set.

version - Version of the data to store.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

setData

public void setData(java.lang.String path,
                    java.lang.String data,
                    int version)
             throws java.lang.Exception

Set data into a ZNode.

Parameters:

path - Path of the ZNode.

data - Data to set as String.

version - Version of the data to store.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

getChildren

public java.util.List<java.lang.String> getChildren(java.lang.String path)
                                             throws java.lang.Exception

Get children of a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

The list of children.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

exists

public boolean exists(java.lang.String path)
               throws java.lang.Exception

Check if a ZNode exists.

Parameters:

path - Path of the ZNode.

Returns:

If the ZNode exists.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

create

public boolean create(java.lang.String path)
               throws java.lang.Exception

Create a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

If the ZNode was created.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

create

public boolean create(java.lang.String path,
                      java.util.List<org.apache.zookeeper.data.ACL> zkAcl)
               throws java.lang.Exception

Create a ZNode.

Parameters:

path - Path of the ZNode.

zkAcl - ACL for the node.

Returns:

If the ZNode was created.

Throws:

java.lang.Exception - If it cannot contact Zookeeper.

createRootDirRecursively

public void createRootDirRecursively(java.lang.String path)
                              throws java.lang.Exception

Utility function to ensure that the configured base znode exists. This recursively creates the znode as well as all of its parents.

Parameters:

path - Path of the znode to create.

Throws:

java.lang.Exception - If it cannot create the file.

createRootDirRecursively

public void createRootDirRecursively(java.lang.String path,
                                     java.util.List<org.apache.zookeeper.data.ACL> zkAcl)
                              throws java.lang.Exception

Utility function to ensure that the configured base znode exists. This recursively creates the znode as well as all of its parents.

Parameters:

path - Path of the znode to create.

zkAcl - ACLs for ZooKeeper.

Throws:

java.lang.Exception - If it cannot create the file.

delete

public boolean delete(java.lang.String path)
               throws java.lang.Exception

Delete a ZNode.

Parameters:

path - Path of the ZNode.

Returns:

If the znode was deleted.

Throws:

java.lang.Exception - If it cannot contact ZooKeeper.

getNodePath

public static java.lang.String getNodePath(java.lang.String root,
                                           java.lang.String nodeName)

Get the path for a ZNode.

Parameters:

root - Root of the ZNode.

nodeName - Name of the ZNode.

Returns:

Path for the ZNode.

safeCreate

public void safeCreate(java.lang.String path,
                       byte[] data,
                       java.util.List<org.apache.zookeeper.data.ACL> acl,
                       org.apache.zookeeper.CreateMode mode,
                       java.util.List<org.apache.zookeeper.data.ACL> fencingACL,
                       java.lang.String fencingNodePath)
                throws java.lang.Exception

Throws:

java.lang.Exception

safeDelete

public void safeDelete(java.lang.String path,
                       java.util.List<org.apache.zookeeper.data.ACL> fencingACL,
                       java.lang.String fencingNodePath)
                throws java.lang.Exception

Deletes the path. Checks for existence of path as well.

Parameters:

path - Path to be deleted.

fencingNodePath - fencingNodePath.

fencingACL - fencingACL.

Throws:

java.lang.Exception - if any problem occurs while performing deletion.

safeSetData

public void safeSetData(java.lang.String path,
                        byte[] data,
                        int version,
                        java.util.List<org.apache.zookeeper.data.ACL> fencingACL,
                        java.lang.String fencingNodePath)
                 throws java.lang.Exception

Throws:

java.lang.Exception

createTransaction

public ZKCuratorManager.SafeTransaction createTransaction(java.util.List<org.apache.zookeeper.data.ACL> fencingACL,
                                                          java.lang.String fencingNodePath)
                                                   throws java.lang.Exception

Throws:

java.lang.Exception