org.jppf.client

Class JPPFJob

java.lang.Object

org.jppf.client.JPPFJob

All Implemented Interfaces:

Serializable, JPPFDistributedJob

public class JPPFJob
extends Object
implements Serializable, JPPFDistributedJob

Instances of this class represent a JPPF submission and hold all the required elements: tasks, execution policy, task listener, data provider, priority, blocking indicator.

This class also provides the API for handling JPPF-annotated tasks and POJO tasks.

All jobs have a name. It can be specified by calling setName(String name). If left unspecified, JPPF will automatically assign a uuid as its value.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JPPFJob() Default constructor, creates a blocking job with no data provider, default SLA values and a priority of 0.
JPPFJob(DataProvider dataProvider) Initialize a blocking job with the specified parameters.
JPPFJob(DataProvider dataProvider, JobSLA jobSLA) Initialize a blocking job with the specified parameters.
JPPFJob(DataProvider dataProvider, JobSLA jobSLA, boolean blocking, TaskResultListener resultsListener) Initialize a job with the specified parameters.
JPPFJob(DataProvider dataProvider, JobSLA jobSLA, JPPFJobMetadata jobMetadata, boolean blocking, TaskResultListener resultsListener) Initialize a job with the specified parameters.
JPPFJob(DataProvider dataProvider, JobSLA jobSLA, TaskResultListener resultsListener) Initialize a non-blocking job with the specified parameters.
JPPFJob(DataProvider dataProvider, TaskResultListener resultsListener) Initialize a non-blocking job with the specified parameters.
JPPFJob(String jobUuid) Default constructor, creates a blocking job with no data provider, default SLA values and a priority of 0.
JPPFJob(TaskResultListener resultsListener) Initialize a non-blocking job with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
void	addJobListener(JobListener listener) Add a listener to the list of job listeners.
JPPFTask	addTask(Object taskObject, Object... args) Add a task to this job.
JPPFTask	addTask(String method, Object taskObject, Object... args) Add a POJO task to this job.
boolean	equals(Object obj)
JobClientSLA	getClientSLA() Get the job SLA for the client side.
DataProvider	getDataProvider() Get the container for data shared between tasks.
JobMetadata	getMetadata() Get the user-defined metadata associated with this job.
String	getName() Get the user-defined display name for this job.
List<JPPFTask>	getPendingTasks() Get the list of tasks that have not yet been executed.
<T> JobPersistence<T>	getPersistenceManager() Get the persistence manager that enables saving and restoring the state of this job.
TaskResultListener	getResultListener() Get the listener that receives notifications of completed tasks.
JobResults	getResults() Get the object that holds the results of executed tasks.
JobSLA	getSLA() Get the service level agreement between the job and the server.
List<JPPFTask>	getTasks() Get the list of tasks to execute.
String	getUuid() Get the universal unique id for this job.
int	hashCode()
boolean	isBlocking() Determine whether the execution of this job is blocking on the client side.
protected Object	readResolve() Resolve this instance after deserialization.
void	removeJobListener(JobListener listener) Remove a listener from the list of job listeners.
void	setBlocking(boolean blocking) Specify whether the execution of this job is blocking on the client side.
void	setClientSLA(JobClientSLA jobClientSLA) Get the service level agreement between the job and the server.
void	setDataProvider(DataProvider dataProvider) Set the container for data shared between tasks.
void	setMetadata(JobMetadata jobMetadata) Set this job's metadata.
void	setName(String name) Set the user-defined display name for this job.
<T> void	setPersistenceManager(JobPersistence<T> persistenceManager) Set the persistence manager that enables saving and restoring the state of this job.
void	setResultListener(TaskResultListener resultsListener) Set the listener that receives notifications of completed tasks.
void	setSLA(JobSLA jobSLA) Get the service level agreement between the job and the server.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JPPFJob

public JPPFJob()

Default constructor, creates a blocking job with no data provider, default SLA values and a priority of 0. This constructor generates a pseudo-random id as a string of 32 hexadecimal characters.

JPPFJob

public JPPFJob(String jobUuid)

Default constructor, creates a blocking job with no data provider, default SLA values and a priority of 0. This constructor generates a pseudo-random id as a string of 32 hexadecimal characters.

Parameters:

jobUuid - the uuid to assign to this job.

JPPFJob

public JPPFJob(DataProvider dataProvider)

Initialize a blocking job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

JPPFJob

public JPPFJob(DataProvider dataProvider,
       JobSLA jobSLA)

Initialize a blocking job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

jobSLA - service level agreement between job and server.

JPPFJob

public JPPFJob(TaskResultListener resultsListener)

Initialize a non-blocking job with the specified parameters.

Parameters:

resultsListener - the listener that receives notifications of completed tasks.

JPPFJob

public JPPFJob(DataProvider dataProvider,
       TaskResultListener resultsListener)

Initialize a non-blocking job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

resultsListener - the listener that receives notifications of completed tasks.

JPPFJob

public JPPFJob(DataProvider dataProvider,
       JobSLA jobSLA,
       TaskResultListener resultsListener)

Initialize a non-blocking job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

jobSLA - service level agreement between job and server.

resultsListener - the listener that receives notifications of completed tasks.

JPPFJob

public JPPFJob(DataProvider dataProvider,
       JobSLA jobSLA,
       boolean blocking,
       TaskResultListener resultsListener)

Initialize a job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

jobSLA - service level agreement between job and server.

blocking - determines whether this job is blocking.

resultsListener - the listener that receives notifications of completed tasks.

JPPFJob

public JPPFJob(DataProvider dataProvider,
       JobSLA jobSLA,
       JPPFJobMetadata jobMetadata,
       boolean blocking,
       TaskResultListener resultsListener)

Initialize a job with the specified parameters.

Parameters:

dataProvider - the container for data shared between tasks.

jobSLA - service level agreement between job and server.

jobMetadata - the user-defined job metadata.

blocking - determines whether this job is blocking.

resultsListener - the listener that receives notifications of completed tasks.

Method Detail

getUuid

public String getUuid()

Description copied from interface: JPPFDistributedJob

Get the universal unique id for this job.

Specified by:

getUuid in interface JPPFDistributedJob

Returns:

the uuid as a string.

getName

public String getName()

Description copied from interface: JPPFDistributedJob

Get the user-defined display name for this job. This is the name displayed in the administration console.

Specified by:

getName in interface JPPFDistributedJob

Returns:

the name as a string.

setName

public void setName(String name)

Set the user-defined display name for this job.

Parameters:

name - the display name as a string.

getTasks

public List<JPPFTask> getTasks()

Get the list of tasks to execute.

Returns:

a list of objects.

getPendingTasks

public List<JPPFTask> getPendingTasks()

Get the list of tasks that have not yet been executed.

Returns:

a list of JPPFTask objects.

addTask

public JPPFTask addTask(Object taskObject,
               Object... args)
                 throws JPPFException

Add a task to this job. This method is for adding a task that is either an instance of JPPFTask, annotated with JPPFRunnable, or an instance of Runnable or Callable.

Parameters:

taskObject - the task to add to this job.

args - arguments to use with a JPPF-annotated class.

Returns:

an instance of JPPFTask that is either the same as the input if the input is a subclass of JPPFTask, or a wrapper around the input object in the other cases.

Throws:

JPPFException - if one of the tasks is neither a JPPFTask or a JPPF-annotated class.

addTask

public JPPFTask addTask(String method,
               Object taskObject,
               Object... args)
                 throws JPPFException

Add a POJO task to this job. The POJO task is identified as a method name associated with either an object for a non-static method, or a class for a static method or for a constructor.

Parameters:

taskObject - the task to add to this job.

method - the name of the method to execute.

args - arguments to use with a JPPF-annotated class.

Returns:

an instance of JPPFTask that is a wrapper around the input task object.

Throws:

JPPFException - if one of the tasks is neither a JPPFTask or a JPPF-annotated class.

getDataProvider

public DataProvider getDataProvider()

Get the container for data shared between tasks.

Returns:

a DataProvider instance.

setDataProvider

public void setDataProvider(DataProvider dataProvider)

Set the container for data shared between tasks.

Parameters:

dataProvider - a DataProvider instance.

getResultListener

public TaskResultListener getResultListener()

Get the listener that receives notifications of completed tasks.

Returns:

a TaskCompletionListener instance.

setResultListener

public void setResultListener(TaskResultListener resultsListener)

Set the listener that receives notifications of completed tasks.

Parameters:

resultsListener - a TaskCompletionListener instance.

isBlocking

public boolean isBlocking()

Determine whether the execution of this job is blocking on the client side.

Returns:

true if the execution is blocking, false otherwise.

setBlocking

public void setBlocking(boolean blocking)

Specify whether the execution of this job is blocking on the client side.

Parameters:

blocking - true if the execution is blocking, false otherwise.

getSLA

public JobSLA getSLA()

Description copied from interface: JPPFDistributedJob

Get the service level agreement between the job and the server.

Specified by:

getSLA in interface JPPFDistributedJob

Returns:

an instance of JobSLA.

setSLA

public void setSLA(JobSLA jobSLA)

Get the service level agreement between the job and the server.

Parameters:

jobSLA - an instance of JobSLA.

getClientSLA

public JobClientSLA getClientSLA()

Get the job SLA for the client side.

Returns:

an instance of JobSLA.

setClientSLA

public void setClientSLA(JobClientSLA jobClientSLA)

Get the service level agreement between the job and the server.

Parameters:

jobClientSLA - an instance of JobSLA.

getMetadata

public JobMetadata getMetadata()

Description copied from interface: JPPFDistributedJob

Get the user-defined metadata associated with this job.

Specified by:

getMetadata in interface JPPFDistributedJob

Returns:

a JobMetadata instance.

setMetadata

public void setMetadata(JobMetadata jobMetadata)

Set this job's metadata.

Parameters:

jobMetadata - a JPPFJobMetadata instance.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getResults

public JobResults getResults()

Get the object that holds the results of executed tasks.

Returns:

a JobResults instance.

addJobListener

public void addJobListener(JobListener listener)

Add a listener to the list of job listeners.

Parameters:

listener - a JobListener instance.

removeJobListener

public void removeJobListener(JobListener listener)

Remove a listener from the list of job listeners.

Parameters:

listener - a JobListener instance.

getPersistenceManager

public <T> JobPersistence<T> getPersistenceManager()

Get the persistence manager that enables saving and restoring the state of this job.

Type Parameters:

T - the type of the keys used by the persistence manager.

Returns:

a JobPersistence instance.

setPersistenceManager

public <T> void setPersistenceManager(JobPersistence<T> persistenceManager)

Set the persistence manager that enables saving and restoring the state of this job.

Type Parameters:

T - the type of the keys used by the persistence manager.

Parameters:

persistenceManager - a JobPersistence instance.

readResolve

protected Object readResolve()

Resolve this instance after deserialization.

Returns:

an instance of Object.

toString

public String toString()

Overrides:

toString in class Object