org.eclipse.smila.jobmanager

Interface JobRunEngine

All Known Implementing Classes:

JobRunEngineImpl

public interface JobRunEngine

Job management component handling/processing the lifecycle of a job run.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelJob(java.lang.String jobName, java.lang.String jobRunId)
void	checkAndHandleJobRunCompleted(java.lang.String jobName, java.lang.String jobRunId) Checks if a job run is completed or if some completion run must take place.
void	deleteJobRunData(java.lang.String jobName, java.lang.String jobRunId) delete a previously completed job run.
void	deleteTransientBulks(java.lang.String jobName, java.lang.String jobRunId, java.lang.String workflowRunId) Deletes transient instances of buckets from the collection of bucket instance ids.
JobRun	ensureJobRun(java.lang.String jobName, java.lang.String jobRunId) Check if the job run data are still valid creates a new job run if not.
void	finishJob(java.lang.String jobName, java.lang.String jobRunId)
java.util.Map<java.lang.String,java.lang.String>	getJobRunsUsingStore(java.lang.String storeName) Creates a map with active job runs using the given store.
java.lang.String	startJob(java.lang.String jobName) start job with default job run mode (as defined by workflow or job, or JobRunMode.STANDARD.
java.lang.String	startJob(java.lang.String jobName, JobRunMode jobMode)

Method Detail

startJob

java.lang.String startJob(java.lang.String jobName)
                          throws JobManagerException

start job with default job run mode (as defined by workflow or job, or JobRunMode.STANDARD.

Parameters:

jobName - name of the job to start

Returns:

id of the new job run

Throws:

JobManagerException - error starting job

startJob

java.lang.String startJob(java.lang.String jobName,
                        JobRunMode jobMode)
                          throws JobManagerException

Parameters:

jobName - name of the job to start

jobMode - the mode for the job to start. May be null, then method behaves just like startJob(String).

Returns:

id of the new job run

Throws:

JobManagerException - error starting job

finishJob

void finishJob(java.lang.String jobName,
             java.lang.String jobRunId)
               throws JobManagerException

Parameters:

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

jobRunId - id of the job run to finish

Throws:

JobManagerException - error finishing job

cancelJob

void cancelJob(java.lang.String jobName,
             java.lang.String jobRunId)
               throws JobManagerException

Parameters:

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

jobRunId - id of the job run to cancel

Throws:

JobManagerException - error canceling job

ensureJobRun

JobRun ensureJobRun(java.lang.String jobName,
                  java.lang.String jobRunId)
                    throws JobManagerException

Check if the job run data are still valid creates a new job run if not.

Parameters:

jobName - The job name

jobRunId - The job run id

Returns:

The job run

Throws:

JobManagerException - The job manager exception

deleteTransientBulks

void deleteTransientBulks(java.lang.String jobName,
                        java.lang.String jobRunId,
                        java.lang.String workflowRunId)

Deletes transient instances of buckets from the collection of bucket instance ids. If the bucket instance is not found in this instance of jobmanager it is lazily loaded before deleted.

Parameters:

jobName - The job name

jobRunId - The job run id

workflowRunId - The workflow run id

checkAndHandleJobRunCompleted

void checkAndHandleJobRunCompleted(java.lang.String jobName,
                                 java.lang.String jobRunId)
                                   throws JobManagerException

Checks if a job run is completed or if some completion run must take place.

Parameters:

jobName - The name of the job.

jobRunId - The id of the job run.

Throws:

JobManagerException - error

deleteJobRunData

void deleteJobRunData(java.lang.String jobName,
                    java.lang.String jobRunId)
                      throws JobManagerException

delete a previously completed job run.

Parameters:

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

jobRunId - id of the complete job run to delete the monitoring data.

Throws:

JobManagerException - run id is not a completed run or error deleting it.

getJobRunsUsingStore

java.util.Map<java.lang.String,java.lang.String> getJobRunsUsingStore(java.lang.String storeName)

Creates a map with active job runs using the given store.

Parameters:

storeName - the store name

Returns:

a map with all job runs using the store with given name. The job name is used as key, the job run id as value.