org.lsst.ccs.bus

Class ModuleInvokerCommand

java.lang.Object

org.lsst.ccs.bus.BusMessage

org.lsst.ccs.bus.Command

org.lsst.ccs.bus.ModuleInvokerCommand

All Implemented Interfaces:

Serializable, BusPayload, CommandBusMessage

Direct Known Subclasses:

PingCommand

public class ModuleInvokerCommand
extends Command

This can be used to send commands to a Modular Subsystem. We are assuming that all subsystems which receive commands are modular subsystems, so this can be used to send commands to any (non-passive) subsystem. TODO: Check if this is really a true statement. What about things like the status persister -- should we be able to send it commands like shutdown? (LSSTCCS-285)

Author:

aubourg

See Also:

Serialized Form

Field Summary

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

canRunInActiveMode, canWaitForReady, command, destination, key, level, log, NO_ARGS, parameters, unParsed

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

detailLevel, origin, priorityLevel, summary, timeStamp

Constructor Summary

Constructors

Constructor and Description
ModuleInvokerCommand(String key, int level, String destination, String command, Object... parameterz) Create a instance of this class.
ModuleInvokerCommand(String command, Object... parameterz) Deprecated. Please use other constructor.
ModuleInvokerCommand(String destination, String command, Object... parameterz) Deprecated. Please use other constructor.

Method Summary

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

canRunInActiveMode, canWaitForReady, getCommand, getCorrelId, getDestination, getKey, getLevel, getMessageType, getParameters, isUnParsed, isWrite, setCanRunInActiveMode, setCanWaitForReady, setCorrelId, setDestination, setKey, setLevel, setUnParsed, 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

Constructor Detail

ModuleInvokerCommand

public ModuleInvokerCommand(String key,
                            int level,
                            String destination,
                            String command,
                            Object... parameterz)

Create a instance of this class. Some functionality of this class is not fully implemented yet (keys, levels).

Parameters:

key - The lock manager key owned by the sender. Can be "".

level - The level at which the sender is currently authorized. Can be 0 (the default).

destination - The destination subsystem and module path within the subsystem. E.g. single-filter-test/module-1/sub-module.

command - The command to be sent.

parameterz - The parameters to be sent with the command. This can be omitted if there are no arguments. Note: There is no need to call Command.setDestination(java.lang.String) explicitly when using this constructor. Note, the interpretation of command and parameterz depends on the setting of Command.unParsed.

ModuleInvokerCommand

@Deprecated
public ModuleInvokerCommand(String destination,
                                        String command,
                                        Object... parameterz)

Deprecated. Please use other constructor.

This method is deprecated because of ambiguity problems, and lack of support for keys. level.

ModuleInvokerCommand

@Deprecated
public ModuleInvokerCommand(String command,
                                        Object... parameterz)

Deprecated. Please use other constructor.

This method is deprecated because of ambiguity problems, and lack of support for keys. level.