edu.illinois.ncsa.datawolf

Class RemoteExecutor

java.lang.Object

edu.illinois.ncsa.datawolf.Executor

edu.illinois.ncsa.datawolf.RemoteExecutor

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

HPCExecutor

public abstract class RemoteExecutor
extends Executor
implements Runnable

This executor will run the job on a remote server. There is no limits on the number of remote executors that can run in parallel. Each remote executor will run in its own thread. The thread will submit the job and check on the job status continuously.

Author:

Rob Kooper

Field Summary

Fields inherited from class edu.illinois.ncsa.datawolf.Executor

datasetDao, executionDao, fileDescriptorDao, fileStorage, logFileDao, work, workflowStepDao

Constructor Summary

Constructors

Constructor and Description
RemoteExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	cancelRemoteJob() Tries to cancel the job on the remote server.
abstract Execution.State	checkRemoteJob() Checks the status of the job on the remote server.
abstract String	getRemoteLog() Checks the remote server for any log messages.
void	run() Submit the remote job and keep checking to see what the status of the job is and fetch any remote information.
void	startJob() The job is ready to be executed.
void	stopJob() The job should be stopped.
abstract Execution.State	submitRemoteJob(File cwd) Submit the job to the remote server.

Methods inherited from class edu.illinois.ncsa.datawolf.Executor

flushLog, getExecutionId, getExecutorName, getLog, getState, getStepId, isDebug, isExecutorReady, isJobStopped, isStoreLog, print, print, println, println, println, setDebug, setJobInformation, setLog, setState, setStoreLog

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoteExecutor

public RemoteExecutor()

Method Detail

startJob

public void startJob()

Description copied from class: Executor

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

Specified by:

startJob in class Executor

stopJob

public void stopJob()

Description copied from class: Executor

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.

Overrides:

stopJob in class Executor

run

public void run()

Submit the remote job and keep checking to see what the status of the job is and fetch any remote information.

Specified by:

run in interface Runnable

submitRemoteJob

public abstract Execution.State submitRemoteJob(File cwd)
                                         throws AbortException,
                                                FailedException

Submit the job to the remote server. This will return the new state of step.

Returns:

the new state of the step

Throws:

AbortException - an abort exception is thrown if the job submission is aborted.

FailedException - a failed exception is thrown if the job submission fails to submit properly.

cancelRemoteJob

public abstract void cancelRemoteJob()

Tries to cancel the job on the remote server.

checkRemoteJob

public abstract Execution.State checkRemoteJob()
                                        throws FailedException

Checks the status of the job on the remote server. This will return the current state of the step. This function can return null if the state of the step has not changed since the previous call.

Returns:

the state of the step (this could be the same state as before, or null if the state did not change).

Throws:

FailedException - a failed exception is thrown if the status check fails.

getRemoteLog

public abstract String getRemoteLog()

Checks the remote server for any log messages. This will assume that the log returned is the full log from the server. This can return null if the log did not change.

Returns:

the log from the server.