ds.granules.exchange

Class ExchangeFactory

java.lang.Object

ds.granules.exchange.ExchangeFactory

public class ExchangeFactory
extends Object

This is a singleton class which encapsulates functionality related to creation and reconstructing various exchanges. The ExchangeFactory also incorporates functionality to access various data elements within an exchange.

Author:

Shrideep Pallickara

Constructor Summary

Constructors

Constructor and Description
ExchangeFactory()

Method Summary

Methods

Modifier and Type	Method and Description
DeploymentMessage	createDeploymentResponse(String jobIdentifier, String taskIdentifier, int exchangeSubType, int conditionFlag, String description) Creates a deployment response, to a previously issued request.
DeploymentMessage	createDeploymentStatusOrAbortRequest(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.
DeploymentMessage	createDepoymentRequest(String jobIdentifier, Operation operation, String respondTo) Creates a deployment request based on the specified parameters.
ExecutionStatus	createExecutionStatusRequest(String jobIdentifier, String taskIdentifier, String respondTo) Creates an ExecutionStatus REQUEST based on the specified parameters
ExecutionStatus	createExecutionStatusResponse(String jobIdentifier, String taskIdentifier, int conditionFlag, String description, TaskLifecycleMetrics taskLifecycleMetrics, String respondTo) Creates an ExecutionStatus RESPONSE based on the specified parameters
ResourceDiscovery	createResourceDiscoveryRequest(int resourceType, String respondTo) Create a ResourceDiscovery request
ResourceDiscovery	createResourceDiscoveryResponse(int conditionFlag, String description, ResourceMetrics resourceMetrics, String respondTo) Creates a ResourceDiscovery response
DeploymentMessage	getDeploymentMessage(byte[] exchangeBytes) Reconstructs the Deployment Message from a stream of bytes
int	getExchangeType(byte[] exchangeBytes) Retrieves the exchange type information from a stream of bytes.
ExecutionStatus	getExecutionStatus(byte[] exchangeBytes) Reconstruct the execution status object from a byte[].
static ExchangeFactory	getInstance() Deprecated.
ResourceDiscovery	getResourceDiscovery(byte[] exchangeBytes) Reconstructs the ResourceDiscovery from a stream of bytes
boolean	isValidExchangeType(int exchangeType) Checks to see if a given exchange type is a valid one.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExchangeFactory

public ExchangeFactory()

Method Detail

getInstance

@Deprecated
public static ExchangeFactory getInstance()

Deprecated.

Retrieve the singleton instance for this factory.

Returns:

The singleton instance for this factory.

isValidExchangeType

public boolean isValidExchangeType(int exchangeType)

Checks to see if a given exchange type is a valid one.

Parameters:

exchangeType -

Returns:

true if the exchange is a valid one; false otherwise.

getExchangeType

public int getExchangeType(byte[] exchangeBytes)

Retrieves the exchange type information from a stream of bytes.

Parameters:

exchangeBytes - The marshalled representation of the exchange

Returns:

the exchangeType

Throws:

MarshallingException - if there are problems with the exchange bytes

createDepoymentRequest

public DeploymentMessage createDepoymentRequest(String jobIdentifier,
                                       Operation operation,
                                       String respondTo)
                                         throws DeploymentException

Creates a deployment request 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.

Returns:

the deployment request duly initialized

Throws:

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

createDeploymentStatusOrAbortRequest

public DeploymentMessage createDeploymentStatusOrAbortRequest(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

createDeploymentResponse

public DeploymentMessage createDeploymentResponse(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 - If there are problems creating this exchange.

getDeploymentMessage

public DeploymentMessage getDeploymentMessage(byte[] exchangeBytes)
                                       throws IOException,
                                              MarshallingException

Reconstructs the Deployment Message from a stream of bytes

Parameters:

exchangeBytes - The marshalled representation of the exchange

Returns:

The reconstructed DeploymentMessage

Throws:

IOException - If there are problems reconstructing elements of the exchange

MarshallingException - If there are problems reconstructing specialized elements of the exchange

createExecutionStatusRequest

public ExecutionStatus createExecutionStatusRequest(String jobIdentifier,
                                           String taskIdentifier,
                                           String respondTo)

Creates an ExecutionStatus REQUEST based on the specified parameters

Parameters:

jobIdentifier - The job identifier that the task is a part of

taskIdentifier - The identifier of the task in question

respondTo - The stream to which the responses should be sent

Returns:

The created execution status exchange.

createExecutionStatusResponse

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

Creates an ExecutionStatus RESPONSE based on the specified parameters

Parameters:

jobIdentifier - The job identifier that the task is a part of

taskIdentifier - The identifier of the task in question

conditionFlag - The status of the execution (based on constants in the ConditionFlag)

description - A description of the response

taskLifecycleMetrics - The metrics associated with the execution.

respondTo - The stream to which the responses should be sent

Returns:

The created execution status exchange.

getExecutionStatus

public ExecutionStatus getExecutionStatus(byte[] exchangeBytes)
                                   throws IOException,
                                          MarshallingException

Reconstruct the execution status object from a byte[].

Parameters:

exchangeBytes - The byte[] representation of the execution status.

Returns:

The reconstructed execution status object.

Throws:

IOException - If there are problems reconstructing elements of the exchange

MarshallingException - If there are problems reconstructing specialized elements of the exchange

createResourceDiscoveryRequest

public ResourceDiscovery createResourceDiscoveryRequest(int resourceType,
                                               String respondTo)

Create a ResourceDiscovery request

Parameters:

resourceType - The type of the resource the node is looking for

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

Returns:

The created ResourceDiscovery request

createResourceDiscoveryResponse

public ResourceDiscovery createResourceDiscoveryResponse(int conditionFlag,
                                                String description,
                                                ResourceMetrics resourceMetrics,
                                                String respondTo)

Creates a ResourceDiscovery response

Parameters:

resourceMetrics - The metrics associated with the resource.

respondTo - The stream over which the resource listens to deployment requests

Returns:

The created ResourceDiscovery response.

getResourceDiscovery

public ResourceDiscovery getResourceDiscovery(byte[] exchangeBytes)
                                       throws IOException,
                                              MarshallingException

Reconstructs the ResourceDiscovery from a stream of bytes

Parameters:

exchangeBytes - The marshalled representation of the exchange

Returns:

The reconstructed ResourceDiscovery

Throws:

IOException - If there are problems reconstructing elements of the exchange

MarshallingException - If there are problems reconstructing specialized elements of the exchange