org.lsst.ccs.bus.messages

Class CommandRequest

java.lang.Object

org.lsst.ccs.bus.messages.BusMessage

org.lsst.ccs.bus.messages.CommandMessage

org.lsst.ccs.bus.messages.CommandRequest

All Implemented Interfaces:

Serializable

public class CommandRequest
extends CommandMessage

Wrapper class to send a BasicCommand over the Command bus; the BasicCommand is either provided as an object or created internally from a String representation: e.g. "doSomething 1 2". The correlationId of this CommandBusMessage is create internally when the object is built.

Author:

LSST CCS Team

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommandRequest(String destination, org.lsst.ccs.command.BasicCommand command) Create a BasicCommandMessage from an existing BasicCommand.
CommandRequest(String destination, String command) Create a BasicCommandMessage from a string representation of a command: e.g.
CommandRequest(String destination, String command, Object... args) Create a BasicCommandMessage from a string representation of a command: e.g.

Method Summary

Modifier and Type	Method and Description
org.lsst.ccs.command.BasicCommand	getBasicCommand()
String	getCommandOriginatorId() Get the CommandOriginator Id for this CommandRequest.
void	setCommandOriginatorId(String commandOriginatorId) Get the CommandOriginator Id for this CommandRequest.
String	toString()

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

getCorrelId, getDestination

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

equals, getOriginAgentInfo, getSummary, getTimeStamp, hashCode, setOriginAgentInfo, setSummary

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommandRequest

public CommandRequest(String destination,
                      String command,
                      Object... args)

Create a BasicCommandMessage from a string representation of a command: e.g. "doSomething 1 2".

Parameters:

destination - The destination of this command.

command - The string representation of a command. A BasicCommand object will be created internally.

args - The array of arguments to the command.

CommandRequest

public CommandRequest(String destination,
                      String command)

Create a BasicCommandMessage from a string representation of a command: e.g. "doSomething 1 2".

Parameters:

destination - The destination of this command.

command - The string representation of a command. A BasicCommand object will be created internally.

CommandRequest

public CommandRequest(String destination,
                      org.lsst.ccs.command.BasicCommand command)

Create a BasicCommandMessage from an existing BasicCommand.

Parameters:

destination - The destination of this command.

command - The BasicCommand object to be wrapper.

Method Detail

getBasicCommand

public org.lsst.ccs.command.BasicCommand getBasicCommand()

toString

public String toString()

Overrides:

toString in class Object

setCommandOriginatorId

public final void setCommandOriginatorId(String commandOriginatorId)

Get the CommandOriginator Id for this CommandRequest.

getCommandOriginatorId

public String getCommandOriginatorId()

Get the CommandOriginator Id for this CommandRequest.