org.lsst.ccs.bus.messages

Class CommandReply<T extends Serializable>

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage<T,D>

org.lsst.ccs.bus.messages.CommandMessage<T,String>

org.lsst.ccs.bus.messages.CommandReply<T>

Type Parameters:

T - Template for the embedded reply object. It must be Serializable.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandAck, CommandNack, CommandResult

public class CommandReply<T extends Serializable>
extends CommandMessage<T,String>

Base class for a command reply. Can be a CommandResult, CommandAck or CommandNack This class provides an implementation for the encoding for all the subclasses. If the content of the CommandReply is a Throwable it will be encoded to a String containing the message and the stacktrace. If it is any other object, the encoding will return the toString() method on that object.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandReply(CommandRequest command, T reply) Main CommandReply constructor.

Method Summary

Modifier and Type	Method and Description
protected String	encodeObject(T obj) Subclasses must provide a specific implementation of the encoding process.
String	getEncodedData() Get the Encoded version of the embedded Object.
Object	getReply() Utility method to get the reply contained in this CommandReply.

Methods inherited from class org.lsst.ccs.bus.messages.CommandMessage

getCorrelationId, getDestination

Methods inherited from class org.lsst.ccs.bus.messages.BusMessage

getClassName, getObject, getOriginAgentInfo, getTimeStamp, setOriginAgentInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandReply

public CommandReply(CommandRequest command,
                    T reply)

Main CommandReply constructor. It is built from the corresponding CommandRequest and it encapsulates the reply from its execution.

Parameters:

command - The CommandRequest that originated the execution.

reply - The result of the execution of the CommandRequest. If not successful the reply is a Throwable.

Method Detail

getReply

public Object getReply()

Utility method to get the reply contained in this CommandReply. It is equivalent to invoking the BusMessage getObject method.

Returns:

The reply Object contained in this CommandReply.

Throws:

EmbeddedObjectDeserializationException - if the embedded object cannot be deserialized.

getEncodedData

public String getEncodedData()

Description copied from class: BusMessage

Get the Encoded version of the embedded Object.

Overrides:

getEncodedData in class BusMessage<T extends Serializable,String>

Returns:

The Encoded version of the embedded Object.

encodeObject

protected String encodeObject(T obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<T extends Serializable,String>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.