org.eclipse.jetty.util

Class PathWatcher

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.PathWatcher

All Implemented Interfaces:

Runnable, LifeCycle

public class PathWatcher
extends AbstractLifeCycle
implements Runnable

Watch a Path (and sub directories) for Path changes.

Suitable replacement for the old Scanner implementation.

Allows for configured Excludes and Includes using FileSystem.getPathMatcher(String) syntax.

Reports activity via registered PathWatcher.Listeners

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathWatcher.Config
static class	PathWatcher.DirAction
static interface	PathWatcher.EventListListener EventListListener Listener that reports accumulated events in one shot
static interface	PathWatcher.Listener Listener for path change events
static class	PathWatcher.PathMatcherSet
class	PathWatcher.PathWatchEvent PathWatchEvent Represents a file event.
static class	PathWatcher.PathWatchEventType PathWatchEventType Type of an event

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
PathWatcher() Construct new PathWatcher

Method Summary

Modifier and Type	Method and Description
void	addListener(EventListener listener) Add a listener for changes the watcher notices.
Collection<PathWatcher.Config>	getConfigs()
Iterator<EventListener>	getListeners() Get an iterator over the listeners.
long	getUpdateQuietTimeMillis() Change the quiet time.
void	handleWatchEvent(Path path, PathWatcher.PathWatchEvent event) Add an event reported by the WatchService to list of pending events that will be sent after their quiet time has expired.
boolean	isNotifyExistingOnStart()
boolean	removeListener(PathWatcher.Listener listener) Delete a listener
void	reset() Remove all current configs and listeners.
void	run() Forever loop.
void	setNotifyExistingOnStart(boolean notify) Whether or not to issue notifications for directories and files that already exist when the watcher starts.
void	setUpdateQuietTime(long duration, TimeUnit unit) Set the quiet time.
String	toString()
void	watch(Path file) Request watch on a the given path (either file or dir) using all Config defaults.
void	watch(PathWatcher.Config config) Request watch on a path with custom Config provided.

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, setStopTimeout, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Constructor Detail

PathWatcher

public PathWatcher()

Construct new PathWatcher

Method Detail

getConfigs

public Collection<PathWatcher.Config> getConfigs()

watch

public void watch(Path file)

Request watch on a the given path (either file or dir) using all Config defaults. In the case of a dir, the default is not to recurse into subdirs for watching.

Parameters:

file - the path to watch

watch

public void watch(PathWatcher.Config config)

Request watch on a path with custom Config provided.

Parameters:

config - the configuration to watch

addListener

public void addListener(EventListener listener)

Add a listener for changes the watcher notices.

Parameters:

listener - change listener

reset

public void reset()

Remove all current configs and listeners.

getListeners

public Iterator<EventListener> getListeners()

Get an iterator over the listeners.

Returns:

iterator over the listeners.

getUpdateQuietTimeMillis

public long getUpdateQuietTimeMillis()

Change the quiet time.

Returns:

the quiet time in millis

removeListener

public boolean removeListener(PathWatcher.Listener listener)

Delete a listener

Parameters:

listener - the listener to remove

Returns:

true if the listener existed and was removed

run

public void run()

Forever loop. Wait for the WatchService to report some filesystem events for the watched paths. When an event for a path first occurs, it is subjected to a quiet time. Subsequent events that arrive for the same path during this quiet time are accumulated and the timer reset. Only when the quiet time has expired are the accumulated events sent. MODIFY events are handled slightly differently - multiple MODIFY events arriving within a quiet time are coalesced into a single MODIFY event. Both the accumulation of events and coalescing of MODIFY events reduce the number and frequency of event reporting for "noisy" files (ie those that are undergoing rapid change).

Specified by:

run in interface Runnable

See Also:

Runnable.run()

handleWatchEvent

public void handleWatchEvent(Path path,
                             PathWatcher.PathWatchEvent event)

Add an event reported by the WatchService to list of pending events that will be sent after their quiet time has expired.

Parameters:

path - the path to add to the pending list

event - the pending event

setNotifyExistingOnStart

public void setNotifyExistingOnStart(boolean notify)

Whether or not to issue notifications for directories and files that already exist when the watcher starts.

Parameters:

notify - true if existing paths should be notified or not

isNotifyExistingOnStart

public boolean isNotifyExistingOnStart()

setUpdateQuietTime

public void setUpdateQuietTime(long duration,
                               TimeUnit unit)

Set the quiet time.

Parameters:

duration - the quiet time duration

unit - the quite time unit

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle