org.jahia.tools.files

Class FileWatcher

java.lang.Object

java.util.Observable

org.jahia.tools.files.FileWatcher

All Implemented Interfaces:

Serializable

public class FileWatcher
extends Observable
implements Serializable

An Observer/Observable Implementation of a Deamon Thread that looks at any new File created in a given Folder. New files are checked by their last modification date. Build a list of files and pass it to any Registered Observer.

 Works in two modes : mode = ALL           -> returns all files in the folder.
                      mode = CHECK_DATE    -> returns only new files.
 

Version:

1.0

Author:

Khue ng

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	mCheckDate Check files by their last modification date status or not

Constructor Summary

Constructors

Constructor and Description
FileWatcher(String fullFolderPath, boolean checkDate, long interval, boolean fileOnly, boolean isDeamon, SchedulerService schedulerService) Constructor Precise if the Thread to Create is a Deamon or not
FileWatcher(String fullFolderPath, boolean checkDate, long interval, boolean fileOnly, SchedulerService schedulerService) Constructor
FileWatcher(String jobName, String fullFolderPath, boolean checkDate, long interval, boolean fileOnly) Constructor
FileWatcher(String jobName, String fullFolderPath, boolean checkDate, long interval, boolean fileOnly, boolean isDeamon, SchedulerService schedulerService) Constructor Precise if the Thread to Create is a Deamon or not

Method Summary

Modifier and Type	Method and Description
void	externalSetChanged() Small trick to export the setChanged method that has a protected.
boolean	getCheckDate() Returns The Check File Mode
boolean	getFileOnly()
File	getFolder()
String	getFolderPath() Returns The Path of the Folder to watch
org.apache.commons.io.filefilter.IOFileFilter	getIgnoreFilter()
long	getInterval() Returns The Interval Values
long	getLastCheckTime()
int	getMaxJobNameLength()
Collection<File>	getPreviousFiles()
boolean	getRemovedFiles()
protected void	initialize() Verify if the Folder to watch exists.
boolean	isDeamon() Thread is a Deamon or not
boolean	isRecursive()
void	setCheckDate(boolean checkDate) Set The Check File Mode ( by last modification date or returns all files found
protected void	setDeamon(boolean isDeamon) Create a Deamon or User Thread
void	setFileOnly(boolean fileOnly) set file only mode
protected void	setFolderPath(String fullFolderPath) Set The FolderPath
void	setIgnoreFiles(List<String> ignoreFiles)
protected void	setInterval(long interval) Set The Interval Values
void	setLastCheckTime(long lastCheckTime)
void	setMaxJobNameLength(int maxJobNameLength)
void	setPreviousFiles(Collection<File> previousFiles)
void	setRecursive(boolean recursive)
void	setRemovedFiles(boolean removedFiles)
void	start() Creates the Timer Thread and starts it
void	stop()

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

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

Field Detail

mCheckDate

public boolean mCheckDate

Check files by their last modification date status or not

Constructor Detail

FileWatcher

public FileWatcher(String jobName,
                   String fullFolderPath,
                   boolean checkDate,
                   long interval,
                   boolean fileOnly)
            throws IOException

Constructor

Parameters:

jobName - the name of the background job to use

fullFolderPath - the real Path to the folder to watch

checkDate - check by last modification date or not

interval - the interval to do the repeat Task

fileOnly - checks only files if true, not directories

Throws:

IOException

FileWatcher

public FileWatcher(String fullFolderPath,
                   boolean checkDate,
                   long interval,
                   boolean fileOnly,
                   SchedulerService schedulerService)
            throws IOException

Constructor

Parameters:

fullFolderPath - the real Path to the folder to watch

checkDate - check by last modification date or not

interval - the interval to do the repeat Task

fileOnly - checks only files if true, not directories

Throws:

IOException

FileWatcher

public FileWatcher(String fullFolderPath,
                   boolean checkDate,
                   long interval,
                   boolean fileOnly,
                   boolean isDeamon,
                   SchedulerService schedulerService)
            throws IOException

Constructor Precise if the Thread to Create is a Deamon or not

Parameters:

fullFolderPath - the real Path to the folder to watch

checkDate - check new files by date changes ?

interval - the interval to do the repeat Task

isDeamon - create a User or Deamon Thread

fileOnly - checks only files if true, not directories

schedulerService - a dependency injection of the service to use to schedule the file watching job.

Throws:

IOException

FileWatcher

public FileWatcher(String jobName,
                   String fullFolderPath,
                   boolean checkDate,
                   long interval,
                   boolean fileOnly,
                   boolean isDeamon,
                   SchedulerService schedulerService)
            throws IOException

Constructor Precise if the Thread to Create is a Deamon or not

Parameters:

jobName - the name of the background job to use

fullFolderPath - the real Path to the folder to watch

checkDate - check new files by date changes ?

interval - the interval to do the repeat Task

isDeamon - create a User or Deamon Thread

fileOnly - checks only files if true, not directories

schedulerService - a dependency injection of the service to use to schedule the file watching job.

Throws:

IOException

Method Detail

start

public void start()
           throws IOException

Creates the Timer Thread and starts it

Throws:

IOException

stop

public void stop()

getInterval

public long getInterval()

Returns The Interval Values

Returns:

(long) the interval

setInterval

protected void setInterval(long interval)

Set The Interval Values

Parameters:

interval - the interval used to do repeatitive task in millis

externalSetChanged

public void externalSetChanged()

Small trick to export the setChanged method that has a protected. This is necessary for compilation with Ant...

getFolderPath

public String getFolderPath()

Returns The Path of the Folder to watch

Returns:

(String) the path to the folder to watch

setFolderPath

protected void setFolderPath(String fullFolderPath)

Set The FolderPath

Parameters:

fullFolderPath - the path to the folder to watch

setFileOnly

public void setFileOnly(boolean fileOnly)

set file only mode

Parameters:

fileOnly - file only or not

getFileOnly

public boolean getFileOnly()

isRecursive

public boolean isRecursive()

setRecursive

public void setRecursive(boolean recursive)

getCheckDate

public boolean getCheckDate()

Returns The Check File Mode

Returns:

(boolean) if check new file by controlling the last modification date

setCheckDate

public void setCheckDate(boolean checkDate)

Set The Check File Mode ( by last modification date or returns all files found

Parameters:

checkDate - check by last modification date or not

isDeamon

public boolean isDeamon()

Thread is a Deamon or not

Returns:

(boolean) true if is Deamon Thread

setDeamon

protected void setDeamon(boolean isDeamon)

Create a Deamon or User Thread

Parameters:

isDeamon -

getFolder

public File getFolder()

getLastCheckTime

public long getLastCheckTime()

setLastCheckTime

public void setLastCheckTime(long lastCheckTime)

getMaxJobNameLength

public int getMaxJobNameLength()

setMaxJobNameLength

public void setMaxJobNameLength(int maxJobNameLength)

getRemovedFiles

public boolean getRemovedFiles()

setRemovedFiles

public void setRemovedFiles(boolean removedFiles)

getPreviousFiles

public Collection<File> getPreviousFiles()

setPreviousFiles

public void setPreviousFiles(Collection<File> previousFiles)

setIgnoreFiles

public void setIgnoreFiles(List<String> ignoreFiles)

getIgnoreFilter

public org.apache.commons.io.filefilter.IOFileFilter getIgnoreFilter()

initialize

protected void initialize()
                   throws IOException

Verify if the Folder to watch exists. Create the Archive Folder if not exist.

Throws:

IOException