edu.illinois.ncsa.datawolf

Class Engine

java.lang.Object

edu.illinois.ncsa.datawolf.Engine

@Singleton
public class Engine
extends Object

Engine that is responsible for executing the steps. This is an abstract class that defines the methods that the engine will need to implement.

Author:

Rob Kooper

Constructor Summary

Constructors

Constructor and Description
Engine() Create the engine with a single worker.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExecutor(Executor executor) Add an executor to the list of known executors.
void	execute(Execution execution) Submit the all the steps in the workflow to the engine to be executed.
void	execute(Execution execution, String... steps) Submit the step to the engine to be executed.
void	execute(Execution execution, WorkflowStep... steps) Submit the step to the engine to be executed.
Executor	findExecutor(String name) Find an executor that fits the given name.
Set<Executor>	getExecutors()
int	getExtraLocalExecutor() The number of additional jobs that can be scheduled on the local executor.
Collection<String>	getSteps(String executionId)
int	getTimeout() Return the timout the engine will wait when no steps are ready to be executed, or executing before it declares the workflow aborted.
boolean	hasStep(String executionId, String stepId)
boolean	isStoreLogs() Returns true if the executors store the logfiles in the database.
void	setExecutors(Set<Executor> executors)
void	setExtraLocalExecutor(int extraLocalExecutor) Sets the number of additional jobs that can be scheduled.
void	setLocalExecutorThreads(int threads)
void	setStoreLogs(boolean storeLogs) Should the logfiles be stored in the database.
void	setTimeout(int timeout) Sets the timeout for a workflow in seconds.
void	stop(String executionId) Stops all steps in a execution from being executed, and removes it from the list.
void	stop(String executionId, String... steps) Stops a particular step from being executed, and removes it from the list.
void	stopAll() Stop all steps from executing.

Methods inherited from class java.lang.Object

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

Constructor Detail

Engine

public Engine()

Create the engine with a single worker.

Method Detail

setLocalExecutorThreads

@Inject
public void setLocalExecutorThreads(@Named(value="engine.localExecutorThreads")
                                  int threads)

isStoreLogs

public boolean isStoreLogs()

Returns true if the executors store the logfiles in the database.

Returns:

true if the logfiles are stored in the database.

setStoreLogs

public void setStoreLogs(boolean storeLogs)

Should the logfiles be stored in the database. Set this to true to store the logfiles in a database.

Parameters:

storeLogs - set this to true (the default) to store the logfiles in the database.

getExtraLocalExecutor

public int getExtraLocalExecutor()

The number of additional jobs that can be scheduled on the local executor. The local executor has a limit of jobs it can run based on getLocalExecutorThreads(), this will allow additional jobs to be scheduled to keep the local executor always busy. The default is one additional jobs.

Returns:

the number of additional jobs that can be scheduled.

setExtraLocalExecutor

public void setExtraLocalExecutor(int extraLocalExecutor)

Sets the number of additional jobs that can be scheduled. See getExtraLocalExecutor().

Parameters:

extraLocalExecutor - the number of additional jobs that can be scheduled.

getTimeout

public int getTimeout()

Return the timout the engine will wait when no steps are ready to be executed, or executing before it declares the workflow aborted.

Returns:

the number of seconds before a workflow is declared as aborted.

setTimeout

public void setTimeout(int timeout)

Sets the timeout for a workflow in seconds. If a workflow has steps that are in WAITING and no steps that are currently executing, and none of the steps in WAITING can be executed, the engine will wait this many seconds before it declares the workflow as ABORTED. Setting the timeout to 0 will disable the timeout.

Parameters:

timeout - the number of seconds to wait before the workflow is declared ABORTED.

findExecutor

public Executor findExecutor(String name)

Find an executor that fits the given name. This will create a new instance of the executor.

Parameters:

name - the name of the executor to find.

Returns:

an instance of the executor.

addExecutor

public void addExecutor(Executor executor)

Add an executor to the list of known executors.

Parameters:

executor - the executor, any executions will be done on a new instance of the executor.

setExecutors

public void setExecutors(Set<Executor> executors)

getExecutors

public Set<Executor> getExecutors()

execute

public void execute(Execution execution)

Submit the all the steps in the workflow to the engine to be executed. This will submit the step to the engine and the engine will execute this step with the given execution environment. Based on the engine, this could happen immediately, on a remote server or at some time in the future.

Parameters:

execution - the execution information

Throws:

Exception - if the step could not be added to the list.

execute

public void execute(Execution execution,
           String... steps)

Submit the step to the engine to be executed. This will submit the step to the engine and the engine will execute this step with the given execution environment. Based on the engine, this could happen immediately, on a remote server or at some time in the future.

Parameters:

execution - the execution information

steps - the list of steps to be executed.

execute

public void execute(Execution execution,
           WorkflowStep... steps)

Submit the step to the engine to be executed. This will submit the step to the engine and the engine will execute this step with the given execution environment. Based on the engine, this could happen immediately, on a remote server or at some time in the future.

Parameters:

execution - the execution information

steps - the list of steps to be executed.

hasStep

public boolean hasStep(String executionId,
              String stepId)

getSteps

public Collection<String> getSteps(String executionId)

stop

public void stop(String executionId,
        String... steps)

Stops a particular step from being executed, and removes it from the list. If the step is already executing attempts will be made to stop the step from executing.

Parameters:

executionId - the execution Id

steps - the list of steps to be stopped.

stop

public void stop(String executionId)

Stops all steps in a execution from being executed, and removes it from the list. If the step is already executing attempts will be made to stop the step from executing.

Parameters:

executionId - the execution Id

stopAll

public void stopAll()

Stop all steps from executing. This will remove all non executed steps from the queue, and attempt to stop all steps currently executing.