org.kuali.ole.sys.context

Class BatchContainerDirectory

java.lang.Object

org.kuali.ole.sys.context.BatchContainerDirectory

public class BatchContainerDirectory
extends Object

BatchContainerDirectory knows the path to the directory for the BatchContainerStep and BatchStepTrigger semaphore files. It also handles much of the logic for writing, reading, and removing those files. BatchContainerDirectory adds a ConsoleAppender to its Logger if one hasn't been configured.

Constructor Summary

Constructors

Constructor and Description
BatchContainerDirectory(String batchContainerPath) Creates a reference for the path to the batch container.

Method Summary

Methods

Modifier and Type	Method and Description
void	addShutdownHook() Creates a shutdown hook and adds it to the local Runtime so that if the container's VM is shut down, the semaphore files will be removed
String	getExceptionFromFile(BatchStepFileDescriptor errorResultFile) Returns the Exception contained in an error result file
BatchStepFileDescriptor	getResultFile(BatchStepFileDescriptor batchStepFile) Returns the result file (either a success file or an error file) if one exists for the specified step.
int	getStepIndexFromFile(BatchStepFileDescriptor batchStepFile) Returns the index of the step contained in the file
File[]	getStepRunFiles() Returns a list of files in the batch container with the run extension
boolean	isBatchContainerRunning() Checks whether the batch container is currently running (by checking for the presence of the batch container semaphore file)
boolean	isFileEmpty(BatchStepFileDescriptor batchStepFile) Checks whether the step's semaphore file in the descriptor is null and if not whether the step's semaphore file in the directory is empty
void	logFileContents(BatchStepFileDescriptor batchStepFile, org.apache.log4j.Logger log) Reads the contents of the semaphore file (normally the error file), and writes the contents to the requested Logger.
void	removeBatchContainerSemaphore() Removes the semaphore file which indicates that the batch container is running
void	removeBatchStepFileFromSystem(BatchStepFileDescriptor batchStepFile) Removes the semaphore file for the specified step
void	writeBatchContainerSemaphore(String jobName, String stepName) Writes the semaphore file which indicates that the batch container is running
void	writeBatchStepErrorResultFile(BatchStepFileDescriptor batchStepFile) Writes the error file for the Step specified in the descriptor
void	writeBatchStepErrorResultFile(BatchStepFileDescriptor batchStepFile, Throwable error) Writes the error file for the Step specified in the descriptor.
void	writeBatchStepRunFile(BatchStepFileDescriptor batchStepFile, int stepIndex) Writes the run file for the Step specified in the descriptor
void	writeBatchStepSuccessfulResultFile(BatchStepFileDescriptor batchStepFile) Writes the success file for the Step specified in the descriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchContainerDirectory

public BatchContainerDirectory(String batchContainerPath)

Creates a reference for the path to the batch container. Verifies that the directory exists and throws an error if it does not.

Parameters:

batchContainerPath - the path to the directory that contains the semaphore files

Method Detail

writeBatchContainerSemaphore

public void writeBatchContainerSemaphore(String jobName,
                                String stepName)

Writes the semaphore file which indicates that the batch container is running

Parameters:

jobName - the name of the job that is starting the batch container

stepName - the name of the step which starts the batch container

removeBatchContainerSemaphore

public void removeBatchContainerSemaphore()

Removes the semaphore file which indicates that the batch container is running

isBatchContainerRunning

public boolean isBatchContainerRunning()

Checks whether the batch container is currently running (by checking for the presence of the batch container semaphore file)

Returns:

true if the batch container is running (if the semaphore file exists), false otherwise

getStepRunFiles

public File[] getStepRunFiles()

Returns a list of files in the batch container with the run extension

Returns:

a list of step .run files

writeBatchStepRunFile

public void writeBatchStepRunFile(BatchStepFileDescriptor batchStepFile,
                         int stepIndex)

Writes the run file for the Step specified in the descriptor

Parameters:

batchStepFile - the step for which a .run file will be written

stepIndex - the index of the step in the job

writeBatchStepSuccessfulResultFile

public void writeBatchStepSuccessfulResultFile(BatchStepFileDescriptor batchStepFile)

Writes the success file for the Step specified in the descriptor

Parameters:

batchStepFile - the step for which a .success file will be written

writeBatchStepErrorResultFile

public void writeBatchStepErrorResultFile(BatchStepFileDescriptor batchStepFile)

Writes the error file for the Step specified in the descriptor

Parameters:

batchStepFile - the step for which a .error file will be written

writeBatchStepErrorResultFile

public void writeBatchStepErrorResultFile(BatchStepFileDescriptor batchStepFile,
                                 Throwable error)

Writes the error file for the Step specified in the descriptor. The stack trace in the Throwable will be written to the file.

Parameters:

batchStepFile - the step for which a .error file will be written

error - the error to write in the error file

removeBatchStepFileFromSystem

public void removeBatchStepFileFromSystem(BatchStepFileDescriptor batchStepFile)

Removes the semaphore file for the specified step

Parameters:

batchStepFile - the step for which the semaphore file should be removed

getResultFile

public BatchStepFileDescriptor getResultFile(BatchStepFileDescriptor batchStepFile)

Returns the result file (either a success file or an error file) if one exists for the specified step. Otherwise null is returned.

Parameters:

batchStepFile - the step for which a result file is requested

Returns:

the descriptor of the result file if one exists, null otherwise

isFileEmpty

public boolean isFileEmpty(BatchStepFileDescriptor batchStepFile)

Checks whether the step's semaphore file in the descriptor is null and if not whether the step's semaphore file in the directory is empty

Parameters:

batchStepFile - the descriptor for which a semaphore file existence check is requested

Returns:

true if the step's semaphore file is empty, false otherwise. Throws a RuntimeException if the file does not exist.

getStepIndexFromFile

public int getStepIndexFromFile(BatchStepFileDescriptor batchStepFile)

Returns the index of the step contained in the file

Parameters:

batchStepFile - the file from which to retrieve the step index

Returns:

the step index, or -1 if there was no content in the file

logFileContents

public void logFileContents(BatchStepFileDescriptor batchStepFile,
                   org.apache.log4j.Logger log)

Reads the contents of the semaphore file (normally the error file), and writes the contents to the requested Logger.

Parameters:

batchStepFile - the descriptor whose semaphore file's contents should be written to the Logger

log - the log to write the file contents to

getExceptionFromFile

public String getExceptionFromFile(BatchStepFileDescriptor errorResultFile)

Returns the Exception contained in an error result file

Parameters:

errorResultFile -

Returns:

the exception

addShutdownHook

public void addShutdownHook()

Creates a shutdown hook and adds it to the local Runtime so that if the container's VM is shut down, the semaphore files will be removed