-AsyncLocalRunner -

X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fengine%2Flocal%2FAsyncLocalRunner.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fengine%2Flocal%2FAsyncLocalRunner.html;h=0000000000000000000000000000000000000000;hb=0bbebf27d045b1345bc042bdf24ef2e6808df251;hp=71ea97d72c4206780a2651237bd2ac46da794d24;hpb=5be600c3985aa7bcb8d8b51d77d773c76e6802bb;p=jabaws.git diff --git a/website/full_javadoc/compbio/engine/local/AsyncLocalRunner.html b/website/full_javadoc/compbio/engine/local/AsyncLocalRunner.html deleted file mode 100644 index 71ea97d..0000000 --- a/website/full_javadoc/compbio/engine/local/AsyncLocalRunner.html +++ /dev/null @@ -1,402 +0,0 @@ - - - - - - -AsyncLocalRunner - - - - - - - - - - - - -

- - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - -

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

- -

- PREV CLASS - NEXT CLASS

- FRAMES - NO FRAMES - - - - -

- SUMMARY: NESTED | FIELD | CONSTR | METHOD

-DETAIL: FIELD | CONSTR | METHOD

- - - -

- -

- -compbio.engine.local -
-Class AsyncLocalRunner

-java.lang.Object
-  compbio.engine.local.AsyncLocalRunner
-

All Implemented Interfaces:: AsyncExecutor

public final class AsyncLocalRunner
extends Object
implements AsyncExecutor
extends Object
implements AsyncExecutor

- - -

- -

- - - - - - - - - - - -
-Constructor Summary
AsyncLocalRunner() - -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-Method Summary
- boolean cancelJob(String jobId) - -
-          Stop running job.
- boolean cleanup(String jobId) - -
-          Remove all files and a job directory for a jobid.
- JobStatus getJobStatus(String jobId) - -
-          Query the status of the job
- ConfiguredExecutable<?> getResults(String taskId) - -
-          Retrieve the results of the job.
- String getWorkDirectory(String jobId) - -
-
- String submitJob(ConfiguredExecutable<?> executable) - -
-          Submits job for the execution - Immediate execution is not guaranteed, this method puts the job in the queue.
- - - - - - - - -
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
- -

-Constructor Summary
`AsyncLocalRunner()` - - -

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

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - - - - - - - -
-Constructor Detail
- -

-AsyncLocalRunner

-public AsyncLocalRunner()

- - - - - - - - - -

-Method Detail

- -

-getWorkDirectory

-public String getWorkDirectory(String jobId)

Specified by:: getWorkDirectory in interface AsyncExecutor

Parameters:: jobId - unique job identifier -
Returns:: task working directory

- -

-cancelJob

-public boolean cancelJob(String jobId)

Description copied from interface: AsyncExecutor

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

Specified by:: cancelJob in interface AsyncExecutor

Returns:: true if job was cancelled successfully, false otherwise

- -

-getJobStatus

-public JobStatus getJobStatus(String jobId)

Description copied from interface: AsyncExecutor

Query the status of the job -

Specified by:: getJobStatus in interface AsyncExecutor

Returns:: The JobStatus object representing the status of the job
See Also:: JobStatus

- -

-submitJob

-public String submitJob(ConfiguredExecutable<?> executable)
-                 throws JobSubmissionException

Description copied from interface: AsyncExecutor

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. -

Specified by:: submitJob in interface AsyncExecutor

Returns:: unique job identifier -
Throws: -: JobSubmissionException - if submission fails. This usually happens due to the problem on a server side.

- -

-cleanup

-public boolean cleanup(String jobId)

Description copied from interface: AsyncExecutor

Remove all files and a job directory for a jobid. -

Specified by:: cleanup in interface AsyncExecutor

Parameters:: jobId - -
Returns:: true if all files were removed, false otherwise

- -

-getResults

-public ConfiguredExecutable<?> getResults(String taskId)
-                                   throws ResultNotAvailableException

Description copied from interface: AsyncExecutor

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. -

Specified by:: getResults in interface AsyncExecutor

Parameters:: taskId - 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.

- -

- - - - - - - - - - - - - - - - - - - -

- - - - - - - - - - - - -

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

- -

- PREV CLASS - NEXT CLASS

- FRAMES - NO FRAMES - - - - -

- SUMMARY: NESTED | FIELD | CONSTR | METHOD

-DETAIL: FIELD | CONSTR | METHOD

- - - -

- - -

- -compbio.engine.local - -Class AsyncLocalRunner

-AsyncLocalRunner

-getWorkDirectory

-cancelJob

-getJobStatus

-submitJob

-cleanup

-getResults

- -compbio.engine.local -
-Class AsyncLocalRunner