org.lsst.ccs.gconsole.services.command

Class DefaultCommandHandle

java.lang.Object

org.lsst.ccs.gconsole.services.command.DefaultCommandHandle

All Implemented Interfaces:

CommandHandle

public class DefaultCommandHandle
extends Object
implements CommandHandle

Basic console-specific implementation of CommandHandle interface. Displays messages when commands sent to remote subsystems fail for any reason or time out.

Author:

onoprien

Field Summary

Fields inherited from interface org.lsst.ccs.gconsole.agent.command.CommandHandle

NONE

Constructor Summary

Constructors

Constructor and Description
DefaultCommandHandle()

Method Summary

Modifier and Type	Method and Description
void	onCancel(CancellationException exception, CommandTask source) Called if the command is successfully canceled.
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.
void	onNack(org.lsst.ccs.bus.messages.CommandNack nack, CommandTask source) Called when the command is rejected.
void	onSendingFailure(Throwable exception, CommandTask source) Called if the command cannot be sent to the target subsystem.
void	onTimeout(TimeoutException exception, CommandTask source) Called if the command times out.

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.agent.command.CommandHandle

onAck, onResult, onResult, onSuccess, shorten

Constructor Detail

DefaultCommandHandle

public DefaultCommandHandle()

Method Detail

onSendingFailure

public void onSendingFailure(Throwable exception,
                             CommandTask source)

Description copied from interface: CommandHandle

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

Specified by:

onSendingFailure in interface CommandHandle

Parameters:

exception - Exception thrown while attempting to send the command.

source - CommandTask that executed the command.

onNack

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

Description copied from interface: CommandHandle

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

Specified by:

onNack in interface CommandHandle

Parameters:

nack - NACK.

source - CommandTask that executed the command.

onExecutionFailure

public void onExecutionFailure(Throwable exception,
                               CommandTask source)

Description copied from interface: CommandHandle

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 CommandHandle.onResult(java.lang.Object, org.lsst.ccs.gconsole.agent.command.CommandTask).

Specified by:

onExecutionFailure in interface CommandHandle

Parameters:

exception - Exception thrown while attempting to execute the command.

source - CommandTask that executed the command.

onTimeout

public void onTimeout(TimeoutException exception,
                      CommandTask source)

Description copied from interface: CommandHandle

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

Specified by:

onTimeout in interface CommandHandle

Parameters:

exception - Exception thrown.

source - CommandTask that executed the command.

onCancel

public void onCancel(CancellationException exception,
                     CommandTask source)

Description copied from interface: CommandHandle

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

Specified by:

onCancel in interface CommandHandle

Parameters:

exception - Exception thrown.

source - CommandTask that executed the command.