org.oddjob.jobs.tasks

Class TaskExecutionService

java.lang.Object

org.oddjob.framework.extend.BaseComponent

org.oddjob.framework.extend.SimpleService

org.oddjob.jobs.tasks.TaskExecutionService

All Implemented Interfaces:

java.lang.Runnable, ArooaContextAware, ArooaSessionAware, PropertyChangeNotifier, Iconic, TaskExecutor, LogEnabled, Resettable, Stateful, Stoppable, Structural

public class TaskExecutionService
extends SimpleService
implements TaskExecutor, Structural

Description

Provide a very simple task execution service.

The task to be executed is defined by the nested jobs which may use the properties. which will be defined when executing the tasks.

This implementation only supports the single execution of a task at one time. If the task is running additional requests to execute the task will be ignored.

Future version will support multiple parallel executions of tasks.

Example

A Task Service that greets people by name. Three TaskRequests call the service with different names.

<oddjob>
    <job>
        <sequential>
            <jobs>
                <task-service id="hello-service">
                    <requests>
                        <input-text prompt="Name" property="some.name"/>
                    </requests>
                    <job>
                        <echo>Hello ${some.name}.</echo>
                    </job>
                </task-service>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Rod"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Jane"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
                <task-request taskExecutor="${hello-service}">
                    <properties>
                        <properties>
                            <values>
                                <value key="some.name" value="Freddy"/>
                            </values>
                        </properties>
                    </properties>
                </task-request>
            </jobs>
        </sequential>
    </job>
</oddjob>

Author:

Rob Gordon

Field Summary

Fields

Modifier and Type	Field and Description
protected ChildHelper<java.lang.Object>	childHelper Track changes to children an notify listeners.

Constructor Summary

Constructors

Constructor and Description
TaskExecutionService()

Method Summary

Modifier and Type	Method and Description
void	addStructuralListener(StructuralListener listener) Add a listener.
TaskView	execute(Task task) Execute a task.
InputRequest[]	getParameterInfo() Provide the Parameter meta info for the task.
java.util.Properties	getProperties()
InputRequest	getRequests(int index)
ResetAction	getReset()
java.lang.String	getResponse()
protected void	onStart()
protected void	onStop() Allow sub classes to do something on stop.
void	removeStructuralListener(StructuralListener listener) Remove a listener.
void	setArooaSession(ArooaSession session) Here for the tests...
void	setJob(java.lang.Object job)
void	setRequests(int index, InputRequest request)
void	setReset(ResetAction resetAction)
void	setResponse(java.lang.String responseExpression)

Methods inherited from class org.oddjob.framework.extend.SimpleService

fireDestroyedState, getName, getStateChanger, hardReset, iconHelper, logger, loggerName, onDestroy, run, setName, softReset, stateHandler, stop, toString

Methods inherited from class org.oddjob.framework.extend.BaseComponent

addIconListener, addPropertyChangeListener, addStateListener, configure, destroy, firePropertyChange, getArooaSession, iconForId, initialise, lastStateEvent, onConfigured, onInitialised, removeIconListener, removePropertyChangeListener, removeStateListener, save, save, setArooaContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.oddjob.Stateful

addStateListener, lastStateEvent, removeStateListener

Field Detail

childHelper

protected final ChildHelper<java.lang.Object> childHelper

Track changes to children an notify listeners.

Constructor Detail

TaskExecutionService

public TaskExecutionService()

Method Detail

setArooaSession

public void setArooaSession(ArooaSession session)

Description copied from class: BaseComponent

Here for the tests...

Specified by:

setArooaSession in interface ArooaSessionAware

Overrides:

setArooaSession in class BaseComponent

Parameters:

session - The Arooa Session. Never null.

getRequests

public InputRequest getRequests(int index)

setRequests

public void setRequests(int index,
                        InputRequest request)

getParameterInfo

public InputRequest[] getParameterInfo()

Description copied from interface: TaskExecutor

Provide the Parameter meta info for the task.

Specified by:

getParameterInfo in interface TaskExecutor

Returns:

execute

public TaskView execute(Task task)
                 throws TaskException

Description copied from interface: TaskExecutor

Execute a task.

Specified by:

execute in interface TaskExecutor

Returns:

Throws:

TaskException

onStart

protected void onStart()
                throws java.lang.Throwable

Specified by:

onStart in class SimpleService

Throws:

java.lang.Exception

java.lang.Throwable

onStop

protected void onStop()
               throws FailedToStopException

Description copied from class: SimpleService

Allow sub classes to do something on stop.

Overrides:

onStop in class SimpleService

Throws:

FailedToStopException

addStructuralListener

public void addStructuralListener(StructuralListener listener)

Add a listener. The listener will immediately receive add notifications for all existing children.

Specified by:

addStructuralListener in interface Structural

Parameters:

listener - The listener.

removeStructuralListener

public void removeStructuralListener(StructuralListener listener)

Remove a listener.

Specified by:

removeStructuralListener in interface Structural

Parameters:

listener - The listener.

setJob

public void setJob(java.lang.Object job)

Property: job

Description: The job to pass resets on to.

Required: Yes.

getReset

public ResetAction getReset()

setReset

public void setReset(ResetAction resetAction)

getProperties

public java.util.Properties getProperties()

getResponse

public java.lang.String getResponse()

setResponse

public void setResponse(java.lang.String responseExpression)