org.eclipse.smila.jobmanager

Interface JobRunDataProvider

All Known Implementing Classes:

JobRunDataProviderImpl

public interface JobRunDataProvider

Provides job management and job run data.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Collection<java.lang.String>	getCompletedJobRunIds(java.lang.String jobName) get Ids of complete job runs.
byte[]	getCustomData(java.lang.String jobName, java.lang.String jobRunId, java.lang.String worker, java.lang.String... path)
AnyMap	getJobRunData(java.lang.String jobName, java.lang.String jobId)
AnyMap	getJobRunData(java.lang.String jobName, java.lang.String jobId, boolean returnDetails)
JobRunDefinitions	getJobRunDefinitions(java.lang.String jobName)
JobRunInfo	getJobRunInfo(java.lang.String jobName) get info on current job run.
AnyMap	getWorkflowRunData(java.lang.String jobName, java.lang.String jobId, java.lang.String workflowRunId) get information about a workflow run.
void	setCustomData(java.lang.String jobName, java.lang.String jobRunId, java.lang.String worker, byte[] data, java.lang.String... path) Set custom data for given job (run), worker and path.

Method Detail

getJobRunData

AnyMap getJobRunData(java.lang.String jobName,
                   java.lang.String jobId)
                     throws JobManagerException

Parameters:

jobName - name of the job for which to monitor the run.

jobId - id of the job run to get the monitoring data. May be either the current run or a completed run.

Returns:

monitoring data for the job run with the given id.

Throws:

JobManagerException - error getting job run data

getJobRunData

AnyMap getJobRunData(java.lang.String jobName,
                   java.lang.String jobId,
                   boolean returnDetails)
                     throws JobManagerException

Parameters:

jobName - name of the job for which to monitor the run.

jobId - id of the job run to get the monitoring data. May be either the current run or a completed run.

returnDetails - whether to return details (e.g. workflow/bucket definition)

Returns:

monitoring data for the job run with the given id.

Throws:

JobManagerException - error getting job run data

getWorkflowRunData

AnyMap getWorkflowRunData(java.lang.String jobName,
                        java.lang.String jobId,
                        java.lang.String workflowRunId)
                          throws JobManagerException

get information about a workflow run. The result contains these keys with integer values:

• JobManagerConstants.DATA_WORKFLOW_RUN_NO_OF_ACTIVE_TASKS
• JobManagerConstants.DATA_WORKFLOW_RUN_NO_OF_TRANSIENT_BULKS

The result may contain additional keys.

Returns:

workflow run information

Throws:

JobManagerException - jobrun or workflowrun are not active anymore.

getJobRunInfo

JobRunInfo getJobRunInfo(java.lang.String jobName)
                         throws JobManagerException

get info on current job run.

Parameters:

jobName - job name

Returns:

if job is defined and active: id and state of current run. Else null.

Throws:

JobManagerException - error getting state.

getCompletedJobRunIds

java.util.Collection<java.lang.String> getCompletedJobRunIds(java.lang.String jobName)
                                                             throws JobManagerException

get Ids of complete job runs.

Parameters:

jobName - job name

Returns:

Ids of completed job runs, sorted lexicographically ascending. Empty set if job is not defined or no completed job runs exists.

Throws:

JobManagerException - error getting state.

getJobRunDefinitions

JobRunDefinitions getJobRunDefinitions(java.lang.String jobName)
                                       throws JobManagerException

Returns:

the currently persisted job/workflow/bucket definitions for the given job.

Throws:

JobManagerException

setCustomData

void setCustomData(java.lang.String jobName,
                 java.lang.String jobRunId,
                 java.lang.String worker,
                 byte[] data,
                 java.lang.String... path)
                   throws JobManagerException

Set custom data for given job (run), worker and path. If not needed, 'path' parameter can be left out. If given path already exists for given job (run) and worker, existing data will be overwritten.

Throws:

JobManagerException - if job (run) does not exist or state of job run does not allow setting custom data.

getCustomData

byte[] getCustomData(java.lang.String jobName,
                   java.lang.String jobRunId,
                   java.lang.String worker,
                   java.lang.String... path)
                     throws JobManagerException

Returns:

custom data for given job (run), worker and path. Returns 'null' if no data is stored or job (run), worker or path do not exist.

Throws:

JobManagerException