org.jahia.services.deamons.filewatcher

Class FileMonitor

java.lang.Object

org.jahia.services.deamons.filewatcher.FileMonitor

All Implemented Interfaces:

Serializable

public class FileMonitor
extends Object
implements Serializable

File watcher service implementation that is based on the VFS DefaultFileMonitor.

Author:

Sergiy Shyrkov

See Also:

Commons VFS project, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FileMonitor() Initializes an instance of this class.
FileMonitor(FileMonitorCallback callback)

Method Summary

Modifier and Type	Method and Description
void	addFile(File file) Adds a file to be monitored.
int	getChecksPerRun() get the number of files to check per run.
long	getDelay() Get the delay between runs.
Set<String>	getFilesToIgnore()
protected boolean	isIgnored(File file)
boolean	isRecursive() Access method to get the recursive setting when adding files for monitoring.
protected void	queueAddFile(File file) Queues a file for addition to be monitored.
protected void	queueRemoveFile(File file) Queues a file for removal from being monitored.
void	removeFile(File file) Removes a file from being monitored.
void	run() Asks the agent for each file being monitored to check its file for changes.
void	setChecksPerRun(int checksPerRun) set the number of files to check per run.
void	setDelay(long delay) Set the delay between runs.
void	setFilesToIgnore(Set<String> filesToIgnore)
void	setFilesToIgnore(String... filesToIgnore)
void	setOnlyFiles(boolean onlyFiles)
void	setRecursive(boolean newRecursive) Access method to set the recursive setting when adding files for monitoring.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileMonitor

public FileMonitor()

Initializes an instance of this class.

FileMonitor

public FileMonitor(FileMonitorCallback callback)

Method Detail

addFile

public void addFile(File file)

Adds a file to be monitored.

Parameters:

file - The FileObject to monitor.

getChecksPerRun

public int getChecksPerRun()

get the number of files to check per run.

Returns:

The number of files to check per iteration.

getDelay

public long getDelay()

Get the delay between runs.

Returns:

The delay period.

getFilesToIgnore

public Set<String> getFilesToIgnore()

isIgnored

protected boolean isIgnored(File file)

isRecursive

public boolean isRecursive()

Access method to get the recursive setting when adding files for monitoring.

Returns:

true if monitoring is enabled for children.

queueAddFile

protected void queueAddFile(File file)

Queues a file for addition to be monitored.

Parameters:

file - The FileObject to add.

queueRemoveFile

protected void queueRemoveFile(File file)

Queues a file for removal from being monitored.

Parameters:

file - The File to be removed from being monitored

removeFile

public void removeFile(File file)

Removes a file from being monitored.

Parameters:

file - The File to remove from monitoring

run

public void run()

Asks the agent for each file being monitored to check its file for changes.

setChecksPerRun

public void setChecksPerRun(int checksPerRun)

set the number of files to check per run. a additional delay will be added if there are more files to check

Parameters:

checksPerRun - a value less than 1 will disable this feature

setDelay

public void setDelay(long delay)

Set the delay between runs.

Parameters:

delay - The delay period.

setFilesToIgnore

public void setFilesToIgnore(Set<String> filesToIgnore)

setFilesToIgnore

public void setFilesToIgnore(String... filesToIgnore)

setOnlyFiles

public void setOnlyFiles(boolean onlyFiles)

setRecursive

public void setRecursive(boolean newRecursive)

Access method to set the recursive setting when adding files for monitoring.

Parameters:

newRecursive - true if monitoring should be enabled for children.