org.lsst.ccs.gconsole.services.command

Class CommandService

java.lang.Object

org.lsst.ccs.gconsole.base.ConsolePlugin

org.lsst.ccs.gconsole.services.command.CommandService

All Implemented Interfaces:

ConsoleService

@Plugin(name="Command Service Plugin",
        id="command-service",
        description="Command service utility.")
public final class CommandService
extends ConsolePlugin
implements ConsoleService

Provides services related to sending commands to remote subsystems.

Author:

onoprien

Constructor Summary

Constructors

Constructor and Description
CommandService()

Method Summary

Modifier and Type	Method and Description
CommandTask	execute(CommandHandle handle, Duration timeout, String command, Object... args) Sends a command to a remote subsystem using the default sender.
CommandSender	getSender() Creates a customizable instance of CommandSender configured for use in the graphical console environment.
void	watch(Consumer<Boolean> watcher, String command, int numberOfArguments) Not yet implemented. Registers a component that should be notified whenever the availability of the specified command changes.

Methods inherited from class org.lsst.ccs.gconsole.base.ConsolePlugin

getConsole, getServices, initialize, propertiesChanged, restore, save, setServicesProvider, shutdown, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.gconsole.base.ConsoleService

startService, stopService

Constructor Detail

CommandService

public CommandService()

Method Detail

getSender

public CommandSender getSender()

Creates a customizable instance of CommandSender configured for use in the graphical console environment. For any commands sent through the CommandSender created by this method, CommandHandle methods will be called on the AWT Event Dispatching Thread.

Returns:

New instance of CommandSender.

execute

public CommandTask execute(CommandHandle handle,
                           Duration timeout,
                           String command,
                           Object... args)

Sends a command to a remote subsystem using the default sender.

Parameters:

handle - Handle for processing the command responses. May be null if no processing is required. All callbacks are executed on the AWT Event Dispatching Thread.

timeout - Timeout. If null, the default timeout of this sender will be used. Zero means the command will never time out. Negative timeout means its absolute value will be used and the custom timeout suggested by the target subsystem through an ACK will be ignored regardless of this sender settings.

command - Command in subsystem/path format.

args - Command arguments.

Returns:

CommandTask created to process the command. Can be used to wait for the response or cancel the command processing.

watch

public void watch(Consumer<Boolean> watcher,
                  String command,
                  int numberOfArguments)

Not yet implemented. Registers a component that should be notified whenever the availability of the specified command changes. Commands might be available or unavailable depending on whether the target subsystem is connected to the buses, and whether the lock level held by the console is sufficient to execute the command. All notifications are delivered on the AWT Event Dispatching Thread.

Parameters:

watcher - Component to be notified.

command - Command in subsystem/path format.

numberOfArguments - Number of arguments accepted by the command.