Package adams.scripting.engine

Interface RemoteScriptingEngine

All Superinterfaces:

Destroyable, FlowContextHandler, OptionHandler, Pausable, RemoteCommandProcessorHandler, Stoppable, StoppableWithFeedback

All Known Subinterfaces:

JobQueueHandler, MainScriptingEngine

All Known Implementing Classes:

AbstractScriptingEngine, AbstractScriptingEngineEnhancer, AbstractScriptingEngineWithJobQueue, DefaultMainScriptingEngine, DefaultScriptingEngine, DefaultWorkerScriptingEngine, FileBasedScriptingEngine, ForwardingScriptingEngine, ManualFeedScriptingEngine, MultiScriptingEngine

public interface RemoteScriptingEngine
extends OptionHandler, Pausable, StoppableWithFeedback, FlowContextHandler, RemoteCommandProcessorHandler

Scripting engine for remote commands.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
String	execute()	Executes the scripting engine.
void	executeJob(CallableWithResult<String> job)	Executes the job.
RemoteCommandHandler	getCommandHandler()	Returns the command handler in use.
Actor	getFlowContext()	Returns the flow context, if any.
PermissionHandler	getPermissionHandler()	Returns the permission handler in use.
RemoteScriptingEngineHandler	getRemoteScriptingEngineHandler()	Returns the application context.
RequestHandler	getRequestHandler()	Returns the request handler in use.
ResponseHandler	getResponseHandler()	Returns the response handler in use.
boolean	isRunning()	Returns whether the scripting engine is currently running.
String	permissionHandlerTipText()	Returns the tip text for this property.
String	requestHandlerTipText()	Returns the tip text for this property.
String	responseHandlerTipText()	Returns the tip text for this property.
void	setCommandHandler(RemoteCommandHandler value)	Sets the command handler to use.
void	setFlowContext(Actor value)	Sets the flow context.
void	setPermissionHandler(PermissionHandler value)	Sets the permission handler to use.
void	setRemoteScriptingEngineHandler(RemoteScriptingEngineHandler value)	Sets the application context.
void	setRequestHandler(RequestHandler value)	Sets the request handler to use.
void	setResponseHandler(ResponseHandler value)	Sets the response handler to use.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.Pausable

isPaused, pauseExecution, resumeExecution

Methods inherited from interface adams.scripting.processor.RemoteCommandProcessorHandler

getCommandProcessor, setCommandProcessor

Methods inherited from interface adams.core.Stoppable

stopExecution

Methods inherited from interface adams.core.StoppableWithFeedback

isStopped

Method Detail

setRemoteScriptingEngineHandler

void setRemoteScriptingEngineHandler(RemoteScriptingEngineHandler value)

Sets the application context.

Parameters:

value - the context

getRemoteScriptingEngineHandler

RemoteScriptingEngineHandler getRemoteScriptingEngineHandler()

Returns the application context.

Returns:

the context, null if none set

setFlowContext

void setFlowContext(Actor value)

Sets the flow context.

Specified by:

setFlowContext in interface FlowContextHandler

Parameters:

value - the actor

getFlowContext

Actor getFlowContext()

Returns the flow context, if any.

Specified by:

getFlowContext in interface FlowContextHandler

Returns:

the actor, null if none available

setCommandHandler

void setCommandHandler(RemoteCommandHandler value)

Sets the command handler to use.

Parameters:

value - the command handler

getCommandHandler

RemoteCommandHandler getCommandHandler()

Returns the command handler in use.

Returns:

the command handler

setPermissionHandler

void setPermissionHandler(PermissionHandler value)

Sets the permission handler to use.

Parameters:

value - the permission handler

getPermissionHandler

PermissionHandler getPermissionHandler()

Returns the permission handler in use.

Returns:

the permission handler

permissionHandlerTipText

String permissionHandlerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setRequestHandler

void setRequestHandler(RequestHandler value)

Sets the request handler to use.

Parameters:

value - the request handler

getRequestHandler

RequestHandler getRequestHandler()

Returns the request handler in use.

Returns:

the request handler

requestHandlerTipText

String requestHandlerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setResponseHandler

void setResponseHandler(ResponseHandler value)

Sets the response handler to use.

Parameters:

value - the response handler

getResponseHandler

ResponseHandler getResponseHandler()

Returns the response handler in use.

Returns:

the response handler

responseHandlerTipText

String responseHandlerTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

executeJob

void executeJob(CallableWithResult<String> job)

Executes the job.

Parameters:

job - the job to execute

execute

String execute()

Executes the scripting engine.

Returns:

error message in case of failure to start up or run, otherwise null

isRunning

boolean isRunning()

Returns whether the scripting engine is currently running.

Returns:

true if running