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 interface	PathWatcher.Listener Listener for path change events
static class	PathWatcher.PathWatchEvent
static class	PathWatcher.PathWatchEventType

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()

Method Summary

Modifier and Type	Method and Description
void	addDirectoryWatch(PathWatcher.Config baseDir) Add a directory watch configuration to the the PathWatcher.
void	addFileWatch(Path file)
void	addListener(PathWatcher.Listener listener)
protected static <T> WatchEvent<T>	cast(WatchEvent<?> event)
protected void	doStart()
protected void	doStop()
Iterator<PathWatcher.Listener>	getListeners()
long	getUpdateQuietTimeMillis()
protected void	notifyOnPathWatchEvent(PathWatcher.PathWatchEvent event)
protected void	register(Path dir, PathWatcher.Config root)
boolean	removeListener(PathWatcher.Listener listener)
void	run()
void	setUpdateQuietTime(long duration, TimeUnit unit)
String	toString()

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

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

Constructor Detail

PathWatcher

public PathWatcher()
            throws IOException

Throws:

IOException

Method Detail

cast

protected static <T> WatchEvent<T> cast(WatchEvent<?> event)

addDirectoryWatch

public void addDirectoryWatch(PathWatcher.Config baseDir)
                       throws IOException

Add a directory watch configuration to the the PathWatcher.

Parameters:

baseDir - the base directory configuration to watch

Throws:

IOException - if unable to setup the directory watch

addFileWatch

public void addFileWatch(Path file)
                  throws IOException

Throws:

IOException

addListener

public void addListener(PathWatcher.Listener listener)

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class AbstractLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class AbstractLifeCycle

Throws:

Exception

getListeners

public Iterator<PathWatcher.Listener> getListeners()

getUpdateQuietTimeMillis

public long getUpdateQuietTimeMillis()

notifyOnPathWatchEvent

protected void notifyOnPathWatchEvent(PathWatcher.PathWatchEvent event)

register

protected void register(Path dir,
                        PathWatcher.Config root)
                 throws IOException

Throws:

IOException

removeListener

public boolean removeListener(PathWatcher.Listener listener)

run

public void run()

Specified by:

run in interface Runnable

setUpdateQuietTime

public void setUpdateQuietTime(long duration,
                               TimeUnit unit)

toString

public String toString()

Overrides:

toString in class Object