org.lsst.ccs.bus.messages

Class CommandMessage

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage

org.lsst.ccs.bus.messages.CommandMessage

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CommandReply, CommandRequest

public abstract class CommandMessage
extends BusMessage

Message to be sent on the Command Bus.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandMessage(String destination)
CommandMessage(String destination, String correlationId)

Method Summary

Modifier and Type	Method and Description
String	getCorrelId() The correlationId of this CommandMessage.
String	getDestination() The destination of the CommandMessage.

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

getOriginAgentInfo, getSummary, getTimeStamp, setOriginAgentInfo, setSummary

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandMessage

public CommandMessage(String destination,
                      String correlationId)

CommandMessage

public CommandMessage(String destination)

Method Detail

getDestination

public String getDestination()

The destination of the CommandMessage. This is the name of the CCS Agent on the buses that is the target of this CommandMessage.

Returns:

The destination for this CommandMessage

getCorrelId

public String getCorrelId()

The correlationId of this CommandMessage. The correlationId is a unique identifier used to correlate CommandMessages related to the same command exchange, as described in the Command State Diagram: WHICH URL? The CorrelationId is intended to be used by CommandMessageListeners to correlate messages. The CorrelationId is used internally to route CommandReply messages to the appropriate CommandOriginator

Returns:

The Correlation Id for this message