agi.parallel.client

Class Job

java.lang.Object

agi.parallel.client.Job

All Implemented Interfaces:

IJob

public class Job
extends java.lang.Object
implements IJob

Represents a group of tasks in the system.

Constructor Summary

Constructors

Constructor and Description
Job(IJobScheduler scheduler) Initializes a new instance of the Job class.

Method Summary

Modifier and Type	Method and Description
void	addJobCompletedListener(JobCompletedListener listener) Add a JobCompletedListener to this job.
void	addJobSubmittedListener(JobSubmittedListener listener) Add a JobSubmittedListener to this job.
void	addTask(Task task) Adds a task to Job.
void	addTaskCompletedListener(TaskCompletedListener listener) Add a TaskCompletedListener to this job.
void	addTaskProgressListener(TaskProgressUpdatedListener listener) Add a TaskProgressUpdatedListener to this job.
void	addTaskStateChangeListener(TaskStateChangedListener listener) Add a TaskStateChangedListener to this job.
void	cancel() Cancels all tasks in this job.
void	cancel(boolean listenForCancellationEvent) Cancels all tasks in this job.
java.util.List<java.lang.String>	getAdditionalJars() Gets the list of additional jars that are sent with this job.
java.util.List<java.lang.String>	getAdditionalNativeLibraries() Gets the list of additional native libraries that are sent with this jar.
AgentSelectionType	getAgentSelectionPreference() Gets the agent selection preference.
boolean	getCancelOnClientDisconnection() Gets a value indicating whether to cancel the tasks of this Job when the client disconnects.
boolean	getCancelOnTaskFailure() Gets a value indicating whether to cancel other tasks on this Job if another Task fails.
java.lang.String	getDescription() Gets the Job description.
java.util.List<java.lang.String>	getExcludedJars() Gets the list of excluded jars that are not sent with this job.
boolean	getExclusiveExecution() Gets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
boolean	getFailIfPreconditionsNotSatisfied() Gets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
java.util.UUID	getId() Gets the job's id.
boolean	getIsCanceled() Gets a value indicating whether this job has been canceled.
short	getMaxTaskInterruptedRetryAttempts() Gets the maximum number of times task will be retried if task gets interrupted.
boolean	getMinimizeClientMessaging() Gets a value indicating whether to minimize sending some messages from the Coordinator.
java.lang.String	getName() Gets the Job name.
JobPriority	getPriority() Gets the job priority.
TaskEnvironment	getTaskEnvironment() Gets Job's TaskEnvironment (get / set) By default, an instance of DefaultTaskEnvironment is set as the task environment of a new job.
int	getTaskExecutionTimeout() Gets the timeout for task execution in milliseconds.
TaskPreconditionCollection	getTaskPreconditions() Gets the list of task pre conditions.
TaskCollection	getTasks() Gets the tasks that are contained in this Job.
void	setAgentSelectionPreference(AgentSelectionType value) Sets the agent selection preference.
void	setCancelOnClientDisconnection(boolean value) Sets a value indicating whether to cancel the tasks of this Job when the client disconnects.
void	setCancelOnTaskFailure(boolean value) Sets a value indicating whether to cancel other tasks on this Job if another Task fails.
void	setDescription(java.lang.String value) Sets the Job description.
void	setExclusiveExecution(boolean value) Sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.
void	setFailIfPreconditionsNotSatisfied(boolean value) Sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.
void	setMaxTaskInterruptedRetryAttempts(short value) Sets the maximum number of times task will be retried if task gets interrupted.
void	setMinimizeClientMessaging(boolean value) Sets a value indicating whether to minimize sending some messages from the Coordinator.
void	setName(java.lang.String value) Sets the Job name.
void	setPriority(JobPriority value) Sets the job priority.
void	setTaskEnvironment(TaskEnvironment value) Sets Job's TaskEnvironment (get / set)
void	setTaskExecutionTimeout(int value) Sets the timeout for task execution in milliseconds.
void	submit() Submits job to job scheduler.
boolean	waitUntilDone() Blocks until all tasks in this job complete.
boolean	waitUntilDone(int millisecondsTimeout) Blocks until all tasks in this job complete or the operation times out.
boolean	waitUntilDone(int millisecondsTimeout, java.lang.Runnable heartbeatCallback, int millisecondsHeartbeat) Blocks until all tasks in this job complete or the operation times out.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Job

public Job(IJobScheduler scheduler)

Initializes a new instance of the Job class.

Parameters:

scheduler - The scheduler which job is submitted to.

Method Detail

addTaskCompletedListener

public void addTaskCompletedListener(TaskCompletedListener listener)

Add a TaskCompletedListener to this job.

addTaskStateChangeListener

public void addTaskStateChangeListener(TaskStateChangedListener listener)

Add a TaskStateChangedListener to this job.

addTaskProgressListener

public void addTaskProgressListener(TaskProgressUpdatedListener listener)

Add a TaskProgressUpdatedListener to this job.

addJobSubmittedListener

public void addJobSubmittedListener(JobSubmittedListener listener)

Add a JobSubmittedListener to this job.

addJobCompletedListener

public void addJobCompletedListener(JobCompletedListener listener)

Add a JobCompletedListener to this job.

getId

public final java.util.UUID getId()

Description copied from interface: IJob

Gets the job's id.

Specified by:

getId in interface IJob

Returns:

The job id.

getTasks

public final TaskCollection getTasks()

Gets the tasks that are contained in this Job.

getAdditionalJars

public final java.util.List<java.lang.String> getAdditionalJars()

Gets the list of additional jars that are sent with this job. The expected values in the last are paths to jar files.

getExcludedJars

public final java.util.List<java.lang.String> getExcludedJars()

Gets the list of excluded jars that are not sent with this job. The expected values in the last are paths or names of jar files.

getAdditionalNativeLibraries

public final java.util.List<java.lang.String> getAdditionalNativeLibraries()

Gets the list of additional native libraries that are sent with this jar. The expected values in the last are paths to dll or so files.

getTaskPreconditions

public final TaskPreconditionCollection getTaskPreconditions()

Gets the list of task pre conditions.

getTaskEnvironment

public final TaskEnvironment getTaskEnvironment()

Description copied from interface: IJob

Gets Job's TaskEnvironment (get / set) By default, an instance of DefaultTaskEnvironment is set as the task environment of a new job.

Specified by:

getTaskEnvironment in interface IJob

Returns:

The task environment.

setTaskEnvironment

public final void setTaskEnvironment(TaskEnvironment value)

Description copied from interface: IJob

Sets Job's TaskEnvironment (get / set)

By default, an instance of DefaultTaskEnvironment is set as the task environment of a new job.

Specified by:

setTaskEnvironment in interface IJob

Parameters:

value - The task environment.

getCancelOnClientDisconnection

public final boolean getCancelOnClientDisconnection()

Description copied from interface: IJob

Gets a value indicating whether to cancel the tasks of this Job when the client disconnects.

CancelOnClientDisconnection ensures that a task does not remain in the coordinator's task queue if the client is no longer connected. If a client disconnects unexpectedly, all tasks in the job are canceled. This is useful for interactive jobs which only makes sense to run if the client is connected and is waiting to process the result of the task.

Specified by:

getCancelOnClientDisconnection in interface IJob

Returns:

true if task should be canceled when the client disconnects. false otherwise.

setCancelOnClientDisconnection

public final void setCancelOnClientDisconnection(boolean value)

Description copied from interface: IJob

Sets a value indicating whether to cancel the tasks of this Job when the client disconnects.

CancelOnClientDisconnection ensures that a task does not remain in the coordinator's task queue if the client is no longer connected. If a client disconnects unexpectedly, all tasks in the job are canceled. This is useful for interactive jobs which only makes sense to run if the client is connected and is waiting to process the result of the task.

Specified by:

setCancelOnClientDisconnection in interface IJob

Parameters:

value - true if task should be canceled when the client disconnects. false otherwise.

getCancelOnTaskFailure

public final boolean getCancelOnTaskFailure()

Description copied from interface: IJob

Gets a value indicating whether to cancel other tasks on this Job if another Task fails.

CancelOnTaskFailure ensures that a task does not remain in the coordinator's task queue if the task fails. This is useful for jobs which are considered logically successful if all the tasks are successful. That is, if a single task fails, then the whole job should be considered a failure.

Specified by:

getCancelOnTaskFailure in interface IJob

setCancelOnTaskFailure

public final void setCancelOnTaskFailure(boolean value)

Description copied from interface: IJob

Sets a value indicating whether to cancel other tasks on this Job if another Task fails.

CancelOnTaskFailure ensures that a task does not remain in the coordinator's task queue if the task fails. This is useful for jobs which are considered logically successful if all the tasks are successful. That is, if a single task fails, then the whole job should be considered a failure.

Specified by:

setCancelOnTaskFailure in interface IJob

getFailIfPreconditionsNotSatisfied

public final boolean getFailIfPreconditionsNotSatisfied()

Description copied from interface: IJob

Gets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.

FailIfPreconditionsNotSatisfied ensures that a task does not remain in the coordinator's task queue if there are currently no agents which meet the preconditions. This is useful for applications which would rather fail fast if a job can't be run rather than wait for certain conditions to become true in the future.

Specified by:

getFailIfPreconditionsNotSatisfied in interface IJob

setFailIfPreconditionsNotSatisfied

public final void setFailIfPreconditionsNotSatisfied(boolean value)

Description copied from interface: IJob

Sets a value indicating whether to fail all tasks immediately of this Job if the precondition is not satisfied.

FailIfPreconditionsNotSatisfied ensures that a task does not remain in the coordinator's task queue if there are currently no agents which meet the preconditions. This is useful for applications which would rather fail fast if a job can't be run rather than wait for certain conditions to become true in the future.

Specified by:

setFailIfPreconditionsNotSatisfied in interface IJob

getMinimizeClientMessaging

public final boolean getMinimizeClientMessaging()

Description copied from interface: IJob

Gets a value indicating whether to minimize sending some messages from the Coordinator.

Specified by:

getMinimizeClientMessaging in interface IJob

setMinimizeClientMessaging

public final void setMinimizeClientMessaging(boolean value)

Description copied from interface: IJob

Sets a value indicating whether to minimize sending some messages from the Coordinator.

Specified by:

setMinimizeClientMessaging in interface IJob

getMaxTaskInterruptedRetryAttempts

public final short getMaxTaskInterruptedRetryAttempts()

Description copied from interface: IJob

Gets the maximum number of times task will be retried if task gets interrupted.

While executing a task, there are a number of system errors that may occur that may happen no matter how well your task is coded. Some examples include the host process exiting abnormally or an agent disconnecting from the coordinator while the agent "owns" a task. Normally, these errors are recoverable; if the task was retried again the task may succeed. As such, the system will try to reassign the task for execution for as many times as MaxTaskInterruptedRetryAttempts is specified.

Setting the maximum task interrupted retry attempts to 0 means that the task will never be retried if there is a system exception while executing the task.

Specified by:

getMaxTaskInterruptedRetryAttempts in interface IJob

setMaxTaskInterruptedRetryAttempts

public final void setMaxTaskInterruptedRetryAttempts(short value)

Description copied from interface: IJob

Sets the maximum number of times task will be retried if task gets interrupted.

While executing a task, there are a number of system errors that may occur that may happen no matter how well your task is coded. Some examples include the host process exiting abnormally or an agent disconnecting from the coordinator while the agent "owns" a task. Normally, these errors are recoverable; if the task was retried again the task may succeed. As such, the system will try to reassign the task for execution for as many times as MaxTaskInterruptedRetryAttempts is specified.

Setting the maximum task interrupted retry attempts to 0 means that the task will never be retried if there is a system exception while executing the task.

Specified by:

setMaxTaskInterruptedRetryAttempts in interface IJob

getExclusiveExecution

public final boolean getExclusiveExecution()

Description copied from interface: IJob

Gets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.

Tasks can either consume a single core of all the cores of an agent. An exclusive job means that all the task of a job will consume all the cores of an agent. The ExclusiveExecution flag prevents any other task to be executed concurrently.

Specified by:

getExclusiveExecution in interface IJob

setExclusiveExecution

public final void setExclusiveExecution(boolean value)

Description copied from interface: IJob

Sets a value indicating whether the tasks on this job should have exclusive access to the resource it is running on.

Tasks can either consume a single core of all the cores of an agent. An exclusive job means that all the task of a job will consume all the cores of an agent. The ExclusiveExecution flag prevents any other task to be executed concurrently.

Specified by:

setExclusiveExecution in interface IJob

getTaskExecutionTimeout

public final int getTaskExecutionTimeout()

Description copied from interface: IJob

Gets the timeout for task execution in milliseconds.

TaskExecutionTimeout is the number of milliseconds that a task can run before it is considered timed out. The TaskExecutionTimeout applies to the task execution, it does not include TaskEnvironment setup time or the time duration that passes after a task has been submitted.

Specified by:

getTaskExecutionTimeout in interface IJob

setTaskExecutionTimeout

public final void setTaskExecutionTimeout(int value)

Description copied from interface: IJob

Sets the timeout for task execution in milliseconds.

TaskExecutionTimeout is the number of milliseconds that a task can run before it is considered timed out. The TaskExecutionTimeout applies to the task execution, it does not include TaskEnvironment setup time or the time duration that passes after a task has been submitted.

Specified by:

setTaskExecutionTimeout in interface IJob

Parameters:

value - Timeout (in milliseconds)

getPriority

public final JobPriority getPriority()

Gets the job priority. Jobs with higher priorities will be run before jobs with lower priorities. The default job priority is JobPriority.Normal.

setPriority

public final void setPriority(JobPriority value)

Sets the job priority. Jobs with higher priorities will be run before jobs with lower priorities. The default job priority is JobPriority.Normal.

getAgentSelectionPreference

public final AgentSelectionType getAgentSelectionPreference()

Description copied from interface: IJob

Gets the agent selection preference.

Specified by:

getAgentSelectionPreference in interface IJob

Returns:

The agent selection preference.

setAgentSelectionPreference

public final void setAgentSelectionPreference(AgentSelectionType value)

Description copied from interface: IJob

Sets the agent selection preference.

Specified by:

setAgentSelectionPreference in interface IJob

Parameters:

value - The agent selection preference.

getName

public final java.lang.String getName()

Description copied from interface: IJob

Gets the Job name.

Specified by:

getName in interface IJob

Returns:

Job name.

setName

public final void setName(java.lang.String value)

Description copied from interface: IJob

Sets the Job name.

Specified by:

setName in interface IJob

Parameters:

value - Job name.

getDescription

public final java.lang.String getDescription()

Description copied from interface: IJob

Gets the Job description.

Specified by:

getDescription in interface IJob

Returns:

The description.

setDescription

public final void setDescription(java.lang.String value)

Description copied from interface: IJob

Sets the Job description.

Specified by:

setDescription in interface IJob

Parameters:

value - The description.

getIsCanceled

public final boolean getIsCanceled()

Description copied from interface: IJob

Gets a value indicating whether this job has been canceled.

Specified by:

getIsCanceled in interface IJob

Returns:

true if the job is canceled; otherwise, false.

addTask

public final void addTask(Task task)
                   throws java.lang.IllegalArgumentException

Description copied from interface: IJob

Adds a task to Job.

Specified by:

addTask in interface IJob

Parameters:

task - The task to be added to Job.

Throws:

java.lang.IllegalArgumentException

submit

public final void submit()
                  throws JobSchedulerException

Description copied from interface: IJob

Submits job to job scheduler.

Specified by:

submit in interface IJob

Throws:

JobSchedulerException - If error occurs with job scheduler.

waitUntilDone

public final boolean waitUntilDone()
                            throws JobSchedulerException

Description copied from interface: IJob

Blocks until all tasks in this job complete.

Specified by:

waitUntilDone in interface IJob

Returns:

True if the call completed without timing out.

Throws:

JobSchedulerException - If error occurs with job scheduler such as the client timing out.

waitUntilDone

public final boolean waitUntilDone(int millisecondsTimeout)
                            throws JobSchedulerException

Description copied from interface: IJob

Blocks until all tasks in this job complete or the operation times out.

Specified by:

waitUntilDone in interface IJob

Parameters:

millisecondsTimeout - The number of milliseconds to wait. Pass to wait indefinitely.

Returns:

True if the call completed without timing out.

Throws:

JobSchedulerException - If error occurs with job scheduler such as the client timing out.

waitUntilDone

public final boolean waitUntilDone(int millisecondsTimeout,
                                   java.lang.Runnable heartbeatCallback,
                                   int millisecondsHeartbeat)
                            throws JobSchedulerException

Description copied from interface: IJob

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.

Specified by:

waitUntilDone in interface IJob

Parameters:

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 - If error occurs with job scheduler such as the client timing out.

cancel

public final void cancel()
                  throws JobSchedulerException

Description copied from interface: IJob

Cancels all tasks in this job. Will not listen for cancellation events.

Specified by:

cancel in interface IJob

Throws:

JobSchedulerException

cancel

public final void cancel(boolean listenForCancellationEvent)
                  throws JobSchedulerException

Description copied from interface: IJob

Cancels all tasks in this job.

Specified by:

cancel in interface IJob

Parameters:

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

Throws:

JobSchedulerException