org.eclipse.smila.jobmanager.persistence.zk

Class ZkPaths

java.lang.Object

org.eclipse.smila.jobmanager.persistence.zk.ZkPaths

public final class ZkPaths
extends java.lang.Object

Zookeeper structure:

 /smila/jobmanager/jobs/<job-name>/workflow-runs/<workflow-run-id>/data/tasks/<task-id>
 ............................................................................/transient-bulks/<subfolder>/<bulk>
 ............................................................................/barriers/<action-position>/tasks
 ........................................................................................................../bulks
 ......................................................................./finishing

 ................................./data/<data-node>              // job counters etc.
 ................................./worker-data/<workername>      // worker specific counters etc.
 ................................./custom/<workername>/<path> // custom data stored by a worker during a job run
 ................................./jobrun-definitions/              // definitions used in a job run
 ..................................................../jobdef
 ................................................... /wfdef
 ..................................................../bucketdef/<bucket-name>
 ....................../buckets/<bucket-id>/<job-name>        // jobs triggered by bucket
 

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JOBMANAGER_PREFIX prefix for jobmanager data.
static java.lang.String	NODE_BUCKETS data of a job run.
static java.lang.String	NODE_CUSTOM root node for stored custom worker data.
static java.lang.String	NODE_DATA global data of a job run.
static java.lang.String	NODE_JOBS data of a job run.
static java.lang.String	NODE_RUN_DEFINITIONS root node for stored definitions that are used by a job run.
static java.lang.String	NODE_RUN_DEFINITIONS_BUCKET stores bucket definitions used by a job run.
static java.lang.String	NODE_RUN_DEFINITIONS_JOB stores job definition used by a job run.
static java.lang.String	NODE_RUN_DEFINITIONS_WORKFLOW stores workflow definition used by a job run.
static java.lang.String	NODE_TASKS tasks of a workflow step.
static java.lang.String	NODE_TRANSIENT_BULKS transient bulks of a workflow run.
static java.lang.String	NODE_WORKERDATA worker specific data of a job run.
static java.lang.String	NODE_WORKFLOW_RUN_FINISHING indicates whether a workflow run is currently finished.
static java.lang.String	NODE_WORKFLOW_RUNS workflow runs of a job run.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	decode(java.lang.String encodedValue)
static java.lang.String	encode(java.lang.String value)
static java.lang.String	getCustomDataPath(java.lang.String job, java.lang.String worker, java.lang.String... path)
static java.lang.String	getJobDataPath(java.lang.String jobName)
static java.lang.String	getJobPath(java.lang.String jobName)
static java.lang.String	getJobRunDefinitionsPath(java.lang.String jobName)
static java.lang.String	getJobRunDefPathForBucketDefs(java.lang.String jobName)
static java.lang.String	getJobRunDefPathForJobDef(java.lang.String jobName)
static java.lang.String	getJobRunDefPathForWorkflowDef(java.lang.String jobName)
static java.lang.String	getJobsPath()
static java.lang.String	getJobWorkerDataPath(java.lang.String jobName)
static java.lang.String	getJobWorkerDataPath(java.lang.String jobName, java.lang.String workerName)
static java.lang.String	getTriggerBucketPath(java.lang.String bucketId)
static java.lang.String	getTriggeredJobPath(java.lang.String bucketId, java.lang.String jobName)
static java.lang.String	getWorkflowRunBarrierBulkPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition, java.lang.String bulkId)
static java.lang.String	getWorkflowRunBarrierBulksPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition)
static java.lang.String	getWorkflowRunBarrierOpeningPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition)
static java.lang.String	getWorkflowRunBarrierPendingPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition)
static java.lang.String	getWorkflowRunBarriersPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition)
static java.lang.String	getWorkflowRunBarrierTaskPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition, java.lang.String taskId)
static java.lang.String	getWorkflowRunBarrierTasksPath(java.lang.String jobName, java.lang.String workflowRunId, int actionPosition)
static java.lang.String	getWorkflowRunBulksPath(java.lang.String jobName, java.lang.String workflowRunId)
static java.lang.String	getWorkflowRunBulksSubPath(java.lang.String jobName, java.lang.String workflowRunId, int currentSubFolder)
static java.lang.String	getWorkflowRunDataPath(java.lang.String jobName, java.lang.String workflowRunId)
static java.lang.String	getWorkflowRunPath(java.lang.String jobName, java.lang.String workflowRunId)
static java.lang.String	getWorkflowRunsPath(java.lang.String jobName)
static java.lang.String	getWorkflowRunTasksPath(java.lang.String jobName, java.lang.String workflowRunId)

Methods inherited from class java.lang.Object

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

Field Detail

JOBMANAGER_PREFIX

public static final java.lang.String JOBMANAGER_PREFIX

prefix for jobmanager data.

See Also:

Constant Field Values

NODE_WORKFLOW_RUNS

public static final java.lang.String NODE_WORKFLOW_RUNS

workflow runs of a job run.

See Also:

Constant Field Values

NODE_BUCKETS

public static final java.lang.String NODE_BUCKETS

data of a job run.

See Also:

Constant Field Values

NODE_JOBS

public static final java.lang.String NODE_JOBS

data of a job run.

See Also:

Constant Field Values

NODE_DATA

public static final java.lang.String NODE_DATA

global data of a job run.

See Also:

Constant Field Values

NODE_WORKERDATA

public static final java.lang.String NODE_WORKERDATA

worker specific data of a job run.

See Also:

Constant Field Values

NODE_TASKS

public static final java.lang.String NODE_TASKS

tasks of a workflow step.

See Also:

Constant Field Values

NODE_TRANSIENT_BULKS

public static final java.lang.String NODE_TRANSIENT_BULKS

transient bulks of a workflow run.

See Also:

Constant Field Values

NODE_RUN_DEFINITIONS

public static final java.lang.String NODE_RUN_DEFINITIONS

root node for stored definitions that are used by a job run.

See Also:

Constant Field Values

NODE_RUN_DEFINITIONS_JOB

public static final java.lang.String NODE_RUN_DEFINITIONS_JOB

stores job definition used by a job run.

See Also:

Constant Field Values

NODE_RUN_DEFINITIONS_WORKFLOW

public static final java.lang.String NODE_RUN_DEFINITIONS_WORKFLOW

stores workflow definition used by a job run.

See Also:

Constant Field Values

NODE_RUN_DEFINITIONS_BUCKET

public static final java.lang.String NODE_RUN_DEFINITIONS_BUCKET

stores bucket definitions used by a job run.

See Also:

Constant Field Values

NODE_WORKFLOW_RUN_FINISHING

public static final java.lang.String NODE_WORKFLOW_RUN_FINISHING

indicates whether a workflow run is currently finished.

See Also:

Constant Field Values

NODE_CUSTOM

public static final java.lang.String NODE_CUSTOM

root node for stored custom worker data.

See Also:

Constant Field Values

Method Detail

getJobsPath

public static java.lang.String getJobsPath()

Returns:

root path for all stored jobs

getJobPath

public static java.lang.String getJobPath(java.lang.String jobName)

Returns:

root path for given job name

getJobRunDefinitionsPath

public static java.lang.String getJobRunDefinitionsPath(java.lang.String jobName)

Returns:

root path where to store the definitions for the job (run).

getJobRunDefPathForJobDef

public static java.lang.String getJobRunDefPathForJobDef(java.lang.String jobName)

Returns:

path where the job definition for the given job is stored.

getJobRunDefPathForWorkflowDef

public static java.lang.String getJobRunDefPathForWorkflowDef(java.lang.String jobName)

Returns:

path where the workflow definition for the given job is stored.

getJobRunDefPathForBucketDefs

public static java.lang.String getJobRunDefPathForBucketDefs(java.lang.String jobName)

Returns:

path where the bucket definitions for the given job are stored.

getJobDataPath

public static java.lang.String getJobDataPath(java.lang.String jobName)

Parameters:

jobName - job name

Returns:

path for job run data for given job.

getJobWorkerDataPath

public static java.lang.String getJobWorkerDataPath(java.lang.String jobName)

Parameters:

jobName - job name

Returns:

root path for worker specific job run data.

getJobWorkerDataPath

public static java.lang.String getJobWorkerDataPath(java.lang.String jobName,
                                    java.lang.String workerName)

Parameters:

jobName - job name

workerName - worker name

Returns:

path for worker specific job run data.

getWorkflowRunsPath

public static java.lang.String getWorkflowRunsPath(java.lang.String jobName)

Parameters:

jobName - job name

Returns:

root path for workflow runs for given job name.

getWorkflowRunPath

public static java.lang.String getWorkflowRunPath(java.lang.String jobName,
                                  java.lang.String workflowRunId)

Parameters:

jobName - job name

workflowRunId - workflow run id

Returns:

path for given job and workflow run id

getWorkflowRunDataPath

public static java.lang.String getWorkflowRunDataPath(java.lang.String jobName,
                                      java.lang.String workflowRunId)

Returns:

path where all data for given workflow run is stored.

getWorkflowRunTasksPath

public static java.lang.String getWorkflowRunTasksPath(java.lang.String jobName,
                                       java.lang.String workflowRunId)

Returns:

path where task ids for given workflow run are stored.

getWorkflowRunBulksPath

public static java.lang.String getWorkflowRunBulksPath(java.lang.String jobName,
                                       java.lang.String workflowRunId)

Returns:

path where all transient bulk ids for given workflow run are stored (in sub folders)

getWorkflowRunBulksSubPath

public static java.lang.String getWorkflowRunBulksSubPath(java.lang.String jobName,
                                          java.lang.String workflowRunId,
                                          int currentSubFolder)

Returns:

sub path where transient bulk ids for given workflow run are stored.

getWorkflowRunBarriersPath

public static java.lang.String getWorkflowRunBarriersPath(java.lang.String jobName,
                                          java.lang.String workflowRunId,
                                          int actionPosition)

Returns:

path where barrier data for the given workflow run is stored

getWorkflowRunBarrierTasksPath

public static java.lang.String getWorkflowRunBarrierTasksPath(java.lang.String jobName,
                                              java.lang.String workflowRunId,
                                              int actionPosition)

Returns:

path where task ids are stored that must be finished before a barrier action is triggered.

getWorkflowRunBarrierTaskPath

public static java.lang.String getWorkflowRunBarrierTaskPath(java.lang.String jobName,
                                             java.lang.String workflowRunId,
                                             int actionPosition,
                                             java.lang.String taskId)

Returns:

path for task to be stored that must be finished before a barrier action is triggered.

getWorkflowRunBarrierBulksPath

public static java.lang.String getWorkflowRunBarrierBulksPath(java.lang.String jobName,
                                              java.lang.String workflowRunId,
                                              int actionPosition)

Returns:

path where bulk ids are stored that are used to trigger a barrier action

getWorkflowRunBarrierBulkPath

public static java.lang.String getWorkflowRunBarrierBulkPath(java.lang.String jobName,
                                             java.lang.String workflowRunId,
                                             int actionPosition,
                                             java.lang.String bulkId)

Returns:

path for bulks to be stored for triggering a barrier task later.

getWorkflowRunBarrierOpeningPath

public static java.lang.String getWorkflowRunBarrierOpeningPath(java.lang.String jobName,
                                                java.lang.String workflowRunId,
                                                int actionPosition)

Returns:

path where we set a mark to ensure that only one finishing tasks leads to opening the barrier.

getWorkflowRunBarrierPendingPath

public static java.lang.String getWorkflowRunBarrierPendingPath(java.lang.String jobName,
                                                java.lang.String workflowRunId,
                                                int actionPosition)

Returns:

path where we set a mark to denote that bulks may be added to this barrier.

getTriggerBucketPath

public static java.lang.String getTriggerBucketPath(java.lang.String bucketId)

Parameters:

bucketId - bucket Id

Returns:

path for node containing job names triggered by this bucket.

getTriggeredJobPath

public static java.lang.String getTriggeredJobPath(java.lang.String bucketId,
                                   java.lang.String jobName)

Parameters:

bucketId - bucket Id

jobName - job name

Returns:

path for node describing that a node is triggered by a bucket

getCustomDataPath

public static java.lang.String getCustomDataPath(java.lang.String job,
                                 java.lang.String worker,
                                 java.lang.String... path)

encode

public static java.lang.String encode(java.lang.String value)

Parameters:

value - a string

Returns:

URL encoded version.

decode

public static java.lang.String decode(java.lang.String encodedValue)

Parameters:

encodedValue - an URL encoded string

Returns:

decoded version.