org.lsst.ccs.bus

Class Command

java.lang.Object

org.lsst.ccs.bus.BusMessage

org.lsst.ccs.bus.Command

All Implemented Interfaces:

Serializable, BusPayload, CommandBusMessage

Direct Known Subclasses:

ModuleConfigCommand, ModuleInvokerCommand, SystemCommand, UnparsedCommand

public abstract class Command
extends BusMessage
implements CommandBusMessage

A command sent on the CCS bus.

Will be executed by the destination subsystem.

Author:

Eric Aubourg

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canRunInActiveMode Deprecated.
protected boolean	canWaitForReady Deprecated.
protected String	command
protected String	destination
protected String	key
protected int	level The level of the sender of this command.
protected static org.lsst.ccs.utilities.logging.Logger	log
static Serializable[]	NO_ARGS to be used by subclasses for no args for commands
protected Object[]	parameters
protected boolean	unParsed Indicates that the command is a pure String to be parsed by the receiver.

Fields inherited from class org.lsst.ccs.bus.BusMessage

detailLevel, origin, priorityLevel, summary, timeStamp

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Command(String key, int level, String destination, String command, Object... parameterz)

Method Summary

Modifier and Type	Method and Description
boolean	canRunInActiveMode() Deprecated.
boolean	canWaitForReady() Deprecated.
String	getCommand()
String	getCorrelId()
String	getDestination() The command destination : subsystem name
String	getKey() Key used for lock and arbitration.
int	getLevel()
String	getMessageType()
Object[]	getParameters()
boolean	isUnParsed()
boolean	isWrite() Deprecated.
void	setCanRunInActiveMode(boolean canRunInActiveMode) Deprecated.
void	setCanWaitForReady(boolean canWaitForReady) Deprecated.
void	setCorrelId(String correlId) Correlation id, propagated from command to command.
void	setDestination(String destination) The command destination : subsystem name
void	setKey(String key) Key used for lock and arbitration.
void	setLevel(int level) Deprecated.
void	setUnParsed(boolean unParsed)
String	toString()

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

getDetailLevel, getOrigin, getPriorityLevel, getSummary, getTimeStamp, setDetailLevel, setOrigin, setPriorityLevel, setSummary, setTimeStamp

Methods inherited from class java.lang.Object

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

Field Detail

NO_ARGS

public static final Serializable[] NO_ARGS

to be used by subclasses for no args for commands

log

protected static final org.lsst.ccs.utilities.logging.Logger log

destination

protected String destination

key

protected String key

level

protected int level

The level of the sender of this command.

command

protected String command

parameters

protected Object[] parameters

unParsed

protected boolean unParsed

Indicates that the command is a pure String to be parsed by the receiver. In this case no arguments should be specified.

canWaitForReady

@Deprecated
protected boolean canWaitForReady

Deprecated.

Deprecated this is subject to re-evaluation of specs

canRunInActiveMode

@Deprecated
protected boolean canRunInActiveMode

Deprecated.

Deprecated this is defined in the Command annotation

Constructor Detail

Command

protected Command(String key,
                  int level,
                  String destination,
                  String command,
                  Object... parameterz)

Method Detail

getMessageType

public String getMessageType()

Specified by:

getMessageType in class BusMessage

getDestination

public String getDestination()

The command destination : subsystem name

Specified by:

getDestination in interface CommandBusMessage

Returns:

command destination

setDestination

public void setDestination(String destination)

The command destination : subsystem name

Parameters:

destination -

getKey

public String getKey()

Key used for lock and arbitration. If set, incoming commands must have the same key.

Returns:

the key

setKey

public void setKey(String key)

Key used for lock and arbitration. If set, incoming commands must have the same key

Parameters:

key -

isWrite

@Deprecated
public boolean isWrite()

Deprecated.

is this command a writing command that has to be protected ?
Deprecated this is defined in the Command annotation

canWaitForReady

@Deprecated
public boolean canWaitForReady()

Deprecated.

can this command wait for a single-threaded ownerSubsystem to be ready ?

Returns:

a boolean

setCanWaitForReady

@Deprecated
public void setCanWaitForReady(boolean canWaitForReady)

Deprecated.

can this command wait for a single-threaded ownerSubsystem to be ready

Parameters:

canWaitForReady -

canRunInActiveMode

@Deprecated
public boolean canRunInActiveMode()

Deprecated.

Can this command be executed by a subsystem which is in "active" mode ?

Returns:

a boolean

setCanRunInActiveMode

@Deprecated
public void setCanRunInActiveMode(boolean canRunInActiveMode)

Deprecated.

toString

public String toString()

Overrides:

toString in class Object

getCorrelId

public String getCorrelId()

Specified by:

getCorrelId in interface CommandBusMessage

setCorrelId

public void setCorrelId(String correlId)

Correlation id, propagated from command to command. Users of this class can set a specific correlation id, but otherwise one will be generated automatically.

isUnParsed

public boolean isUnParsed()

setUnParsed

public void setUnParsed(boolean unParsed)

getCommand

public String getCommand()

getParameters

public Object[] getParameters()

getLevel

public int getLevel()

setLevel

@Deprecated
public void setLevel(int level)

Deprecated.