ds.granules.exchange

Class DeploymentMessage

java.lang.Object

ds.granules.exchange.Exchange

ds.granules.exchange.DeploymentMessage

public class DeploymentMessage
extends Exchange

This class encapsulates the exchanges related to the deployment of an application instance.

Author:

Shrideep Pallickara

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORT
static int	DEPLOY
static int	STATUS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DeploymentMessage() The null constructor for the DeploymnetMessage
protected	DeploymentMessage(String jobIdentifier, Operation operation, String respondTo) Creates a deployment message based on the specified parameters.
protected	DeploymentMessage(String jobIdentifier, String taskIdentifier, int exchangeSubType, int conditionFlag, String description) Creates a deployment response, to a previously issued request.
protected	DeploymentMessage(String jobIdentifier, String taskIdentifier, String respondTo, int exchangeSubType) Creates a DeploymentMessage that is a request for either getting the STATUS or ABORTing a previously deployment operation.

Method Summary

Methods

Modifier and Type	Method and Description
String	getClassName()
String	getJobIdentifier()
Operation	getOperation()
String	getTaskIdentifier()
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

Field Detail

DEPLOY

public static final int DEPLOY

See Also:

Constant Field Values

STATUS

public static final int STATUS

See Also:

Constant Field Values

ABORT

public static final int ABORT

See Also:

Constant Field Values

Constructor Detail

DeploymentMessage

protected DeploymentMessage()

The null constructor for the DeploymnetMessage

DeploymentMessage

protected DeploymentMessage(String jobIdentifier,
                 Operation operation,
                 String respondTo)
                     throws DeploymentException

Creates a deployment message based on the specified parameters.

Parameters:

jobIdentifier - The ID to be associated with the deployment

operation - The operation being deployed

respondTo - The stream over which responses need to be sent.

Throws:

DeploymentException - If problems are encountered with the specified parameters, or if any of them are NULL.

DeploymentMessage

protected DeploymentMessage(String jobIdentifier,
                 String taskIdentifier,
                 String respondTo,
                 int exchangeSubType)
                     throws DeploymentException

Creates a DeploymentMessage that is a request for either getting the STATUS or ABORTing a previously deployment operation.

Parameters:

jobIdentifier - The ID to be associated with the deployment

taskIdentifier - The task identifier that was assigned to one of the constituent tasks that comprises the system-wide deployment.

respondTo - The stream over which responses need to be sent.

exchangeSubType - This should be either the STATUS or ABORT exchange subTypes.

Throws:

DeploymentException - If problems are encountered with the specified parameters, or if any of them are NULL or if the exchangeSubType is something other than DeploymentMessage.STATUS or DeploymentMessage.ABORT

DeploymentMessage

protected DeploymentMessage(String jobIdentifier,
                 String taskIdentifier,
                 int exchangeSubType,
                 int conditionFlag,
                 String description)
                     throws DeploymentException

Creates a deployment response, to a previously issued request. This includes the task identifiers and the exchangeSUbType, which indicates whether this is a response to a previously issued DEPLOY, STATUS or ABORT request. A condition flag is also included in some cases to indicate the status of processing the previously issued request. The description element includes a detailed description of the response.

Parameters:

jobIdentifier - The ID to be associated with the deployment

taskIdentifier - The task identifier that was assigned to one of the constituent tasks that comprises the system-wide deployment.

exchangeSubType - Indicates whether this is a response to a previously issued DEPLOY, STATUS or ABORT

conditionFlag - Indicates the status of processing the previously issued request.

description - A detailed description or reason for the response

Throws:

DeploymentException

Method Detail

getJobIdentifier

public String getJobIdentifier()

Returns:

the jobIdentifier

getOperation

public Operation getOperation()

Returns:

the operation

getClassName

public String getClassName()

Returns:

the className

getTaskIdentifier

public String getTaskIdentifier()

Returns:

the taskIdentifier

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

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.