Package adams.scripting.command.flow

Class SendFlowControlCommand

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.AbstractCommandWithResponse

adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

adams.scripting.command.flow.SendFlowControlCommand

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, RemoteCommand, RemoteCommandOnFlow, RemoteCommandWithErrorMessage, RemoteCommandWithResponse, Serializable

public class SendFlowControlCommand
extends AbstractRemoteCommandOnFlowWithResponse

Sends a control command to a flow (pause/resume/stop/start).

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SendFlowControlCommand.Command	Enumeration of available commands.

Field Summary

Fields

Modifier and Type	Field	Description
protected SendFlowControlCommand.Command	m_Command	the command.
protected String	m_Response	the response.
static String	RESPONSE_ALREADY_PAUSED	response: already paused.
static String	RESPONSE_ALREADY_RUNNING	response: already running.
static String	RESPONSE_FAILED	response: failed.
static String	RESPONSE_NO_SUPPORTED	response: command not supported.
static String	RESPONSE_ROOT_NOT_FLOW	response: root not a Flow actor.
static String	RESPONSE_SUCCESS	response: success.

Fields inherited from class adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

m_ID

Fields inherited from class adams.scripting.command.AbstractCommandWithResponse

m_ErrorMessage, m_ResponseConnection

Fields inherited from class adams.scripting.command.AbstractCommand

m_RemoteScriptingEngineHandler, m_Request

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Constructor Summary

Constructors

Constructor	Description
SendFlowControlCommand()

Method Summary

Modifier and Type	Method	Description
String	commandTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
SendFlowControlCommand.Command	getCommand()	Returns the command to send.
byte[]	getRequestPayload()	Always zero-length array.
Object[]	getRequestPayloadObjects()	Returns the objects that represent the request payload.
byte[]	getResponsePayload()	Returns the payload of the response, if any.
Object[]	getResponsePayloadObjects()	Returns the objects that represent the response payload.
String	globalInfo()	Returns a string describing the object.
String	IDTipText()	Returns the tip text for this property.
protected void	prepareResponsePayload()	Hook method for preparing the response payload,
void	setCommand(SendFlowControlCommand.Command value)	Sets the command to send.
void	setRequestPayload(byte[] value)	Ignored.
void	setResponsePayload(byte[] value)	Sets the payload for the response.

Methods inherited from class adams.scripting.command.AbstractRemoteCommandOnFlowWithResponse

getID, retrieveFlow, setID

Methods inherited from class adams.scripting.command.AbstractCommandWithResponse

afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, doHandleRequest, getDefaultResponseConnection, getErrorMessage, getResponseConnection, handleResponse, hasErrorMessage, parse, responseConnectionTipText, setResponseConnection, toString

Methods inherited from class adams.scripting.command.AbstractCommand

afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, initialize, isRequest, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

afterSendRequest, assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, parse, setRemoteScriptingEngineHandler, setRequest

Field Detail

RESPONSE_SUCCESS

public static final String RESPONSE_SUCCESS

response: success.

See Also:

Constant Field Values

RESPONSE_FAILED

public static final String RESPONSE_FAILED

response: failed.

See Also:

Constant Field Values

RESPONSE_NO_SUPPORTED

public static final String RESPONSE_NO_SUPPORTED

response: command not supported.

See Also:

Constant Field Values

RESPONSE_ALREADY_PAUSED

public static final String RESPONSE_ALREADY_PAUSED

response: already paused.

See Also:

Constant Field Values

RESPONSE_ALREADY_RUNNING

public static final String RESPONSE_ALREADY_RUNNING

response: already running.

See Also:

Constant Field Values

RESPONSE_ROOT_NOT_FLOW

public static final String RESPONSE_ROOT_NOT_FLOW

response: root not a Flow actor.

See Also:

Constant Field Values

m_Command

protected SendFlowControlCommand.Command m_Command

the command.

m_Response

protected String m_Response

the response.

Constructor Detail

SendFlowControlCommand

public SendFlowControlCommand()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractRemoteCommandOnFlowWithResponse

IDTipText

public String IDTipText()

Returns the tip text for this property.

Specified by:

IDTipText in interface RemoteCommandOnFlow

Specified by:

IDTipText in class AbstractRemoteCommandOnFlowWithResponse

Returns:

tip text for this property suitable for displaying in the gui

setCommand

public void setCommand(SendFlowControlCommand.Command value)

Sets the command to send.

Parameters:

value - the command

getCommand

public SendFlowControlCommand.Command getCommand()

Returns the command to send.

Returns:

the command

commandTipText

public String commandTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setRequestPayload

public void setRequestPayload(byte[] value)

Ignored.

Parameters:

value - the payload

getRequestPayload

public byte[] getRequestPayload()

Always zero-length array.

Returns:

the payload

getRequestPayloadObjects

public Object[] getRequestPayloadObjects()

Returns the objects that represent the request payload.

Returns:

the objects

setResponsePayload

public void setResponsePayload(byte[] value)

Sets the payload for the response.

Parameters:

value - the payload

getResponsePayload

public byte[] getResponsePayload()

Returns the payload of the response, if any.

Returns:

the payload

prepareResponsePayload

protected void prepareResponsePayload()

Hook method for preparing the response payload,

Overrides:

prepareResponsePayload in class AbstractCommandWithResponse

getResponsePayloadObjects

public Object[] getResponsePayloadObjects()

Returns the objects that represent the response payload.

Returns:

the objects