org.kuali.ole.sys.batch

Class FilePurgeStep

java.lang.Object

org.kuali.ole.sys.batch.InitiateDirectoryBase

org.kuali.ole.sys.batch.AbstractStep

org.kuali.ole.sys.batch.FilePurgeStep

All Implemented Interfaces:

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

public class FilePurgeStep
extends AbstractStep

Purges old files from the reports directory specified in build.properties

Field Summary

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

batchInputFileType, dateTimeService, interrupted, name, parameterService

Constructor Summary

Constructors

Constructor and Description
FilePurgeStep()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(String jobName, Date jobRunDate) Deletes all files in the temporary directory that are over 1 day old
List<FilePurgeCustomAge>	getCustomAges() Gets the customAges attribute.
List<String>	getDirectories() Gets the directories attribute.
FilePurgeService	getFilePurgeService() Gets the filePurgeService attribute.
List<String>	getRequiredDirectoryNames() By default it should use batchInpeutFile (single file) directory path as the required directory name.
void	setCustomAges(List<FilePurgeCustomAge> customAge) Sets the customAges attribute value.
void	setDirectories(List<String> directories) Sets the directories attribute value.
void	setFilePurgeService(FilePurgeService filePurgeService) Sets the filePurgeService attribute value.

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

afterPropertiesSet, getBatchInputFileType, getDateTimeService, getName, getParameterService, 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

Constructor Detail

FilePurgeStep

public FilePurgeStep()

Method Detail

getRequiredDirectoryNames

public List<String> getRequiredDirectoryNames()

Description copied from class: AbstractStep

By default it should use batchInpeutFile (single file) directory path as the required directory name. Subclasses should override this function to provide any custom required directory list.

Specified by:

getRequiredDirectoryNames in interface InitiateDirectory

Overrides:

getRequiredDirectoryNames in class AbstractStep

Returns:

See Also:

AbstractStep.getRequiredDirectoryNames()

execute

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

Deletes all files in the temporary directory that are over 1 day old

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

See Also:

Step.execute(String, Date)

getDirectories

public List<String> getDirectories()

Gets the directories attribute.

Returns:

Returns the directories.

setDirectories

public void setDirectories(List<String> directories)

Sets the directories attribute value.

Parameters:

directories - The directories to set.

getCustomAges

public List<FilePurgeCustomAge> getCustomAges()

Gets the customAges attribute.

Returns:

Returns the customAges.

setCustomAges

public void setCustomAges(List<FilePurgeCustomAge> customAge)

Sets the customAges attribute value.

Parameters:

customAges - The customAges to set.

getFilePurgeService

public FilePurgeService getFilePurgeService()

Gets the filePurgeService attribute.

Returns:

Returns the filePurgeService.

setFilePurgeService

public void setFilePurgeService(FilePurgeService filePurgeService)

Sets the filePurgeService attribute value.

Parameters:

filePurgeService - The filePurgeService to set.