ds.granules.exchange

Class ExecutionStatus

java.lang.Object

ds.granules.exchange.Exchange

ds.granules.exchange.ExecutionStatus

public class ExecutionStatus
extends Exchange

This class encapsulates exchanges related to retrieving the status of a message.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExecutionStatus()
protected	ExecutionStatus(String jobIdentifier, String taskIdentifier, int conditionFlag, String description, TaskLifecycleMetrics taskLifecycleMetrics, String respondTo)
protected	ExecutionStatus(String jobIdentifier, String taskIdentifier, String respondTo)

Method Summary

Methods

Modifier and Type	Method and Description
String	getJobIdentifier()
String	getTaskIdentifier()
TaskLifecycleMetrics	getTaskLifecycleMetrics() Retrieve the TaskLifecycleMetrics associated with the RESPONSE.
boolean	isValidExchangeSubType() Checks to see if the exchange sub-type in the reconstructed exchange is a valid one.
void	marshallExchangeSpecificElements(ds.funnel.data.format.FormatWriter mFormat) This method is utilized by the derived classes to marshall (or serialize) elements that are specific to the derived class.
String	toString()
void	unmarshallExchangeSpecificElements(ds.funnel.data.format.FormatReader mFormat) This method is utilized by the derived classes to reconstruct elements that are specific to the derived class.

Methods inherited from class ds.granules.exchange.Exchange

getBytes, getConditionFlag, getDescription, getExchangeSubType, getExchangeType, getIdentifier, getRespondTo, getTimestamp, isRequest, isResponse, reconstruct, setConditionFlag, setDescription, setExchangeSubType, setExchangeType, setIdentifier, setRequest, setRespondTo, setResponse, setTimestamp

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionStatus

protected ExecutionStatus()

ExecutionStatus

protected ExecutionStatus(String jobIdentifier,
               String taskIdentifier,
               String respondTo)

ExecutionStatus

protected ExecutionStatus(String jobIdentifier,
               String taskIdentifier,
               int conditionFlag,
               String description,
               TaskLifecycleMetrics taskLifecycleMetrics,
               String respondTo)

Method Detail

isValidExchangeSubType

public boolean isValidExchangeSubType()

Description copied from class: Exchange

Checks to see if the exchange sub-type in the reconstructed exchange is a valid one.

Specified by:

isValidExchangeSubType in class Exchange

Returns:

true If the exchange subType is a valid one, or false otherwise.

getJobIdentifier

public String getJobIdentifier()

Returns:

the jobIdentifier

getTaskIdentifier

public String getTaskIdentifier()

Returns:

the taskIdentifier

getTaskLifecycleMetrics

public TaskLifecycleMetrics getTaskLifecycleMetrics()

Retrieve the TaskLifecycleMetrics associated with the RESPONSE.

Returns:

The taskLifecycle metrics for a task.

marshallExchangeSpecificElements

public void marshallExchangeSpecificElements(ds.funnel.data.format.FormatWriter mFormat)
                                      throws ds.funnel.data.format.FormatException

Description copied from class: Exchange

This method is utilized by the derived classes to marshall (or serialize) elements that are specific to the derived class. All the base class elements (which are identified by the accessor methods) are handled by the base class even though it is an abstract class.

Specified by:

marshallExchangeSpecificElements in class Exchange

Parameters:

mFormat - The buffer formatter to write to.

Throws:

ds.funnel.data.format.FormatException

unmarshallExchangeSpecificElements

public void unmarshallExchangeSpecificElements(ds.funnel.data.format.FormatReader mFormat)
                                        throws ds.funnel.data.format.FormatException

Description copied from class: Exchange

This method is utilized by the derived classes to reconstruct elements that are specific to the derived class. The unmarshall method will reconstruct the object state based on what was marshalled using the marshall method. All the base class elements (which are identified by the accessor methods) are handled by the base class even though it is an abstract class.

Specified by:

unmarshallExchangeSpecificElements in class Exchange

Parameters:

mFormat - The buffer formatter to read from.

Throws:

ds.funnel.data.format.FormatException

toString

public String toString()

Overrides:

toString in class Object