org.lsst.ccs.bus.messages

Class CommandRequest

java.lang.Object

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

org.lsst.ccs.bus.messages.CommandMessage<org.lsst.ccs.command.BasicCommand,String>

org.lsst.ccs.bus.messages.CommandRequest

All Implemented Interfaces:

Serializable

public final class CommandRequest
extends CommandMessage<org.lsst.ccs.command.BasicCommand,String>

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".

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
protected String	encodeObject(org.lsst.ccs.command.BasicCommand obj) Subclasses must provide a specific implementation of the encoding process.
org.lsst.ccs.command.BasicCommand	getBasicCommand() Utility method to get the embedded BasicCommand.
int	getLevel() Get the level associated to this command request.
AgentLock	getLock() Get the lock associated to this command request.
void	setLockAndLevel(AgentLock lock, int level) Associate lock and level sender's information to this command request.
String	toString()

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

getCorrelationId, getDestination

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

getCCSTimeStamp, getClassName, getDeSerializationTime, getEncodedData, getObject, getOriginAgentInfo, getSerializationTime, getTransferDuration, setOriginAgentInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

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,
                      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,
                      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

encodeObject

protected String encodeObject(org.lsst.ccs.command.BasicCommand obj)

Description copied from class: BusMessage

Subclasses must provide a specific implementation of the encoding process.

Specified by:

encodeObject in class BusMessage<org.lsst.ccs.command.BasicCommand,String>

Parameters:

obj - The Serializable object embedded in the BusMessage.

Returns:

The encoded version of the embedded object.

getBasicCommand

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

Utility method to get the embedded BasicCommand. This is equivalent to invoking the BusMessage getObject method.

Returns:

The BasicCommand embedded in this CommandRequest.

Throws:

EmbeddedObjectDeserializationException - if the embedded object cannot be deserialized

getLock

public AgentLock getLock()

Get the lock associated to this command request.

Returns:

a lock object.

getLevel

public int getLevel()

Get the level associated to this command request.

Returns:

setLockAndLevel

public void setLockAndLevel(AgentLock lock,
                            int level)

Associate lock and level sender's information to this command request. Implementation note : this makes the CommandRequest object mutable, and potentially any arbitrary lock object could be set to this command request. But the bus application layer will have the final word on which lock will be set.

Parameters:

lock -

level -

toString

public String toString()

Overrides:

toString in class BusMessage<org.lsst.ccs.command.BasicCommand,String>