Class JobRunner
-
- All Implemented Interfaces:
Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,SizeOfHandler
,RemoteCommand
,RemoteCommandWithErrorMessage
,RemoteCommandWithResponse
,Serializable
public class JobRunner extends AbstractCommandWithResponse
Encapsulates a JobRunner.- Version:
- $Revision$
- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected JobRunner
m_JobRunner
the JobRunner.-
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 JobRunner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
doHandleRequest(RemoteScriptingEngine engine, RemoteCommandProcessor processor)
Handles the request.JobRunner
getJobRunner()
Returns the JobRunner in use.byte[]
getRequestPayload()
Returns the payload of the request, if any.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.protected void
initialize()
Initializes the members.void
setJobRunner(JobRunner value)
Sets the JobRunner to use.void
setRequestPayload(byte[] value)
Sets the payload for the request.void
setResponsePayload(byte[] value)
Sets the payload for the response.-
Methods inherited from class adams.scripting.command.AbstractCommandWithResponse
afterSendResponse, assembleResponse, assembleResponseHeader, beforeSendResponse, defineOptions, getDefaultResponseConnection, getErrorMessage, getResponseConnection, handleResponse, hasErrorMessage, parse, prepareResponsePayload, responseConnectionTipText, setResponseConnection, toString
-
Methods inherited from class adams.scripting.command.AbstractCommand
afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, 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_JobRunner
protected JobRunner m_JobRunner
the JobRunner.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- Returns:
- a description suitable for displaying in the gui
-
initialize
protected void initialize()
Initializes the members.- Overrides:
initialize
in classAbstractCommand
-
setRequestPayload
public void setRequestPayload(byte[] value)
Sets the payload for the request.- Parameters:
value
- the payload
-
getRequestPayload
public byte[] getRequestPayload()
Returns the payload of the request, if any.- 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
-
getResponsePayloadObjects
public Object[] getResponsePayloadObjects()
Returns the objects that represent the response payload.- Returns:
- the objects
-
setJobRunner
public void setJobRunner(JobRunner value)
Sets the JobRunner to use.- Parameters:
value
- the JobRunner
-
getJobRunner
public JobRunner getJobRunner()
Returns the JobRunner in use.- Returns:
- the JobRunner, null if none set
-
doHandleRequest
protected String doHandleRequest(RemoteScriptingEngine engine, RemoteCommandProcessor processor)
Handles the request.- Overrides:
doHandleRequest
in classAbstractCommandWithResponse
- Parameters:
engine
- the remote engine handling the requestprocessor
- the processor for formatting/parsing- Returns:
- null if successful, otherwise error message
-
-