org.eclipse.smila.scripting.worker

Class ScriptProcessorWorker

java.lang.Object

org.eclipse.smila.scripting.worker.ScriptProcessorWorker

All Implemented Interfaces:

Worker

public class ScriptProcessorWorker
extends java.lang.Object
implements Worker

A worker for executing scripts. The task/job parameters for the script and the function name can be overwritten in the record.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_FUNCTION_NAME (optional) record attribute for overwriting function parameter.
static java.lang.String	ATTR_SCRIPT_NAME (optional) record attribute for overwriting script parameter.
static java.lang.String	DEFAULT_INIT_FUNCTION Default function name for initializing scripts.
static java.lang.String	DEFAULT_PARAMETERS_ATTRIBUTE record attribute for (task) parameters.
static java.lang.String	DEFAULT_PROCESS_FUNCTION Default function name for processing records.
static java.lang.String	INPUT_SLOT_NAME the workers input slot name .
static java.lang.String	KEY_FAIL_ON_ERROR parameter key for fail on error.
static java.lang.String	KEY_INIT_FUNCTION key for the initialize-function parameter.
static java.lang.String	KEY_PROCESS_FUNCTION key for the processing-function parameter.
static java.lang.String	KEY_SCRIPT_NAME key for the script parameter.
static java.lang.String	KEY_WRITE_ATTACHMENTS_TO_OUTPUT name for "write attachments to output" parameter.
static java.lang.String	OUTPUT_SLOT_NAME the workers output slot name .
static java.lang.String	WORKER_NAME worker's name.

Constructor Summary

Constructors

Constructor and Description
ScriptProcessorWorker()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName()
void	perform(TaskContext taskContext) Performs a computation on the data available in the TaskContext, such as a task for this worker, input and (if configured) output slots.
void	setScriptingEngine(ScriptingEngine scriptingEngine) set OSGI service.
void	unsetScriptingEngine(ScriptingEngine scriptingEngine) unset OSGI service.

Methods inherited from class java.lang.Object

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

Field Detail

WORKER_NAME

public static final java.lang.String WORKER_NAME

worker's name.

See Also:

Constant Field Values

KEY_SCRIPT_NAME

public static final java.lang.String KEY_SCRIPT_NAME

key for the script parameter.

See Also:

Constant Field Values

KEY_PROCESS_FUNCTION

public static final java.lang.String KEY_PROCESS_FUNCTION

key for the processing-function parameter.

See Also:

Constant Field Values

KEY_INIT_FUNCTION

public static final java.lang.String KEY_INIT_FUNCTION

key for the initialize-function parameter.

See Also:

Constant Field Values

KEY_WRITE_ATTACHMENTS_TO_OUTPUT

public static final java.lang.String KEY_WRITE_ATTACHMENTS_TO_OUTPUT

name for "write attachments to output" parameter.

See Also:

Constant Field Values

KEY_FAIL_ON_ERROR

public static final java.lang.String KEY_FAIL_ON_ERROR

parameter key for fail on error.

See Also:

Constant Field Values

DEFAULT_PARAMETERS_ATTRIBUTE

public static final java.lang.String DEFAULT_PARAMETERS_ATTRIBUTE

record attribute for (task) parameters.

See Also:

Constant Field Values

ATTR_SCRIPT_NAME

public static final java.lang.String ATTR_SCRIPT_NAME

(optional) record attribute for overwriting script parameter.

See Also:

Constant Field Values

ATTR_FUNCTION_NAME

public static final java.lang.String ATTR_FUNCTION_NAME

(optional) record attribute for overwriting function parameter.

See Also:

Constant Field Values

INPUT_SLOT_NAME

public static final java.lang.String INPUT_SLOT_NAME

the workers input slot name .

See Also:

Constant Field Values

OUTPUT_SLOT_NAME

public static final java.lang.String OUTPUT_SLOT_NAME

the workers output slot name .

See Also:

Constant Field Values

DEFAULT_PROCESS_FUNCTION

public static final java.lang.String DEFAULT_PROCESS_FUNCTION

Default function name for processing records.

See Also:

Constant Field Values

DEFAULT_INIT_FUNCTION

public static final java.lang.String DEFAULT_INIT_FUNCTION

Default function name for initializing scripts.

See Also:

Constant Field Values

Constructor Detail

ScriptProcessorWorker

public ScriptProcessorWorker()

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in interface Worker

Returns:

the name of the worker. The worker function will be executed for tasks tied to this worker name.

perform

public void perform(TaskContext taskContext)
             throws java.lang.Exception

Description copied from interface: Worker

Performs a computation on the data available in the TaskContext, such as a task for this worker, input and (if configured) output slots. An implementor must make sure, calls to this method must be thread-safe!

Specified by:

perform in interface Worker

Parameters:

taskContext - the TaskContext information with which this operation can be performed.

Throws:

java.lang.Exception

setScriptingEngine

public void setScriptingEngine(ScriptingEngine scriptingEngine)

set OSGI service.

unsetScriptingEngine

public void unsetScriptingEngine(ScriptingEngine scriptingEngine)

unset OSGI service.