ds.granules.operation

Class JobSubmission

java.lang.Object

ds.granules.operation.JobSubmission

public class JobSubmission
extends java.lang.Object

This class manages the submission, tracking and cancellation of Jobs and their constituent tasks.

Author:

Shrideep Pallickara

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODULE

Constructor Summary

Constructors

Constructor and Description
JobSubmission()

Method Summary

Modifier and Type	Method and Description
void	abortTask(java.lang.String jobIdentifier, java.lang.String taskIdentifier) Send an abort request for a specific task.
java.lang.String	createJobIdentifier() Creates a Job Identifier
ProgressTracker	deploy(Operation[] operations, int numOfResources, java.lang.String jobIdentifier, JobLifecycleObserver jobLifecycleObserver)
void	discoverResource() Discovers the available computational resources.
void	discoverResource(int wait) Discovers the available computational resources.
static JobSubmission	getInstance() Deprecated.
java.util.Enumeration<java.lang.String>	getListOfJobs() Get the complete list of jobs that have been submitted from this node.
int	getNumberOfAvailableResources() Retrieves the number of available resources.
int	getNumberOfResources()
java.util.Collection<java.lang.String>	getResourceDeploymentStreams() Retrieves the currently-available resource deployment streams known by the JobSubmission singleton instance.
java.util.Collection<java.lang.String>	getResourceDeploymentStreams(java.util.Collection<java.lang.String> exclusions) Retrieves the currently-available resource deployment streams known by the JobSubmission singleton instance.
java.lang.String	getStatus() This method returns a String representation of the status of all jobs that have been submitted from this node.
ProgressTracker	getStatusOfJob(java.lang.String jobIdentifier) Retrieve the status of a specific job that was submitted from this node.
void	getStatusOfTask(java.lang.String jobIdentifier, java.lang.String taskIdentifier) Retrieve the status of a task.
void	initialize(java.lang.String configurationFile, int entityId, java.util.Properties props, java.lang.String commType) Initializes communications based on the specified parameters.
void	killJob(java.lang.String jobIdentifier) Attempts to kill the job while it is in execution at different sites
ProgressTracker	submit(Operation operation, JobLifecycleObserver jobLifecycleObserver) Submit the given operation for execution.
ProgressTracker	submit(Operation operation, java.lang.String resourceDeploymentStream, JobLifecycleObserver jobLifecycleObserver) Submit the given operation for execution.
ProgressTracker	submit(Operation operation, java.lang.String resourceDeploymentStream, java.lang.String jobIdentifier, JobLifecycleObserver jobLifecycleObserver) This method allows one to group a set of related tasks together in a Job.

Methods inherited from class java.lang.Object

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

Field Detail

MODULE

public static final java.lang.String MODULE

See Also:

Constant Field Values

Constructor Detail

JobSubmission

public JobSubmission()

Method Detail

getInstance

@Deprecated
public static JobSubmission getInstance()

Deprecated.

initialize

public void initialize(java.lang.String configurationFile,
                       int entityId,
                       java.util.Properties props,
                       java.lang.String commType)
                throws CommunicationsException

Initializes communications based on the specified parameters.

Parameters:

configurationFile - The configuration file

entityId - The ID for the entity

props - The properties for streaming

commType - The communications type

Throws:

CommunicationsException - If there are problems sending messages over the network

discoverResource

public void discoverResource()
                      throws java.io.IOException,
                             MarshallingException,
                             CommunicationsException,
                             DeploymentException

Discovers the available computational resources.

Throws:

java.io.IOException

MarshallingException

CommunicationsException

DeploymentException

discoverResource

public void discoverResource(int wait)
                      throws java.io.IOException,
                             MarshallingException,
                             CommunicationsException,
                             DeploymentException

Discovers the available computational resources.

Parameters:

wait - Number of half-second intervals to wait for the discovery to complete. For small networks, this could be lower than the default of 6.

Throws:

java.io.IOException

MarshallingException

CommunicationsException

DeploymentException

getNumberOfAvailableResources

public int getNumberOfAvailableResources()

Retrieves the number of available resources.

Returns:

Number of available resources

getResourceDeploymentStreams

public java.util.Collection<java.lang.String> getResourceDeploymentStreams()

Retrieves the currently-available resource deployment streams known by the JobSubmission singleton instance. The results returned by this method will be the last cached values unless discoverResource() is called by the client prior to invocation.

Returns:

List of deployment streams (String values)

getResourceDeploymentStreams

public java.util.Collection<java.lang.String> getResourceDeploymentStreams(java.util.Collection<java.lang.String> exclusions)

Retrieves the currently-available resource deployment streams known by the JobSubmission singleton instance. The results returned by this method will be the last cached values unless discoverResource() is called by the client prior to invocation.

Returns:

List of deployment streams (String values)

createJobIdentifier

public java.lang.String createJobIdentifier()

Creates a Job Identifier

Returns:

The created job identifier.

submit

public ProgressTracker submit(Operation operation,
                              JobLifecycleObserver jobLifecycleObserver)
                       throws CommunicationsException,
                              DeploymentException,
                              MarshallingException

Submit the given operation for execution. A given operation can be executed at multiple nodes. The operation returns a JobLifecyle Object that allows an entity to track that status of the JOb's execution at different stages.

Parameters:

operation - The operation that needs to be executed at the remote sites

jobLifecycleObserver - The observer being registered, and on whom the appropriate methods outlining the executing of the job will be invoked.

Returns:

The JobLifecycle object that allows one to track the status of the individual tasks that comprise the Job

Throws:

CommunicationsException - If there are problems sending messages over the network

DeploymentException - If there are problems during the deployment process

MarshallingException - If there are problems Marshalling the operation in a deployment request

submit

public ProgressTracker submit(Operation operation,
                              java.lang.String resourceDeploymentStream,
                              JobLifecycleObserver jobLifecycleObserver)
                       throws CommunicationsException,
                              DeploymentException,
                              MarshallingException

Submit the given operation for execution. The submission request is targeted to a specific resource. A given operation can be executed at multiple nodes. The operation returns a JobLifecyle Object that allows an entity to track that status of the JOb's execution at different stages.

Parameters:

operation - The operation that needs to be executed at the remote sites

resourceDeploymentStream - The deployment stream associated with the resource.

jobLifecycleObserver - The observer being registered, and on whom the appropriate methods outlining the executing of the job will be invoked.

Returns:

The JobLifecycle object that allows one to track the status of the individual tasks that comprise the Job

Throws:

CommunicationsException - If there are problems sending messages over the network

DeploymentException - If there are problems during the deployment process

MarshallingException - If there are problems Marshalling the operation in a deployment request

submit

public ProgressTracker submit(Operation operation,
                              java.lang.String resourceDeploymentStream,
                              java.lang.String jobIdentifier,
                              JobLifecycleObserver jobLifecycleObserver)
                       throws CommunicationsException,
                              DeploymentException,
                              MarshallingException

This method allows one to group a set of related tasks together in a Job. The specified jobIdentifier should have been previously created using the createJobIdentifier() method.

Parameters:

operation - The operation that needs to be executed at the remote sites

resourceDeploymentStream - The deployment stream associated with the resource.

jobIdentifier - The identifier of the Job group.

jobLifecycleObserver - The observer being registered, and on whom the appropriate methods outlining the executing of the job will be invoked.

Returns:

The JobLifecycle object that allows one to track the status of the individual tasks that comprise the Job

Throws:

CommunicationsException - If there are problems sending messages over the network

DeploymentException - if there are problems during the deployment process * @throws DeploymentException

MarshallingException - If there are problems Marshalling the operation in a deployment request

killJob

public void killJob(java.lang.String jobIdentifier)
             throws DeploymentException,
                    CommunicationsException,
                    MarshallingException

Attempts to kill the job while it is in execution at different sites

Parameters:

jobIdentifier - The ID of the Job that needs to be killed

Throws:

DeploymentException - If there are problems in locating the job, or if it has already been completed or canceled

MarshallingException - If there are problems marshalling the request

CommunicationsException - If there are problems sending the request over the network.

abortTask

public void abortTask(java.lang.String jobIdentifier,
                      java.lang.String taskIdentifier)
               throws CommunicationsException,
                      DeploymentException,
                      MarshallingException

Send an abort request for a specific task.

Parameters:

jobIdentifier - The Job that this task is a part of

taskIdentifier - The ID of the task that needs to be aborted

Throws:

DeploymentException - If there are problems in locating the job, or if it has already been completed or canceled

CommunicationsException

MarshallingException

getStatusOfTask

public void getStatusOfTask(java.lang.String jobIdentifier,
                            java.lang.String taskIdentifier)
                     throws CommunicationsException,
                            DeploymentException,
                            MarshallingException

Retrieve the status of a task.

Parameters:

jobIdentifier -

taskIdentifier -

Throws:

CommunicationsException

DeploymentException

MarshallingException

getStatus

public java.lang.String getStatus()

This method returns a String representation of the status of all jobs that have been submitted from this node.

Returns:

A String representation of the status of all jobs.

getStatusOfJob

public ProgressTracker getStatusOfJob(java.lang.String jobIdentifier)

Retrieve the status of a specific job that was submitted from this node.

Parameters:

jobIdentifier - The id of the job in question

Returns:

ProgressTracker associated with the job, or NULL if the specified id is an invalid one.

getListOfJobs

public java.util.Enumeration<java.lang.String> getListOfJobs()

Get the complete list of jobs that have been submitted from this node.

Returns:

An enumeration of the submitted jobs.

deploy

public ProgressTracker deploy(Operation[] operations,
                              int numOfResources,
                              java.lang.String jobIdentifier,
                              JobLifecycleObserver jobLifecycleObserver)
                       throws CommunicationsException,
                              DeploymentException,
                              MarshallingException

Throws:

CommunicationsException

DeploymentException

MarshallingException

getNumberOfResources

public int getNumberOfResources()