org.kepler.job

Class Job

java.lang.Object

org.kepler.job.Job

public class Job
extends java.lang.Object

Class Job to describe a standalone job. It is assumed that a job will be submitted only once and then forgotten. Do not resubmit the same Job object but create another one.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Job.JobFile
class	Job.JobFiles

Field Summary

Fields

Modifier and Type	Field and Description
Job.JobFiles	jobfiles
JobStatusInfo	status

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Job(java.lang.String jobID) Constructor is called from JobFactory. jobID is a unique id for the jobs.

Method Summary

Modifier and Type	Method and Description
boolean	deleteFromQueue() Remove job from the queue (either running or waiting)
protected java.lang.String	getBinFile()
Job[]	getDependentJobs() Get a set of jobs that must successfully complete before this job can start.
java.lang.String	getJobID() Get the key of the Job object in the hash table.
protected java.util.Vector	getLocalFiles() Return vector of local files that should be staged to the remote site for a job.
java.lang.String	getLocalWorkdirPath()
int	getNumTasks()
protected java.util.Vector	getRemoteFiles() Return vector of remote files that should be copied into to remote job directory before submission.
java.lang.String	getSubmitFile()
java.lang.String	getWorkdirPath()
protected boolean	isBinFileLocal()
protected boolean	isSubmitFileLocal()
boolean	reconnect(JobManager jobmanager) Reconnect to a executing job.
void	setBinFile(java.lang.String binFile, boolean isLocal) Set file to be staged to bin path.
void	setDependentJobs(Job[] dependentJobs) Specify a set of jobs that must successfully complete before this can start.
boolean	setExecutable(java.lang.String executablePath, boolean isLocal, java.lang.String arguments) Set the executable for the job.
boolean	setInputFile(java.lang.String path, boolean isLocal) Set an input file for job.
boolean	setLocalWorkdir(java.lang.String path) Set and create the local working directory.
void	setNumTasks(int nt)
boolean	setOtherInputFile(java.lang.String path) Set an "other" input file for job.
void	setOutputFile(java.lang.String path) Set an output file for job.
void	setSubmitFile(java.lang.String submitFile, boolean isItLocal) Give a predefined submit file for the job.
boolean	setWorkdir(java.lang.String path) Set the (remote) working directory.
boolean	setWorkdir(java.lang.String path, boolean createUniqueSubdir) Set the (remote) working directory.
boolean	status() Check the status of the job
java.lang.String	submit(JobManager jobmanager, boolean overwrite, java.lang.String options) Submit a job, called from Job.submit(); boolean overwrite indicates whether old files that exist on the same directory should be removed before staging new files.

Methods inherited from class java.lang.Object

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

Field Detail

status

public JobStatusInfo status

jobfiles

public Job.JobFiles jobfiles

Constructor Detail

Job

protected Job(java.lang.String jobID)

Constructor is called from JobFactory. jobID is a unique id for the jobs. Currently only for the current applications. Later it will be an uuid.

Method Detail

getJobID

public java.lang.String getJobID()

Get the key of the Job object in the hash table. Used by JobManager to create unique files based on Job's key Do not mix it with status.jobID, which is the real job id in the remote queue.

setNumTasks

public void setNumTasks(int nt)

getNumTasks

public int getNumTasks()

setExecutable

public boolean setExecutable(java.lang.String executablePath,
                             boolean isLocal,
                             java.lang.String arguments)
                      throws JobException

Set the executable for the job. executablePath is the path to the executable isLocal true means a local file, false means the executable is on the remote site arguments are the arguments to be passed to the job. This will work only if the submission file is created by the JobManager and not provided as is in the setSubmitFile() method.

Returns:

true if succeeds. Throws JobException if isLocal is true but executable is not found locally.

Throws:

JobException

setInputFile

public boolean setInputFile(java.lang.String path,
                            boolean isLocal)
                     throws JobException

Set an input file for job. It can be either locally present or remotely.

Returns:

true at success, but throws JobException if file is assumed to be a local file and it does not exist.

Throws:

JobException

setBinFile

public void setBinFile(java.lang.String binFile,
                       boolean isLocal)
                throws JobException

Set file to be staged to bin path. It can be either locally present or remotely. It is currently used for staging default fork script jmgr-fork.sh from job/resources

Throws:

JobException

setOtherInputFile

public boolean setOtherInputFile(java.lang.String path)
                          throws JobException

Set an "other" input file for job. It will be staged to the remote site into the remote working dir but it will not be used in creating the submission file.

Returns:

true at success, but throws JobException if file is assumed to be a local file and it does not exist.

Throws:

JobException

setOutputFile

public void setOutputFile(java.lang.String path)
                   throws JobException

Set an output file for job. It should be the name of output file which will be produced by the job.

Throws:

JobException

setLocalWorkdir

public boolean setLocalWorkdir(java.lang.String path)
                        throws JobException

Set and create the local working directory. For local execution, it will be the same as the working directory, so it is not necessary to set. For remote execution, the result of the remote job will be brought to this directory (not implemented!).

Returns:

true if creation succeeded, throws JobException otherwise

Throws:

JobException

setWorkdir

public boolean setWorkdir(java.lang.String path)

Set the (remote) working directory. The directory given as path must exist already. The actual working directory of a job will be this path appended with the job's myID. That directory will be created automatically and the job submission will be issued from this directory. I.e. relative input/output filenames in the job submission refer files under this directory. To get back the actual working directory name, use getWorkdirPath().

Returns:

if path==null, it returns false, otherwise true

setWorkdir

public boolean setWorkdir(java.lang.String path,
                          boolean createUniqueSubdir)

Set the (remote) working directory. If "createUniqueSubdir" is set to false, then the given dir is used as working dir. If "createUniqueSubdir" is set to true, the directory given as path must exist already and tThe actual working directory will be this path appended with the job's myID. That directory will be created automatically and the job submission will be issued from this directory. I.e. relative input/output filenames in the job submission refer files under this directory. To get back the actual working directory name, use getWorkdirPath().

Returns:

if path==null, it returns false, otherwise true

getLocalWorkdirPath

public java.lang.String getLocalWorkdirPath()

getWorkdirPath

public java.lang.String getWorkdirPath()

setSubmitFile

public void setSubmitFile(java.lang.String submitFile,
                          boolean isItLocal)
                   throws JobException

Give a predefined submit file for the job. This is the most general possibility for advanced users, to submit jobs to a specific job manager. For basic users, do not use this method. Just define the executable, input and output files for the Job and the JobManager will create an appropriate submit file for the selected job manager. !!!That is not implemented in the support classes, so you must use this method always!!!

Throws:

JobException

submit

public java.lang.String submit(JobManager jobmanager,
                               boolean overwrite,
                               java.lang.String options)
                        throws JobException

Submit a job, called from Job.submit(); boolean overwrite indicates whether old files that exist on the same directory should be removed before staging new files. As long jobIDs are not really unique, this is worth to be true. options can be a special options string for the actual jobmanager.

Throws:

JobException

reconnect

public boolean reconnect(JobManager jobmanager)
                  throws JobException

Reconnect to a executing job. As long jobIDs are not really unique, this is worth to be true. options can be a special options string for the actual jobmanager.

Throws:

JobException

status

public boolean status()
               throws JobException

Check the status of the job

Throws:

JobException

deleteFromQueue

public boolean deleteFromQueue()
                        throws JobException

Remove job from the queue (either running or waiting)

Throws:

JobException

setDependentJobs

public void setDependentJobs(Job[] dependentJobs)

Specify a set of jobs that must successfully complete before this can start.

getDependentJobs

public Job[] getDependentJobs()

Get a set of jobs that must successfully complete before this job can start. If there are none, returns null.

getSubmitFile

public java.lang.String getSubmitFile()

isSubmitFileLocal

protected boolean isSubmitFileLocal()

getBinFile

protected java.lang.String getBinFile()

isBinFileLocal

protected boolean isBinFileLocal()

getLocalFiles

protected java.util.Vector getLocalFiles()

Return vector of local files that should be staged to the remote site for a job. Vector elements are type of File!

getRemoteFiles

protected java.util.Vector getRemoteFiles()

Return vector of remote files that should be copied into to remote job directory before submission. Vector elements are type of Strings!