org.jenkinsci.plugins.lsf

Class BatchSystem

java.lang.Object

org.jenkinsci.plugins.lsf.BatchSystem

Direct Known Subclasses:

LSF

public abstract class BatchSystem
extends Object

Author:

Laisvydas Skurevicius

Field Summary

Fields

Modifier and Type	Field and Description
protected hudson.model.AbstractBuild<?,?>	build
protected String	COMMUNICATION_FILE
protected com.michelin.cio.hudson.plugins.copytoslave.CopyToMasterNotifier	copyFileToMaster
protected hudson.Launcher	launcher
protected hudson.model.BuildListener	listener
protected String	masterWorkingDirectory

Constructor Summary

Constructors

Constructor and Description
BatchSystem(hudson.model.AbstractBuild<?,?> build, hudson.Launcher launcher, hudson.model.BuildListener listener, String COMMUNICATION_FILE, String masterWorkingDirectory)

Method Summary

Modifier and Type	Method and Description
abstract void	cleanUpFiles(String jobId) cleans up the files created by the batch system
abstract void	createFinishedJobOutputFile(String jobId, int offset) creates the final job output file of the finished job in the slave
abstract void	createFormattedRunningJobOutputFile(String outputFileName, int offset, int numberOfLines) creates a formatted job output file of the running job in the slave from the specified output file (created by createJobProgressFile method)
abstract void	createJobProgressFile(String jobId, String outputFileName) creates the job output file of the running job in the slave
abstract String	getJobStatus(String jobId)
abstract boolean	isEndStatus(String jobStatus)
abstract boolean	isRunningStatus(String jobStatus)
abstract boolean	jobCompletedSuccessfully(String jobStatus)
abstract boolean	jobExitedWithErrors(String jobStatus)
abstract void	killJob(String jobId) kills the job with specified job id in the batch system
abstract void	printErrorLog() prints the error log to the slave console
abstract void	printExitCode(String jobId) prints the exit code to the slave console
abstract void	processStatus(String jobStatus) executes the appropriate actions depending on the status of the job (prints the appropriate messages)
abstract String	submitJob(String jobFileName, boolean sendEmail, String queueType) submits the the job to the batch system's selected queue and configures if an email should be sent after the job is done

Methods inherited from class java.lang.Object

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

Field Detail

build

protected final hudson.model.AbstractBuild<?,?> build

launcher

protected final hudson.Launcher launcher

listener

protected final hudson.model.BuildListener listener

COMMUNICATION_FILE

protected final String COMMUNICATION_FILE

copyFileToMaster

protected final com.michelin.cio.hudson.plugins.copytoslave.CopyToMasterNotifier copyFileToMaster

masterWorkingDirectory

protected final String masterWorkingDirectory

Constructor Detail

BatchSystem

public BatchSystem(hudson.model.AbstractBuild<?,?> build,
                   hudson.Launcher launcher,
                   hudson.model.BuildListener listener,
                   String COMMUNICATION_FILE,
                   String masterWorkingDirectory)

Method Detail

submitJob

public abstract String submitJob(String jobFileName,
                                 boolean sendEmail,
                                 String queueType)
                          throws InterruptedException,
                                 IOException

submits the the job to the batch system's selected queue and configures if an email should be sent after the job is done

Parameters:

jobFileName - name of the job file

sendEmail - specifies if an email should be sent

queueType - the batch system's queue type (if it has one)

Returns:

the job id of the submitted job

Throws:

InterruptedException

IOException

getJobStatus

public abstract String getJobStatus(String jobId)
                             throws IOException,
                                    InterruptedException

Parameters:

jobId -

Returns:

the job status of the specified job id

Throws:

IOException

InterruptedException

killJob

public abstract void killJob(String jobId)
                      throws InterruptedException

kills the job with specified job id in the batch system

Parameters:

jobId - the identifier of the job

Throws:

InterruptedException

processStatus

public abstract void processStatus(String jobStatus)

executes the appropriate actions depending on the status of the job (prints the appropriate messages)

Parameters:

jobStatus - the status of the job

printErrorLog

public abstract void printErrorLog()
                            throws InterruptedException

prints the error log to the slave console

Throws:

InterruptedException

printExitCode

public abstract void printExitCode(String jobId)
                            throws InterruptedException,
                                   IOException

prints the exit code to the slave console

Parameters:

jobId - the identifier of the job

Throws:

InterruptedException

IOException

createJobProgressFile

public abstract void createJobProgressFile(String jobId,
                                           String outputFileName)
                                    throws InterruptedException,
                                           IOException

creates the job output file of the running job in the slave

Parameters:

jobId - the identifier of the job

outputFileName - name of the created output file

Throws:

InterruptedException

IOException

createFormattedRunningJobOutputFile

public abstract void createFormattedRunningJobOutputFile(String outputFileName,
                                                         int offset,
                                                         int numberOfLines)
                                                  throws InterruptedException,
                                                         IOException

creates a formatted job output file of the running job in the slave from the specified output file (created by createJobProgressFile method)

Parameters:

outputFileName - the output file that should be formatted

offset - number of lines that should be skipped from the given output file

numberOfLines - the total amount of lines of the given output file

Throws:

InterruptedException

IOException

createFinishedJobOutputFile

public abstract void createFinishedJobOutputFile(String jobId,
                                                 int offset)
                                          throws InterruptedException

creates the final job output file of the finished job in the slave

Parameters:

jobId - the identifier of the job

offset - number of lines that should be skipped from the final output

Throws:

InterruptedException

cleanUpFiles

public abstract void cleanUpFiles(String jobId)
                           throws InterruptedException

cleans up the files created by the batch system

Parameters:

jobId -

Throws:

InterruptedException

isRunningStatus

public abstract boolean isRunningStatus(String jobStatus)

Parameters:

jobStatus - the status of the job

Returns:

true if the given job status is a running status

isEndStatus

public abstract boolean isEndStatus(String jobStatus)

Parameters:

jobStatus - the status of the job

Returns:

true if the given job status is an ending state

jobExitedWithErrors

public abstract boolean jobExitedWithErrors(String jobStatus)

Parameters:

jobStatus - the status of the job

Returns:

true if the job exited with errors

jobCompletedSuccessfully

public abstract boolean jobCompletedSuccessfully(String jobStatus)

Parameters:

jobStatus - the status of the job

Returns:

true if the job completed successfully without errors