edu.illinois.ncsa.datawolf

Class Executor

java.lang.Object

edu.illinois.ncsa.datawolf.Executor

Direct Known Subclasses:

LocalExecutor, RemoteExecutor

public abstract class Executor
extends Object

Author:

Rob Kooper

Field Summary

Fields

Modifier and Type	Field and Description
protected DatasetDao	datasetDao
protected ExecutionDao	executionDao
protected FileDescriptorDao	fileDescriptorDao
protected FileStorage	fileStorage
protected LogFileDao	logFileDao
protected com.google.inject.persist.UnitOfWork	work
protected WorkflowStepDao	workflowStepDao

Constructor Summary

Constructors

Constructor and Description
Executor()

Method Summary

Modifier and Type	Method and Description
protected void	flushLog()
String	getExecutionId() Returns the id of the execution associated with this executor.
abstract String	getExecutorName() Name of the executor.
String	getLog() Return any log information.
Execution.State	getState() Return current state of the execution.
String	getStepId() Returns the id of the step associated with this executor.
boolean	isDebug() Get debug flag for the executor.
boolean	isExecutorReady() Before a step is executed this will check to see if the executor is ready to run.
protected boolean	isJobStopped() Returns true if the job is stopped.
boolean	isStoreLog() Should the executor store the logfiles generated.
protected void	print(String msg) Append message to the log.
protected void	print(String format, Object... args) Append formatted message to the log.
protected void	println(String msg) Append message with newline to the log.
protected void	println(String format, Object... args) Append formatted message with newline to the log.
protected void	println(String msg, Throwable thr) Append message and stacktrace of throwable to the log.
void	setDebug(boolean debug) Set executor debug flag.
void	setJobInformation(Execution execution, WorkflowStep step) Set the job information for this executor.
protected void	setLog(String msg) Sets the log to the message.
void	setState(Execution.State state) Sets the state of the job.
void	setStoreLog(boolean storeLog) Should the logfiles be stored in the database.
abstract void	startJob() The job is ready to be executed.
void	stopJob() The job should be stopped.

Methods inherited from class java.lang.Object

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

Field Detail

executionDao

@Inject
protected ExecutionDao executionDao

logFileDao

@Inject
protected LogFileDao logFileDao

fileDescriptorDao

@Inject
protected FileDescriptorDao fileDescriptorDao

fileStorage

@Inject
protected FileStorage fileStorage

workflowStepDao

@Inject
protected WorkflowStepDao workflowStepDao

datasetDao

@Inject
protected DatasetDao datasetDao

work

@Inject
protected com.google.inject.persist.UnitOfWork work

Constructor Detail

Executor

public Executor()

Method Detail

isDebug

public boolean isDebug()

Get debug flag for the executor. If true, the executor won't cleanup temporary files/directories/etc.

Returns:

true if executor is in debug mode, false otherwise

setDebug

public void setDebug(boolean debug)

Set executor debug flag. Set this to true to indicate that temporary files/directories/etc should not be removed when finished.

Parameters:

debug - set to false (default) to indicate temporary files/directories/etc should be removed

isStoreLog

public boolean isStoreLog()

Should the executor store the logfiles generated.

Returns:

will return true if the logfiles are stored in the database.

setStoreLog

public void setStoreLog(boolean storeLog)

Should the logfiles be stored in the database. Set this to true and the logfiles generated for the execution of a step are stored in the database.

Parameters:

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

getExecutorName

public abstract String getExecutorName()

Name of the executor. This name is used to find the executor to be used for a tool.

Returns:

the name of the executor.

isExecutorReady

public boolean isExecutorReady()

Before a step is executed this will check to see if the executor is ready to run. Some executors need a license, this allows the executor to check and see if a license is available before the step is executed. This can reserve any items needed to run. The executer will be started soon.

Returns:

true if the executor can be run.

setJobInformation

public void setJobInformation(Execution execution,
                              WorkflowStep step)

Set the job information for this executor. Each job will have its own executor. Once all the data for the job is ready the system will call startJob for the job to be launched. When setJobInformation is called it will be inside a transaction and all values inside execution and step can be accessed, however once this function is finished the transaction is committed and accessing data in the execution and/or step can lead to a lazyloading execution.

Parameters:

execution - the execution to be used for job information.

step - the step that needs to be executed.

startJob

public abstract void startJob()

The job is ready to be executed. This function should submit the job and return quickly. This should not do the actual computation.

stopJob

public void stopJob()

The job should be stopped. If the job is actually running it should be killed, if it is waiting to be executed it should not be started.

isJobStopped

protected boolean isJobStopped()

Returns true if the job is stopped. This will allow the executor to check to see if the job should be stopped. Any executor should call this function often to see if the execution was stopped.

Returns:

true if the job is stopped and execution should be stopped.

getStepId

public String getStepId()

Returns the id of the step associated with this executor.

Returns:

id of the step associated with this executor.

getExecutionId

public String getExecutionId()

Returns the id of the execution associated with this executor.

Returns:

id of the execution associated with this executor.

getLog

public String getLog()

Return any log information. This function will return the current log information. This function should return quickly. It is probably best to have a thread running that is responsible for fetching the data and have this function return the latest information available.

Returns:

the current log information.

print

protected void print(String msg)

Append message to the log.

Parameters:

msg - the message to be added to the log.

print

protected void print(String format,
                     Object... args)

Append formatted message to the log.

Parameters:

format - A format string

args - Arguments referenced by the format specifiers in the format string.

println

protected void println(String msg)

Append message with newline to the log.

Parameters:

msg - the message to be added to the log.

println

protected void println(String format,
                       Object... args)

Append formatted message with newline to the log.

Parameters:

format - A format string

args - Arguments referenced by the format specifiers in the format string.

println

protected void println(String msg,
                       Throwable thr)

Append message and stacktrace of throwable to the log.

Parameters:

msg - the messsage to be added to the log.

thr - the throwable to be added to the log.

setLog

protected void setLog(String msg)

Sets the log to the message. This will erase any previous log messages.

Parameters:

msg - the new log message.

flushLog

protected void flushLog()

getState

public Execution.State getState()

Return current state of the execution. This function will return the current state of the execution. This function should return quickly. It is probably best to have a thread running that is responsible for fetching the data and have this function return the latest information available.

Returns:

the current state of the execution.

setState

public void setState(Execution.State state)

Sets the state of the job. This will change the state of the job in the execution object and save it. This will create its own transaction and should not be called inside a transaction.