ds.granules.operation

Class ProgressTrackerWidget

java.lang.Object

ds.granules.operation.ProgressTrackerWidget

All Implemented Interfaces:

ProgressTracker

public class ProgressTrackerWidget
extends Object
implements ProgressTracker

An implementation of the ProgressTracker interface.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProgressTrackerWidget(String binding, String jobIdentifier, JobLifecycleObserver jobLifecycleObserver)

Method Summary

Methods

Modifier and Type	Method and Description
int	getCompletionStatus(String taskIdentifier) Retrieve the completion status for a specific taskIdentifier
String	getDeploymentStream(String taskIdentifier) Retrieve the deployment stream associated with a given task.
String	getIdentifier() Retrieve the Job identifier
int	getNumberOfConcurrentDeployments() Gets the number of concurrent deployments.
Enumeration<String>	getTaskIdentifiers() Gets the task identifiers associated with the concurrent deployments
TaskLifecycleMetrics	getTaskLifecycleMetrics(String taskIdentifier) Retrieve the TaskLifecycleMetrics associated with a given task.
protected void	incrementNumberOfDeployments()
boolean	isComplete() Check to see if the Job has completed.
boolean	isSuccessful() Check to see if the Job completed successfully.
String	toString()
protected void	updateTaskExecutionStatus(String binding, String taskIdentifier, TaskLifecycleMetrics taskLifecycleMetrics, String taskDeploymentStream) Updates the task execution status associated with a given task.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProgressTrackerWidget

protected ProgressTrackerWidget(String binding,
                     String jobIdentifier,
                     JobLifecycleObserver jobLifecycleObserver)

Method Detail

getCompletionStatus

public int getCompletionStatus(String taskIdentifier)

Description copied from interface: ProgressTracker

Retrieve the completion status for a specific taskIdentifier

Specified by:

getCompletionStatus in interface ProgressTracker

Returns:

The completion status

getIdentifier

public String getIdentifier()

Description copied from interface: ProgressTracker

Retrieve the Job identifier

Specified by:

getIdentifier in interface ProgressTracker

updateTaskExecutionStatus

protected void updateTaskExecutionStatus(String binding,
                             String taskIdentifier,
                             TaskLifecycleMetrics taskLifecycleMetrics,
                             String taskDeploymentStream)

Updates the task execution status associated with a given task.

Parameters:

binding - The binding for making changes

taskIdentifier - The identifier of the task whose status is being updated

taskLifecycleMetrics - The lifecycle metrics for the task in question.

getTaskLifecycleMetrics

public TaskLifecycleMetrics getTaskLifecycleMetrics(String taskIdentifier)

Description copied from interface: ProgressTracker

Retrieve the TaskLifecycleMetrics associated with a given task.

Specified by:

getTaskLifecycleMetrics in interface ProgressTracker

Parameters:

taskIdentifier - The ID associated with a given task.

Returns:

The lifecycle metrics for the task in question.

getDeploymentStream

public String getDeploymentStream(String taskIdentifier)

Description copied from interface: ProgressTracker

Retrieve the deployment stream associated with a given task.

Specified by:

getDeploymentStream in interface ProgressTracker

Parameters:

taskIdentifier - The ID associated with a given task.

Returns:

The deployment stream associated with the given task.

getNumberOfConcurrentDeployments

public int getNumberOfConcurrentDeployments()

Description copied from interface: ProgressTracker

Gets the number of concurrent deployments. This reflects the number of tasks that have been deployed successfully on a set of resources.

Specified by:

getNumberOfConcurrentDeployments in interface ProgressTracker

Returns:

The number of concurrent deployments.

getTaskIdentifiers

public Enumeration<String> getTaskIdentifiers()

Description copied from interface: ProgressTracker

Gets the task identifiers associated with the concurrent deployments

Specified by:

getTaskIdentifiers in interface ProgressTracker

Returns:

An enumeration of the task identifiers.

isComplete

public boolean isComplete()

Description copied from interface: ProgressTracker

Check to see if the Job has completed.

Specified by:

isComplete in interface ProgressTracker

Returns:

true if it is complete; false otherwise.

isSuccessful

public boolean isSuccessful()

Description copied from interface: ProgressTracker

Check to see if the Job completed successfully.

Specified by:

isSuccessful in interface ProgressTracker

Returns:

true if all the constiuent tasks completed successfully; false otherwise.

incrementNumberOfDeployments

protected void incrementNumberOfDeployments()

toString

public String toString()

Overrides:

toString in class Object