org.lsst.ccs.gconsole.agent.command

Interface CommandHandle

All Known Implementing Classes:

DefaultCommandHandle

public interface CommandHandle

Interface to be implemented by classes that process responses to commands sent to remote subsystems.

Author:

onoprien

Field Summary

Fields

Modifier and Type	Field and Description
static CommandHandle	NONE Empty CommandHandle that does no processing.

Method Summary

Modifier and Type	Method and Description
default void	onAck(org.lsst.ccs.bus.messages.CommandAck ack, CommandTask source) Called when an ACK is received.
default void	onCancel(CancellationException exception, CommandTask source) Called if the command is successfully canceled.
default void	onExecutionFailure(Throwable exception, CommandTask source) Called when the target subsystem either throws an uncaught exception while trying to execute the command, or returns an exception as the result of execution.
default void	onNack(org.lsst.ccs.bus.messages.CommandNack nack, CommandTask source) Called when the command is rejected.
default void	onResult(CommandCode code, Object result, CommandTask source) Called when either the result of the command execution is received, or the command is canceled or times out.
default void	onResult(Object result, CommandTask source) Deprecated. Use onResult(CommandCode, Object, CommandTask) instead.
default void	onSendingFailure(Throwable exception, CommandTask source) Called if the command cannot be sent to the target subsystem.
default void	onSuccess(Object result, CommandTask source) Called when the command result that is not an exception is received.
default void	onTimeout(TimeoutException exception, CommandTask source) Called if the command times out.
default String	shorten(String message) Shortens messages longer than 200 characters.

Field Detail

NONE

static final CommandHandle NONE

Empty CommandHandle that does no processing.

Method Detail

onSendingFailure

default void onSendingFailure(Throwable exception,
                              CommandTask source)

Called if the command cannot be sent to the target subsystem. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

exception - Exception thrown while attempting to send the command.

source - CommandTask that executed the command.

onAck

default void onAck(org.lsst.ccs.bus.messages.CommandAck ack,
                   CommandTask source)

Called when an ACK is received.

Parameters:

ack - ACK.

source - CommandTask that executed the command.

onNack

default void onNack(org.lsst.ccs.bus.messages.CommandNack nack,
                    CommandTask source)

Called when the command is rejected. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

nack - NACK.

source - CommandTask that executed the command.

onSuccess

default void onSuccess(Object result,
                       CommandTask source)

Called when the command result that is not an exception is received. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

result - Result.

source - CommandTask that executed the command.

onExecutionFailure

default void onExecutionFailure(Throwable exception,
                                CommandTask source)

Called when the target subsystem either throws an uncaught exception while trying to execute the command, or returns an exception as the result of execution. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

exception - Exception thrown while attempting to execute the command.

source - CommandTask that executed the command.

onTimeout

default void onTimeout(TimeoutException exception,
                       CommandTask source)

Called if the command times out. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

exception - Exception thrown.

source - CommandTask that executed the command.

onCancel

default void onCancel(CancellationException exception,
                      CommandTask source)

Called if the command is successfully canceled. The default implementation forwards the call to onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Parameters:

exception - Exception thrown.

source - CommandTask that executed the command.

onResult

@Deprecated
default void onResult(Object result,
                                  CommandTask source)

Deprecated. Use onResult(CommandCode, Object, CommandTask) instead.

Called when either the result of the command execution is received, or the command is canceled or times out. This method is guaranteed to be called for every command unless one of the more specific handlers - onNack(org.lsst.ccs.bus.messages.CommandNack, org.lsst.ccs.gconsole.agent.command.CommandTask), onSuccess(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask), onExecutionFailure(java.lang.Throwable, org.lsst.ccs.gconsole.agent.command.CommandTask), onTimeout(java.util.concurrent.TimeoutException, org.lsst.ccs.gconsole.agent.command.CommandTask), onCancel(java.util.concurrent.CancellationException, org.lsst.ccs.gconsole.agent.command.CommandTask) - is implemented. The default implementation does nothing.

Parameters:

result - Result of the command submission. Either an object returned by the target subsystem, or a locally generated TimeoutException or CancellationException.

source - CommandTask that executed the command.

onResult

default void onResult(CommandCode code,
                      Object result,
                      CommandTask source)

Called when either the result of the command execution is received, or the command is canceled or times out. This method is guaranteed to be called for every command unless one of the more specific handlers - onNack(org.lsst.ccs.bus.messages.CommandNack, org.lsst.ccs.gconsole.agent.command.CommandTask), onSuccess(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask), onExecutionFailure(java.lang.Throwable, org.lsst.ccs.gconsole.agent.command.CommandTask), onTimeout(java.util.concurrent.TimeoutException, org.lsst.ccs.gconsole.agent.command.CommandTask), onCancel(java.util.concurrent.CancellationException, org.lsst.ccs.gconsole.agent.command.CommandTask) - is implemented. The default implementation does nothing.

Parameters:

code - Exit code.

result - Result of the command submission. Either an object returned by the target subsystem, or a locally generated TimeoutException or CancellationException.

source - CommandTask that executed the command.

shorten

default String shorten(String message)

Shortens messages longer than 200 characters. This method is specifically tuned to deal with annoying command responses, like "Could not find command " + stack trace.

Parameters:

message - Original message.

Returns:

Shortened message