ds.granules.operation

Class InstanceDeployer

java.lang.Object

ds.granules.operation.InstanceDeployer

All Implemented Interfaces:

JobLifecycleObserver

Direct Known Subclasses:

ECGDeployer, EEGDeployer, RespirationMonitorDeployer, UpperCaseDeployer, WordCountDeployer

public class InstanceDeployer
extends java.lang.Object
implements JobLifecycleObserver

This is a class that encapsulates several of the functionality that need to be supported by Granules application deployers. By extending this class, application-specific deployers are easier to develop.

Author:

Shrideep Pallickara

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
InstanceDeployer()

Method Summary

Modifier and Type	Method and Description
void	completedExecution(java.lang.String jobIdentifier, java.lang.String taskIdentifier, TaskLifecycleMetrics taskLifecycleMetrics) This method is invoked when a task has completed execution either successfully or due to an abnormal termination or previously issued abort request.
void	completedSuccessfully(java.lang.String jobIdentifier, ProgressTracker progressTracker) This method is invoked when all the constituent distributed tasks have finished executing successfully.
void	completedWithErrors(java.lang.String jobIdentifier, ProgressTracker progressTracker) This method is invoked when we have heard from all the sub-tasks, and one or more errors have been encountered in the execution of constituent tasks.
java.lang.String	createJobIdentifier() Create a Job Identifier.
ProgressTracker	deployOperations(Operation[] operations) This method deploys a set of operations on a specified number of resources.
ProgressTracker	deployOperations(Operation[] operations, int numOfResources, java.lang.String jobIdentifier) This method deploys a set of operations on a specified number of resources.
ProgressTracker	deployOperations(Operation[] operations, java.lang.String jobIdentifier) This method deploys a set of operations on the set of available resources.
java.lang.String	getStatus() Returns the status of all Jobs that have been submitted from this node in question.
void	initialize(java.util.Properties streamingProperties) This initializes the deployer based on the specified argument.
void	initialize(java.util.Properties streamingProperties, java.lang.String commType) This initializes the deployer based on the specified arguments.
void	initialize(java.lang.String configurationFile, int entityId, java.util.Properties props, java.lang.String commType) This initializes the deployer based on the specified arguments.
void	killJob(java.lang.String jobIdentifier) Kill a Job with specified jobIdentifer
void	refreshStatus(java.lang.String jobIdentifier) This method refreshes the status of various tasks that comprise a Job.
void	refreshStatus(java.lang.String jobIdentifier, java.lang.String taskIdentifier) This method refreshes the status of a specific task that is part of the Job in question.
void	resetTrackers() Resets the task completion counts maintained by this class.
void	setStartTime() Resets the start timer which tracks the time at which an application began execution.
void	startedExecution(java.lang.String jobIdentifier, java.lang.String taskIdentifier, TaskLifecycleMetrics taskLifecycleMetrics) This method is invoked when the first task reports that it has begun execution.

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

InstanceDeployer

public InstanceDeployer()

Method Detail

setStartTime

public void setStartTime()

Resets the start timer which tracks the time at which an application began execution.

resetTrackers

public void resetTrackers()

Resets the task completion counts maintained by this class. These counts are updated as the application progresses in its distributed execution.

createJobIdentifier

public java.lang.String createJobIdentifier()

Create a Job Identifier.

Returns:

A UUID representing the Job identifier that was created.

initialize

public void initialize(java.util.Properties streamingProperties)
                throws CommunicationsException,
                       java.io.IOException,
                       MarshallingException,
                       DeploymentException

This initializes the deployer based on the specified argument. This includes initializing communications based on the specified parameters and also discovering resources.

Parameters:

streamingProperties - The properties for streaming

Throws:

CommunicationsException - If there are problems during network communications.

java.io.IOException - If there are IO problems.

MarshallingException - If there are problems marshalling the requests.

DeploymentException - If no resources are available.

initialize

public void initialize(java.util.Properties streamingProperties,
                       java.lang.String commType)
                throws CommunicationsException,
                       java.io.IOException,
                       MarshallingException,
                       DeploymentException

This initializes the deployer based on the specified arguments. This includes initializing communications based on the specified parameters and also discovering resources.

Parameters:

streamingProperties - The properties for streaming

commType - The communications type

Throws:

CommunicationsException - If there are problems during network communications.

java.io.IOException - If there are IO problems.

MarshallingException - If there are problems marshalling the requests.

DeploymentException - If no resources are available.

initialize

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

This initializes the deployer based on the specified arguments. This includes initializing communications based on the specified parameters and also discovering resources.

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 during network communications.

java.io.IOException - If there are IO problems.

MarshallingException - If there are problems marshalling the requests.

DeploymentException - If no resources are available.

deployOperations

public ProgressTracker deployOperations(Operation[] operations)
                                 throws CommunicationsException,
                                        DeploymentException,
                                        MarshallingException

This method deploys a set of operations on a specified number of resources.

Parameters:

operations - The set of operations that need to be deployed.

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 during network communications.

DeploymentException - If there are deployment related exceptions that are reported. One reason why this might happen is if the number of requested resources exceeds the number of available resources.

MarshallingException - If there are problems marshalling the requests.

deployOperations

public ProgressTracker deployOperations(Operation[] operations,
                                        java.lang.String jobIdentifier)
                                 throws CommunicationsException,
                                        DeploymentException,
                                        MarshallingException

This method deploys a set of operations on the set of available resources. All operations will be part of the Job identified by the jobIdentifier argument.

Parameters:

operations - The set of operations that need to be deployed.

jobIdentifier - The identifier that groups these operations together.

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 during network communications.

DeploymentException - If there are deployment related exceptions that are reported. One reason why this might happen is if the number of requested resources exceeds the number of available resources.

MarshallingException - If there are problems marshalling the requests.

deployOperations

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

This method deploys a set of operations on a specified number of resources. All operations will be part of the Job identified by the jobIdentifier argument.

Parameters:

operations - The set of operations that need to be deployed.

numOfResources - The number of resources on which this needs to be deployed.

jobIdentifier - The identifier that groups these operations together.

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 during network communications.

DeploymentException - If there are deployment related exceptions that are reported. One reason why this might happen is if the number of requested resources exceeds the number of available resources.

MarshallingException - If there are problems marshalling the requests.

getStatus

public java.lang.String getStatus()

Returns the status of all Jobs that have been submitted from this node in question.

refreshStatus

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

This method refreshes the status of various tasks that comprise a Job. DIstributed resources will be contacted to retrieve the most up-to-date status of the tasks.

Parameters:

jobIdentifier - The ID of the Job that needs to refreshed.

Throws:

CommunicationsException - If there are problems during network communications.

DeploymentException - If there are deployment related exceptions that are reported

MarshallingException - If there are problems marshalling the requests.

refreshStatus

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

This method refreshes the status of a specific task that is part of the Job in question. Distributed resources will be contacted to retrieve the most up-to-date status of this task.

Parameters:

jobIdentifier - The ID of the Job that needs to refreshed.

taskIdentifier - The ID of the Task that needs to refreshed.

Throws:

CommunicationsException - If there are problems during network communications.

DeploymentException - If there are deployment related exceptions that are reported

MarshallingException - If there are problems marshalling the requests.

killJob

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

Kill a Job with specified jobIdentifer

Parameters:

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

Throws:

DeploymentException - If there are deployment related exceptions that are reported

CommunicationsException - If there are problems during network communications.

MarshallingException - If there are problems marshalling the request.

completedExecution

public void completedExecution(java.lang.String jobIdentifier,
                               java.lang.String taskIdentifier,
                               TaskLifecycleMetrics taskLifecycleMetrics)

Description copied from interface: JobLifecycleObserver

This method is invoked when a task has completed execution either successfully or due to an abnormal termination or previously issued abort request. Invoking the taskLifecycleMetrics.getExecutionStatus() method and comparing it to the constants in the metrics, reveals the completion status of the task.

Specified by:

completedExecution in interface JobLifecycleObserver

Parameters:

jobIdentifier - The ID of the Job being reported on

taskIdentifier - The taskId of one of the constituent tasks

taskLifecycleMetrics - The metrics associated with the task in question.

completedSuccessfully

public void completedSuccessfully(java.lang.String jobIdentifier,
                                  ProgressTracker progressTracker)

Description copied from interface: JobLifecycleObserver

This method is invoked when all the constituent distributed tasks have finished executing successfully.

Specified by:

completedSuccessfully in interface JobLifecycleObserver

Parameters:

jobIdentifier - The ID of the Job being reported on

progressTracker - Contains information about the lifecycle metrics associated with the constituent tasks.

completedWithErrors

public void completedWithErrors(java.lang.String jobIdentifier,
                                ProgressTracker progressTracker)

Description copied from interface: JobLifecycleObserver

This method is invoked when we have heard from all the sub-tasks, and one or more errors have been encountered in the execution of constituent tasks.

Specified by:

completedWithErrors in interface JobLifecycleObserver

Parameters:

jobIdentifier - The ID of the Job being reported on

progressTracker - Contains information about the lifecycle metrics associated with the constituent tasks.

startedExecution

public void startedExecution(java.lang.String jobIdentifier,
                             java.lang.String taskIdentifier,
                             TaskLifecycleMetrics taskLifecycleMetrics)

Description copied from interface: JobLifecycleObserver

This method is invoked when the first task reports that it has begun execution.

Specified by:

startedExecution in interface JobLifecycleObserver

Parameters:

jobIdentifier - The ID of the Job being reported on

taskIdentifier - The taskId of one of the constituent tasks that has started execution.

taskLifecycleMetrics - The metrics associated with the task in question.