com.ibm.optim.oaas.client.job

Interface JobExecutor

public interface JobExecutor

A job executor is in charge of submitting and monitoring the execution of jobs.

See Also:

JobExecutorBuilder, JobExecutorFactory

Method Summary

Methods

Modifier and Type	Method and Description
Future<JobResponse>	create(JobRequest request, JobCallback callback) Creates a job request but does not submit the job.
Future<JobResponse>	execute(JobRequest request) Executes a job request.
Future<JobResponse>	execute(JobRequest request, JobCallback callback) Executes a job request and calls a callback at major steps of the execution.
Future<JobResponse>	monitor(JobRequest request, String jobid, JobCallback callback) Monitor a job request that was submitted.
void	shutdown() Stops the execution of the executor and releases all used resources.
Future<JobResponse>	submit(JobRequest request, JobCallback callback) Submits a job request but does not monitor the execution nor process the outputs and logs.

Method Detail

shutdown

void shutdown()

Stops the execution of the executor and releases all used resources.

execute

Future<JobResponse> execute(JobRequest request)
                            throws OperationException,
                                   IOException,
                                   InterruptedException,
                                   JobException

Executes a job request. The returned future will be done when the job has finished or an exception occurred.

Parameters:

request - The request.

Returns:

The future of the job response.

Throws:

OperationException - if any other remote exception was raised.

IOException - if an I-O exception was raised.

InterruptedException - if the operation was interrupted.

JobException - if the job failed for any reason.

execute

Future<JobResponse> execute(JobRequest request,
                          JobCallback callback)
                            throws OperationException,
                                   IOException,
                                   InterruptedException,
                                   JobException

Executes a job request and calls a callback at major steps of the execution. The returned future will be done when the job has finished or an exception occurred.

Parameters:

request - The request.

callback - The call back.

Returns:

The future of the job response.

Throws:

OperationException - if any other remote exception was raised.

IOException - if an I-O exception was raised.

InterruptedException - if the operation was interrupted.

JobException - if the job failed for any reason.

create

Future<JobResponse> create(JobRequest request,
                         JobCallback callback)
                           throws OperationException,
                                  IOException,
                                  InterruptedException,
                                  JobException

Creates a job request but does not submit the job. The returned future will be done when the job has been created with all the input attachment uploaded.

Parameters:

request - The request.

callback - The call back.

Returns:

The future of the job response.

Throws:

OperationException - if any other remote exception was raised.

IOException - if an I-O exception was raised.

InterruptedException - if the operation was interrupted.

JobException - if the job failed for any reason.

See Also:

monitor(JobRequest, String, JobCallback)

submit

Future<JobResponse> submit(JobRequest request,
                         JobCallback callback)
                           throws OperationException,
                                  IOException,
                                  InterruptedException,
                                  JobException

Submits a job request but does not monitor the execution nor process the outputs and logs. The returned future will be done when the job has been submitted with all the input attachment uploaded.

Parameters:

request - The request.

callback - The call back.

Returns:

The future of the job response.

Throws:

OperationException - if any other remote exception was raised.

IOException - if an I-O exception was raised.

InterruptedException - if the operation was interrupted.

JobException - if the job failed for any reason.

See Also:

monitor(JobRequest, String, JobCallback)

monitor

Future<JobResponse> monitor(JobRequest request,
                          String jobid,
                          JobCallback callback)
                            throws OperationException,
                                   IOException,
                                   InterruptedException,
                                   JobException

Monitor a job request that was submitted. The job will not be created and attachment will not be uploaded. The returned future will be done when the job is completed.

Parameters:

request - The request.

jobid - The ID of the job to monitor.

callback - The call back or null if not defined.

Returns:

The future of the job response.

Throws:

OperationException - if any other remote exception was raised.

IOException - if an I-O exception was raised.

InterruptedException - if the operation was interrupted.

JobException - if the job failed for any reason.

See Also:

submit(JobRequest, JobCallback)