org.eclipse.smila.jobmanager.internal

Class JobRunDataProviderImpl

java.lang.Object

org.eclipse.smila.jobmanager.internal.JobRunDataProviderImpl

All Implemented Interfaces:

JobRunDataProvider

public class JobRunDataProviderImpl
extends java.lang.Object
implements JobRunDataProvider

Implements JobRunDataProvider.

Constructor Summary

Constructors

Constructor and Description
JobRunDataProviderImpl()

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.
WorkerDefinition	getWorker(java.lang.String name) Returns a worker from the persistence definition.
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.
void	setDefinitionPersistence(DefinitionPersistence defPersistence) set OSGI service.
void	setPermanentStorage(PermanentStorage permStorage)
void	setRunStorage(RunStorage runStorage)
void	unsetDefinitionPersistence(DefinitionPersistence defPersistence) unset OSGI service.
void	unsetPermanentStorage(PermanentStorage permStorage)
void	unsetRunStorage(RunStorage runStorage)

Methods inherited from class java.lang.Object

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

Constructor Detail

JobRunDataProviderImpl

public JobRunDataProviderImpl()

Method Detail

getJobRunData

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

Specified by:

getJobRunData in interface JobRunDataProvider

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

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

Specified by:

getJobRunData in interface JobRunDataProvider

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

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

Description copied from interface: JobRunDataProvider

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.

Specified by:

getWorkflowRunData in interface JobRunDataProvider

Returns:

workflow run information

Throws:

JobManagerException - jobrun or workflowrun are not active anymore.

getJobRunInfo

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

Description copied from interface: JobRunDataProvider

get info on current job run.

Specified by:

getJobRunInfo in interface JobRunDataProvider

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

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

Description copied from interface: JobRunDataProvider

get Ids of complete job runs.

Specified by:

getCompletedJobRunIds in interface JobRunDataProvider

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.

getWorker

public WorkerDefinition getWorker(java.lang.String name)
                           throws ConfigNotFoundException

Returns a worker from the persistence definition.

Parameters:

name - the name of the worker

Returns:

the worker with the given name

Throws:

ConfigNotFoundException - the worker does not exist.

getJobRunDefinitions

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

Specified by:

getJobRunDefinitions in interface JobRunDataProvider

Returns:

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

Throws:

JobManagerException

setCustomData

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

Description copied from interface: JobRunDataProvider

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.

Specified by:

setCustomData in interface JobRunDataProvider

Throws:

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

getCustomData

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

Specified by:

getCustomData in interface JobRunDataProvider

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

setDefinitionPersistence

public void setDefinitionPersistence(DefinitionPersistence defPersistence)

set OSGI service.

unsetDefinitionPersistence

public void unsetDefinitionPersistence(DefinitionPersistence defPersistence)

unset OSGI service.

setPermanentStorage

public void setPermanentStorage(PermanentStorage permStorage)

Parameters:

permStorage - PermanentStorage reference.

unsetPermanentStorage

public void unsetPermanentStorage(PermanentStorage permStorage)

Parameters:

permStorage - PermanentStorage reference.

setRunStorage

public void setRunStorage(RunStorage runStorage)

Parameters:

runStorage - RunStorage reference.

unsetRunStorage

public void unsetRunStorage(RunStorage runStorage)

Parameters:

runStorage - RunStorage reference.