org.kuali.ole.sys.batch

Class BatchContainerStep

java.lang.Object

org.kuali.ole.sys.batch.InitiateDirectoryBase

org.kuali.ole.sys.batch.AbstractStep

org.kuali.ole.sys.batch.BatchContainerStep

All Implemented Interfaces:

InitiateDirectory, Step, ContainerStepListener, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class BatchContainerStep
extends AbstractStep
implements ContainerStepListener

BatchContainerStep looks for .run files. When one is found it deletes the file and creates a new thread (BatchStepExecutor) which executes the Step indicated by the .run file. BatchContainerStep continues looking for .run files until it finds a stopBatchContainerStep.run file. When BatchContainerStep begins it writes a .runlock file to indicate that the batch container is running, but will first look for an existing .runlock file and if one is found it will exit immediately. BatchContainerStep adds a ConsoleAppender to its Logger if one hasn't been configured.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	batchContainerDirectory
protected Step	batchContainerStopStep
protected List<BatchStepFileDescriptor[]>	completedSteps
protected StringBuffer	containerResults
protected BatchContainerDirectory	directory
protected Map<String,BatchStepFileDescriptor>	startedSteps

Fields inherited from class org.kuali.ole.sys.batch.AbstractStep

batchInputFileType, dateTimeService, interrupted, name, parameterService

Constructor Summary

Constructors

Constructor and Description
BatchContainerStep()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(String jobName, Date jobRunDate) This method begins an infinite loop in order to process semaphore files written by BatchStepTrigger (called via the brte scripts).
Step	getBatchContainerStopStep()
protected long	getSemaphoreProcessingInterval()
protected Step	getStep(BatchStepFileDescriptor batchStepFile) Retrieves the Step bean from the SpringContext
protected void	initContainerResults() Initialize the structures necessary for logging the Steps' statistics
protected boolean	isStopBatchContainerTriggered(Step step)
protected void	logContainerResultsSummary() Print a summary of the steps that ran and the steps that haven't completed yet.
protected void	logStepFinished(BatchStepFileDescriptor resultFile, String logFileName) Log the notification that the Step finished to an internal buffer.
protected void	logStepStarted(BatchStepFileDescriptor runFile, String logFileName) Log the notification that the Step started to an internal buffer.
void	setBatchContainerDirectory(String batchContainerDirectory) The path to the directory in which BatchContainerStep, BatchStepExecutor, and BatchStepTrigger will read and write the step semaphore files.
void	setBatchContainerStopStep(Step batchContainerStopStep) The Step which indicates to the Batch Container to shut itself down.
protected void	sleep() Sleep for a specified amount of time before looking for more semaphore files to process
void	stepFinished(BatchStepFileDescriptor resultFile, String logFileName) Notification that the Step finished.
void	stepStarted(BatchStepFileDescriptor runFile, String logFileName) Notification that the Step started.

Methods inherited from class org.kuali.ole.sys.batch.AbstractStep

afterPropertiesSet, getBatchInputFileType, getDateTimeService, getName, getParameterService, getRequiredDirectoryNames, interrupt, isInterrupted, setBatchInputFileType, setBeanName, setDateTimeService, setInterrupted, setParameterService

Methods inherited from class org.kuali.ole.sys.batch.InitiateDirectoryBase

prepareDirectories

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.sys.batch.InitiateDirectory

prepareDirectories

Field Detail

batchContainerDirectory

protected String batchContainerDirectory

batchContainerStopStep

protected Step batchContainerStopStep

directory

protected BatchContainerDirectory directory

containerResults

protected StringBuffer containerResults

startedSteps

protected Map<String,BatchStepFileDescriptor> startedSteps

completedSteps

protected List<BatchStepFileDescriptor[]> completedSteps

Constructor Detail

BatchContainerStep

public BatchContainerStep()

Method Detail

execute

public boolean execute(String jobName,
              Date jobRunDate)
                throws InterruptedException

This method begins an infinite loop in order to process semaphore files written by BatchStepTrigger (called via the brte scripts). BatchStepTrigger writes .run files, BatchContainerStep reads .run files and calls BatchStepExecutor (its own thread) which will execute the Step and write either a .success or .error result file which is then read by BatchStepTrigger. This method exits gracefully when it receives a .run file for the batchContainerStopStep.

Specified by:

execute in interface Step

Parameters:

jobName - the name of the job running the step

jobRunDate - the time/date the job is executed

Returns:

true if successful and continue the job, false if successful and stop the job

Throws:

InterruptedException

stepStarted

public void stepStarted(BatchStepFileDescriptor runFile,
               String logFileName)

Notification that the Step started. Log the Step's information

Specified by:

stepStarted in interface ContainerStepListener

Parameters:

runFile - The Step's .run file descriptor

logFileName - The Step's log file created by its executor. The logFile is used to provide a unique identifier for this run of the Step

stepFinished

public void stepFinished(BatchStepFileDescriptor resultFile,
                String logFileName)

Notification that the Step finished. Log the Step's information

Specified by:

stepFinished in interface ContainerStepListener

Parameters:

resultFile - the Step's .success or .error file descriptor

logFileName - The Step's log file created by its executor when the step started. The logFile is used to provide a unique identifier for this run of the Step

getStep

protected Step getStep(BatchStepFileDescriptor batchStepFile)

Retrieves the Step bean from the SpringContext

Parameters:

batchStepFile - the file descriptor for the step to run

Returns:

the Step bean from the SpringContext

isStopBatchContainerTriggered

protected boolean isStopBatchContainerTriggered(Step step)

Parameters:

step - the Step specified by the .run file

Returns:

true if the Step received is the step to stop the batch container, false otherwise

sleep

protected void sleep()

Sleep for a specified amount of time before looking for more semaphore files to process

getSemaphoreProcessingInterval

protected long getSemaphoreProcessingInterval()

Returns:

(in milliseconds) the amount of time to wait before looking for more semaphore files to process

initContainerResults

protected void initContainerResults()

Initialize the structures necessary for logging the Steps' statistics

logStepStarted

protected void logStepStarted(BatchStepFileDescriptor runFile,
                  String logFileName)

Log the notification that the Step started to an internal buffer. Add the descriptor to the list of started steps. The logFileName is used as a unique identifier in the list of started steps in order to identify it in the list of started steps on completion.

Parameters:

runFile - the step's run file descriptor

logFileName - the name of the log created by the Step's executor.

logStepFinished

protected void logStepFinished(BatchStepFileDescriptor resultFile,
                   String logFileName)

Log the notification that the Step finished to an internal buffer. Remove the run descriptor from the list of started steps and add the run descriptor and the result descriptor to the list of completed steps. The logFileName is used to locate the run descriptor from the list of started steps.

Parameters:

resultFile - the step's result file descriptor

logFileName - the name of the log created by the Step's executor

logContainerResultsSummary

protected void logContainerResultsSummary()

Print a summary of the steps that ran and the steps that haven't completed yet.

setBatchContainerDirectory

public void setBatchContainerDirectory(String batchContainerDirectory)

The path to the directory in which BatchContainerStep, BatchStepExecutor, and BatchStepTrigger will read and write the step semaphore files.

Parameters:

batchContainerDirectory -

setBatchContainerStopStep

public void setBatchContainerStopStep(Step batchContainerStopStep)

The Step which indicates to the Batch Container to shut itself down.

Parameters:

batchContainerStopStep -

getBatchContainerStopStep

public Step getBatchContainerStopStep()

Returns:

the batchContainerStopStep