com.nt.udc.ndk.util

Class FileRetentionThread

java.lang.Object

java.lang.Thread

com.nt.udc.ndk.util.FileRetentionThread

All Implemented Interfaces:

java.lang.Runnable

public class FileRetentionThread
extends java.lang.Thread

FileRetetentionThread is responsible for moving/deleting older files from DC output directory to archive directory after retention period. This thread will be used only if File Retention is enabled in Node GUI. This thread starts running when node starts and ends when node ends. This thread checks at every hour starting for the older files in the output folder. If files found, it moves/deletes them based on the file retention action configured in the Node GUI.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

java.lang.Thread.State, java.lang.Thread.UncaughtExceptionHandler

Field Summary

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FileRetentionThread(int retentionDays, java.lang.String fileRetentionAction, java.lang.String archiveFolder, java.lang.String fileExtension, java.lang.String dcOutputFolder, LoggerIfc logger) The constructor used initialize the parameters required for File Retention thread.
FileRetentionThread(int retentionDays, java.lang.String fileRetentionAction, java.lang.String archiveFolder, java.lang.String fileExtension, java.lang.String dcOutputFolder, LoggerIfc logger, java.lang.String prefix) constructor with prefix parameter.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doRetentionAction() This method scans the directory containing the completed files and deletes/moves them.
void	run()
void	shutdown()

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRetentionThread

public FileRetentionThread(int retentionDays,
                   java.lang.String fileRetentionAction,
                   java.lang.String archiveFolder,
                   java.lang.String fileExtension,
                   java.lang.String dcOutputFolder,
                   LoggerIfc logger,
                   java.lang.String prefix)
                    throws NodeStartException

constructor with prefix parameter.

Parameters:

retentionDays - number of days the files to retain in the output folder

fileRetentionAction - what to do on the older files after retention days

archiveFolder - the folder to which the files will be moved if archive action is selected

fileExtension - the file extension used filtering completed files.

dcOutputFolder - the folder from which the files need to be moved/deleted

logger - exception will be logged in this logger

prefix - the prefix of completed files.

Throws:

NodeStartException - will be throws if archive folder doesn't exists and not creatable.

FileRetentionThread

public FileRetentionThread(int retentionDays,
                   java.lang.String fileRetentionAction,
                   java.lang.String archiveFolder,
                   java.lang.String fileExtension,
                   java.lang.String dcOutputFolder,
                   LoggerIfc logger)
                    throws NodeStartException

The constructor used initialize the parameters required for File Retention thread.

Parameters:

retentionDays - number of days the files to retain in the output folder

fileRetentionAction - what to do on the older files after retention days

archiveFolder - the folder to which the files will be moved if archive action is selected

fileExtension - the file extension used filtering completed files.

dcOutputFolder - the folder from which the files need to be moved/deleted

logger - exception will be logged in this logger

Throws:

NodeStartException - will be throws if archive folder doesn't exists and not creatable.

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

Overrides:

run in class java.lang.Thread

shutdown

public void shutdown()

doRetentionAction

protected void doRetentionAction()
                          throws java.lang.Exception

This method scans the directory containing the completed files and deletes/moves them.

Throws:

java.lang.Exception - if an error occurs during scan of directory.