compbio.engine

Interface AsyncExecutor

All Known Implementing Classes:

AsyncClusterRunner, AsyncJobRunner, AsyncLocalRunner

public interface AsyncExecutor

An asynchronous executor engine, capable of running, cancelling, obtaining results calculated by a native executable wrapper in Executable interface. Implementation agnostic. Executables can be run either locally to the JVM or on the cluster.

Author:

pvtroshin Date October 2009

Method Summary

Modifier and Type	Method and Description
boolean	cancelJob(java.lang.String jobId) Stop running job.
boolean	cleanup(java.lang.String jobId) Remove all files and a job directory for a jobid.
JobStatus	getJobStatus(java.lang.String jobId) Query the status of the job
ConfiguredExecutable<?>	getResults(java.lang.String jobId) Retrieve the results of the job.
java.lang.String	getWorkDirectory(java.lang.String jobId)
java.lang.String	submitJob(ConfiguredExecutable<?> executable) Submits job for the execution Immediate execution is not guaranteed, this method puts the job in the queue.

Method Detail

submitJob

java.lang.String submitJob(ConfiguredExecutable<?> executable)
                    throws JobSubmissionException

Submits job for the execution Immediate execution is not guaranteed, this method puts the job in the queue. All it guarantees that the job will be eventually executed. The start of execution will depend on the number of jobs in the queue.

Returns:

unique job identifier

Throws:

JobSubmissionException - if submission fails. This usually happens due to the problem on a server side.

getResults

ConfiguredExecutable<?> getResults(java.lang.String jobId)
                            throws ResultNotAvailableException

Retrieve the results of the job. Please not that current implementations of this method blocks if the task is running until the end of the calculation.

Parameters:

jobId - job identifier obtained at the job submission

Returns:

ConfiguredExecutable object from which result can be obtained

Throws:

ResultNotAvailableException - if the result is not available for whatever reason. Could be due to execution failure, or due to the results being removed from the server at the time of request.

getWorkDirectory

java.lang.String getWorkDirectory(java.lang.String jobId)

Parameters:

jobId - unique job identifier

Returns:

task working directory

cleanup

boolean cleanup(java.lang.String jobId)

Remove all files and a job directory for a jobid.

Parameters:

jobId -

Returns:

true if job directory was successfully removed, false otherwise.

cancelJob

boolean cancelJob(java.lang.String jobId)

Stop running job. Please not that this method does not guarantee to remove the job directory and files in it.

Returns:

true if job was cancelled successfully, false otherwise

getJobStatus

JobStatus getJobStatus(java.lang.String jobId)

Query the status of the job

Parameters:

String - jobId - unique job identifier

Returns:

The JobStatus object representing the status of the job

See Also:

JobStatus