agi.parallel.client

Interface IJobScheduler

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ClusterJobScheduler

public interface IJobScheduler
extends java.io.Closeable

Provides the methods used to submit and monitor jobs to a job scheduler. After creating an instance of this class, call the connect() method to connect to the cluster. You can then submit and monitor jobs.

See Also:

ClusterJobScheduler

Method Summary

Modifier and Type	Method and Description
void	cancelJob(java.util.UUID jobId, boolean listenForCancellationEvent) Cancels the job with the specified id.
void	cancelTask(java.util.UUID taskId) Cancels the task with the specified id.
void	close() Closes this JobScheduler and releases any system resources associated with it.
void	connect() Connects client to specified job scheduler.
Job	createJob() Returns a new job that can later be used to submit to the job scheduler.
void	disconnect() Disconnects client from specified job scheduler.
void	dispose() Deprecated. Please use close() (or a try-with-resources statement)
java.util.UUID	getId() Gets the id of this job scheduler.
boolean	getIsConnected() Gets a value indicating whether the job scheduler is connected.
int	getMaximumHostCount() Returns the maximum number of hosts that is available to the job scheduler.
void	submitJob(Job job, JobSubmitListener listener) Submits job to the job scheduler so that the job scheduler can add the job to it's queue.
boolean	waitUntilDone(java.util.UUID jobId, int millisecondsTimeout, java.lang.Runnable heartbeatCallback, int millisecondsHeartbeat) Blocks until all tasks in this job complete or the operation times out.

Method Detail

getId

java.util.UUID getId()

Gets the id of this job scheduler.

getIsConnected

boolean getIsConnected()

Gets a value indicating whether the job scheduler is connected. true if this scheduler is connected; otherwise, false.

connect

void connect()
      throws JobSchedulerException

Connects client to specified job scheduler.

Throws:

JobSchedulerException - An error occurred while connect to job scheduler.

disconnect

void disconnect()

Disconnects client from specified job scheduler.

dispose

@Deprecated
void dispose()

Deprecated. Please use close() (or a try-with-resources statement)

close

void close()

Closes this JobScheduler and releases any system resources associated with it.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

createJob

Job createJob()
       throws JobSchedulerException

Returns a new job that can later be used to submit to the job scheduler.

Returns:

Job that can be used to submit tasks to the job scheduler.

Throws:

JobSchedulerException - Thrown if client is not connected to the job scheduler yet.

getMaximumHostCount

int getMaximumHostCount()
                 throws JobSchedulerException

Returns the maximum number of hosts that is available to the job scheduler.

Returns:

Maximum number of threads for the job scheduler.

Throws:

JobSchedulerException - If operation fails.

submitJob

void submitJob(Job job,
               JobSubmitListener listener)
        throws JobSchedulerException

Submits job to the job scheduler so that the job scheduler can add the job to it's queue.

Parameters:

job - The job to be submitted.

Throws:

JobSchedulerException - If a task or task environment cannot be serialized.

cancelJob

void cancelJob(java.util.UUID jobId,
               boolean listenForCancellationEvent)
        throws JobSchedulerException

Cancels the job with the specified id.

Parameters:

jobId - The id of the job to cancel.

listenForCancellationEvent - if set to true, client will listen for the cancellation event. Otherwise, cancellation events can be ignored.

Throws:

JobSchedulerException - Thrown if client is not connected to the job scheduler yet.

cancelTask

void cancelTask(java.util.UUID taskId)
         throws JobSchedulerException

Cancels the task with the specified id.

Parameters:

taskId - The id of the task to cancel.

Throws:

JobSchedulerException - Thrown if client is not connected to the job scheduler yet.

waitUntilDone

boolean waitUntilDone(java.util.UUID jobId,
                      int millisecondsTimeout,
                      java.lang.Runnable heartbeatCallback,
                      int millisecondsHeartbeat)
               throws JobSchedulerException

Blocks until all tasks in this job complete or the operation times out. The callback passed in for the heartbeat is called with the period specified by the millisecondsHeartbeat argument.

Parameters:

jobId - The job id for the job to be submitted.

millisecondsTimeout - The timeout (in milliseconds).

heartbeatCallback - The heartbeat callback.

millisecondsHeartbeat - The heartbeat period (in milliseconds).

Returns:

true if job completed, false if timed-out.

Throws:

JobSchedulerException - Thrown if client disconnects from the job scheduler.