edu.illinois.ncsa.datawolf.executor.hpc

Class HPCExecutor

java.lang.Object

edu.illinois.ncsa.datawolf.Executor

edu.illinois.ncsa.datawolf.RemoteExecutor

edu.illinois.ncsa.datawolf.executor.hpc.HPCExecutor

All Implemented Interfaces:

Runnable

public class HPCExecutor
extends RemoteExecutor

The HPCExecutor will launch remote jobs based on machine information provided in the XML template. The executable will be passed an arbitrary set of parameters at the command line based on what the user specified when creating the tool. Limitation: file staging currently needs to happen in a separate tool. TODO CMN : add file staging capability, executor options (e.g. ncpus)

Author:

"Chris Navarro "

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXECUTOR_NAME
protected HPCJobInfoDao	hpcJobInfoDao

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

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

Constructor Summary

Constructors

Constructor and Description
HPCExecutor()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelRemoteJob() Tries to cancel the job on the remote server.
Execution.State	checkRemoteJob() Checks the status of the job on the remote server.
String	getExecutorName() Name of the executor.
Execution.State	getGondolaLogFile()
String	getRemoteLog() Checks the remote server for any log messages.
String	parseJobId(String[] lines)
Execution.State	submitRemoteJob(File cwd) Submit the job to the remote server.
protected void	updateJobScript(ScriptType script, Map<String,String> fileMap, List<String> command, String stagingDir)

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

run, startJob, stopJob

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

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

Methods inherited from class java.lang.Object

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

Field Detail

EXECUTOR_NAME

public static final String EXECUTOR_NAME

See Also:

Constant Field Values

hpcJobInfoDao

@Inject
protected HPCJobInfoDao hpcJobInfoDao

Constructor Detail

HPCExecutor

public HPCExecutor()

Method Detail

submitRemoteJob

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

Description copied from class: RemoteExecutor

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

Specified by:

submitRemoteJob in class RemoteExecutor

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.

parseJobId

public String parseJobId(String[] lines)

updateJobScript

protected void updateJobScript(ScriptType script,
                   Map<String,String> fileMap,
                   List<String> command,
                   String stagingDir)

cancelRemoteJob

public void cancelRemoteJob()

Description copied from class: RemoteExecutor

Tries to cancel the job on the remote server.

Specified by:

cancelRemoteJob in class RemoteExecutor

checkRemoteJob

public Execution.State checkRemoteJob()
                               throws FailedException

Description copied from class: RemoteExecutor

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.

Specified by:

checkRemoteJob in class RemoteExecutor

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.

getGondolaLogFile

public Execution.State getGondolaLogFile()

getRemoteLog

public String getRemoteLog()

Description copied from class: RemoteExecutor

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.

Specified by:

getRemoteLog in class RemoteExecutor

Returns:

the log from the server.

getExecutorName

public String getExecutorName()

Description copied from class: Executor

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

Specified by:

getExecutorName in class Executor

Returns:

the name of the executor.