ds.granules.exchange

Class Exchange

java.lang.Object

ds.granules.exchange.Exchange

Direct Known Subclasses:

DeploymentMessage, ExecutionStatus, ResourceDiscovery

public abstract class Exchange
extends Object

This is the base class for exchanges. All specific exchanges need to extend this class and override the abstract methods. This class utilizes the template pattern to marshall and reconstruct the various exchange types.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
Exchange()

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getBytes() Retrieve the byte[] representation of the exchange.
int	getConditionFlag()
String	getDescription() Retrieve the description associated with this exchange.
int	getExchangeSubType()
int	getExchangeType()
String	getIdentifier()
String	getRespondTo() Retrieve the respondTo field for this exchange.
long	getTimestamp() Retrieve the timestamp for this exchange.
boolean	isRequest() Indicates whether this exchange is a Request
boolean	isResponse() Indicates whether this exchange is a Response to a previously issued request.
abstract boolean	isValidExchangeSubType() Checks to see if the exchange sub-type in the reconstructed exchange is a valid one.
abstract 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.
void	reconstruct(byte[] marshalledBytes) Reconstruct the exchange from the byte[] representation.
protected void	setConditionFlag(int conditionFlag)
protected void	setDescription(String description)
protected void	setExchangeSubType(int exchangeSubType)
void	setExchangeType(int exchangeType)
protected void	setIdentifier(String identifier)
protected void	setRequest() Sets this exchange as a request.
void	setRespondTo(String respondTo) Set the repondTo field for this exchange.
protected void	setResponse() Sets this exchange as a reponse.
void	setTimestamp(long timestamp) Set the timestamp for this exchange.
abstract 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 java.lang.Object

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

Constructor Detail

Exchange

public Exchange()

Method Detail

getBytes

public final byte[] getBytes()
                      throws ds.funnel.data.format.FormatException

Retrieve the byte[] representation of the exchange.

Returns:

The byte[] representation of the exchange.

Throws:

IOException - If there are IO problems while performing this operation.

MarshallingException - If there are Marshalling problems while performing this operation.

ds.funnel.data.format.FormatException

reconstruct

public final void reconstruct(byte[] marshalledBytes)
                       throws ds.funnel.data.format.FormatException

Reconstruct the exchange from the byte[] representation.

Parameters:

marshalledBytes - The byte[] representation of the exchange.

Throws:

IOException - If there are IO problems while performing this operation.

MarshallingException - If there are Marshalling problems while performing this operation.

ds.funnel.data.format.FormatException

isValidExchangeSubType

public abstract boolean isValidExchangeSubType()

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

Returns:

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

marshallExchangeSpecificElements

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

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.

Parameters:

mFormat - The buffer formatter to write to.

Throws:

IOException - If there are IO problems while performing this operation.

MarshallingException - If there are Marshalling problems while performing this operation.

ds.funnel.data.format.FormatException

unmarshallExchangeSpecificElements

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

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.

Parameters:

mFormat - The buffer formatter to read from.

Throws:

IOException - If there are IO problems while performing this operation.

MarshallingException - If there are Marshalling problems while performing this operation.

ds.funnel.data.format.FormatException

setExchangeType

public void setExchangeType(int exchangeType)

Parameters:

exchangeType - The exchangeType to set

getExchangeType

public int getExchangeType()

Returns:

the exchangeType

isRequest

public boolean isRequest()

Indicates whether this exchange is a Request

Returns:

true if this exchange is a request; false otherwise.

isResponse

public boolean isResponse()

Indicates whether this exchange is a Response to a previously issued request.

Returns:

true if the exchange is a reponse; false otherwise.

setRequest

protected void setRequest()

Sets this exchange as a request.

setResponse

protected void setResponse()

Sets this exchange as a reponse.

setExchangeSubType

protected void setExchangeSubType(int exchangeSubType)

Parameters:

exchangeSubType - The exchangeSubType to set

getExchangeSubType

public int getExchangeSubType()

Returns:

the exchangeSubType

setConditionFlag

protected void setConditionFlag(int conditionFlag)

Parameters:

conditionFlag - The conditionFlag to set

getConditionFlag

public int getConditionFlag()

Returns:

the conditionFlag

setIdentifier

protected void setIdentifier(String identifier)

Parameters:

identifier - The identifier to set

getIdentifier

public String getIdentifier()

Returns:

the identifier

setDescription

protected void setDescription(String description)

Parameters:

description - the description to set

getDescription

public String getDescription()

Retrieve the description associated with this exchange. Typically, this field is used to summarize the exchange in plain English.

Returns:

the description

setRespondTo

public void setRespondTo(String respondTo)

Set the repondTo field for this exchange.

Parameters:

respondTo - The respondTo to set

getRespondTo

public String getRespondTo()

Retrieve the respondTo field for this exchange.

Returns:

the respondTo

setTimestamp

public void setTimestamp(long timestamp)

Set the timestamp for this exchange.

Parameters:

timestamp - The timestamp to set

getTimestamp

public long getTimestamp()

Retrieve the timestamp for this exchange.

Returns:

the timestamp