Package adams.scripting.command.flow

Class RunRemoteFlow

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.flow.RunRemoteFlow

All Implemented Interfaces:

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

public class RunRemoteFlow
extends AbstractCommandWithResponse

Loads and runs a flow on a remote server.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected File	m_FlowFile	the flow to run.
protected boolean	m_RegisterFlow	whether to register the flow.

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
RunRemoteFlow()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	flowFileTipText()	Returns the tip text for this property.
File	getFlowFile()	Returns the remote flow file.
boolean	getRegisterFlow()	Returns whether to register the flow.
byte[]	getRequestPayload()	Always zero-length array.
Object[]	getRequestPayloadObjects()	Always zero-length array.
byte[]	getResponsePayload()	Always zero-length array.
Object[]	getResponsePayloadObjects()	Always zero-length array.
String	globalInfo()	Returns a string describing the object.
protected void	prepareResponsePayload()	Hook method for preparing the response payload,
String	registerFlowTipText()	Returns the tip text for this property.
void	setFlowFile(File value)	Sets the remote flow file.
void	setRegisterFlow(boolean value)	Sets whether to register the flow.
void	setRequestPayload(byte[] value)	Ignored.
void	setResponsePayload(byte[] value)	Ignored.

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, setRemoteScriptingEngineHandler, setRequest

Field Detail

m_FlowFile

protected File m_FlowFile

the flow to run.

m_RegisterFlow

protected boolean m_RegisterFlow

whether to register the flow.

Constructor Detail

RunRemoteFlow

public RunRemoteFlow()

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 AbstractCommandWithResponse

setFlowFile

public void setFlowFile(File value)

Sets the remote flow file.

Parameters:

value - the flow

getFlowFile

public File getFlowFile()

Returns the remote flow file.

Returns:

the flow

flowFileTipText

public String flowFileTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setRegisterFlow

public void setRegisterFlow(boolean value)

Sets whether to register the flow.

Parameters:

value - true if to register

getRegisterFlow

public boolean getRegisterFlow()

Returns whether to register the flow.

Returns:

true if to register

registerFlowTipText

public String registerFlowTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

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()

Always zero-length array.

Returns:

the objects

setResponsePayload

public void setResponsePayload(byte[] value)

Ignored.

Parameters:

value - the payload

getResponsePayload

public byte[] getResponsePayload()

Always zero-length array.

Returns:

the payload

getResponsePayloadObjects

public Object[] getResponsePayloadObjects()

Always zero-length array.

Returns:

the objects

prepareResponsePayload

protected void prepareResponsePayload()

Hook method for preparing the response payload,

Overrides:

prepareResponsePayload in class AbstractCommandWithResponse