edu.iu.dsc.tws.common.zk

Class ZKUtils

java.lang.Object

edu.iu.dsc.tws.common.zk.ZKUtils

public final class ZKUtils
extends java.lang.Object

this class provides methods to construct znode path names for jobs and workers in addition, it provides methods to cleanup znodes on zookeeper server

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	LOG

Method Summary

Modifier and Type	Method and Description
static void	closeClient()
static CuratorFramework	connectToServer(java.lang.String zkServers) connect to ZooKeeper server
static CuratorFramework	connectToServer(java.lang.String zkServers, int sessionTimeoutMs) connect to ZooKeeper server
static PersistentNode	createPersistentEphemeralZnode(java.lang.String path, byte[] payload) create a PersistentNode object in the given path it is ephemeral and persistent it will be deleted after the worker leaves or fails it will be persistent for occasional network problems
static PersistentNode	createPersistentZnode(java.lang.String path, byte[] payload) create a PersistentNode object in the given path it needs to be deleted explicitly, not ephemeral it will be persistent for occasional network problems
static java.lang.String	defaultBarrierDir(java.lang.String rootPath, java.lang.String jobID) construct default barrier directory path for the job
static byte[]	encodeJobMasterZnode(java.lang.String masterAddress, int state) encode the given WorkerInfo object as a byte array.
static java.lang.String	ephemDir(java.lang.String rootPath, java.lang.String jobID) construct ephemeral directory path for the job
static java.lang.String	eventsDir(java.lang.String rootPath, java.lang.String jobID) construct events directory path for the job
static CuratorFramework	getClient()
static int	getWorkerIDFromEphemPath(java.lang.String workerPath) WorkerID is at the end of workerPath The char "-" proceeds the workerID
static int	getWorkerIDFromPersPath(java.lang.String workerPath) WorkerID is at the end of workerPath The char "/" proceeds the workerID
static java.lang.String	initBarrierDir(java.lang.String rootPath, java.lang.String jobID) construct init barrier directory path for the job
static java.lang.String	jmEphemPath(java.lang.String rootPath, java.lang.String jobID) construct the job master path for an ephemeral znode that will watch JM liveness
static java.lang.String	jmPersPath(java.lang.String rootPath, java.lang.String jobID) construct the job master path for a persistent znode that will store the job master state
static java.lang.String	jobDir(java.lang.String rootPath, java.lang.String jobID) construct main job directory path for the job
static java.lang.String	jobEndTimePath(java.lang.String rootPath, java.lang.String jobID) construct the job end time znode path
static java.lang.String	jobSubmisionTimePath(java.lang.String rootPath, java.lang.String jobID) construct the job submission time znode path
static java.lang.String	persDir(java.lang.String rootPath, java.lang.String jobID) construct persistent directory path for the job
static java.lang.String	workerPath(java.lang.String workersDir, int workerID) construct a worker path from the workers directory

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final java.util.logging.Logger LOG

Method Detail

getClient

public static CuratorFramework getClient()

connectToServer

public static CuratorFramework connectToServer(java.lang.String zkServers)

connect to ZooKeeper server

Parameters:

zkServers -

Returns:

connectToServer

public static CuratorFramework connectToServer(java.lang.String zkServers,
                                               int sessionTimeoutMs)

connect to ZooKeeper server

closeClient

public static void closeClient()

jobDir

public static java.lang.String jobDir(java.lang.String rootPath,
                                      java.lang.String jobID)

construct main job directory path for the job

ephemDir

public static java.lang.String ephemDir(java.lang.String rootPath,
                                        java.lang.String jobID)

construct ephemeral directory path for the job

persDir

public static java.lang.String persDir(java.lang.String rootPath,
                                       java.lang.String jobID)

construct persistent directory path for the job

eventsDir

public static java.lang.String eventsDir(java.lang.String rootPath,
                                         java.lang.String jobID)

construct events directory path for the job

defaultBarrierDir

public static java.lang.String defaultBarrierDir(java.lang.String rootPath,
                                                 java.lang.String jobID)

construct default barrier directory path for the job

initBarrierDir

public static java.lang.String initBarrierDir(java.lang.String rootPath,
                                              java.lang.String jobID)

construct init barrier directory path for the job

workerPath

public static java.lang.String workerPath(java.lang.String workersDir,
                                          int workerID)

construct a worker path from the workers directory

jmPersPath

public static java.lang.String jmPersPath(java.lang.String rootPath,
                                          java.lang.String jobID)

construct the job master path for a persistent znode that will store the job master state

jmEphemPath

public static java.lang.String jmEphemPath(java.lang.String rootPath,
                                           java.lang.String jobID)

construct the job master path for an ephemeral znode that will watch JM liveness

jobSubmisionTimePath

public static java.lang.String jobSubmisionTimePath(java.lang.String rootPath,
                                                    java.lang.String jobID)

construct the job submission time znode path

jobEndTimePath

public static java.lang.String jobEndTimePath(java.lang.String rootPath,
                                              java.lang.String jobID)

construct the job end time znode path

getWorkerIDFromEphemPath

public static int getWorkerIDFromEphemPath(java.lang.String workerPath)

WorkerID is at the end of workerPath The char "-" proceeds the workerID

Returns:

getWorkerIDFromPersPath

public static int getWorkerIDFromPersPath(java.lang.String workerPath)

WorkerID is at the end of workerPath The char "/" proceeds the workerID

Returns:

createPersistentEphemeralZnode

public static PersistentNode createPersistentEphemeralZnode(java.lang.String path,
                                                            byte[] payload)

create a PersistentNode object in the given path it is ephemeral and persistent it will be deleted after the worker leaves or fails it will be persistent for occasional network problems

createPersistentZnode

public static PersistentNode createPersistentZnode(java.lang.String path,
                                                   byte[] payload)

create a PersistentNode object in the given path it needs to be deleted explicitly, not ephemeral it will be persistent for occasional network problems

encodeJobMasterZnode

public static byte[] encodeJobMasterZnode(java.lang.String masterAddress,
                                          int state)

encode the given WorkerInfo object as a byte array. First put the worker state as a 4 byte array to the beginning resulting byte array has the state bytes and workerInfo object after that