org.eclipse.jetty.util

Class Scanner

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.Scanner

All Implemented Interfaces:

LifeCycle

public class Scanner
extends AbstractLifeCycle

Scanner Utility for scanning a directory for added, removed and changed files and reporting these events via registered Listeners.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Scanner.BulkListener
static interface	Scanner.DiscreteListener
static interface	Scanner.Listener Listener Marker for notifications re file changes.
static class	Scanner.Notification
static interface	Scanner.ScanCycleListener Listener that notifies when a scan has started and when it has ended.
static interface	Scanner.ScanListener
(package private) static class	Scanner.TimeNSize

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

AbstractLifeCycle.AbstractLifeCycleListener

Field Summary

Fields

Modifier and Type	Field and Description
private static int	__scannerId
private java.util.Map<java.lang.String,Scanner.TimeNSize>	_currentScan
private java.io.FilenameFilter	_filter
private java.util.List<Scanner.Listener>	_listeners
private java.util.Map<java.lang.String,Scanner.Notification>	_notifications
private java.util.Map<java.lang.String,Scanner.TimeNSize>	_prevScan
private boolean	_reportDirs
private boolean	_reportExisting
private boolean	_running
private int	_scanCount
private int	_scanDepth
private java.util.List<java.io.File>	_scanDirs
private int	_scanInterval
private java.util.TimerTask	_task
private java.util.Timer	_timer
private static Logger	LOG

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

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
Scanner()

Method Summary

Modifier and Type	Method and Description
void	addListener(Scanner.Listener listener) Add an added/removed/changed listener
void	addScanDir(java.io.File dir)
void	doStart() Start the scanning action.
void	doStop() Stop the scanning.
boolean	exists(java.lang.String path)
java.io.FilenameFilter	getFilenameFilter() Get any filter applied to files in the scan dir.
boolean	getRecursive()
boolean	getReportDirs()
boolean	getReportExistingFilesOnStartup()
int	getScanDepth() Get the scanDepth.
java.util.List<java.io.File>	getScanDirs()
int	getScanInterval() Get the scan interval
java.util.Timer	newTimer()
java.util.TimerTask	newTimerTask()
void	removeListener(Scanner.Listener listener) Remove a registered listener
private void	reportAddition(java.lang.String filename) Report a file addition to the registered FileAddedListeners
private void	reportBulkChanges(java.util.List<java.lang.String> filenames)
private void	reportChange(java.lang.String filename) Report a file change to the FileChangedListeners
void	reportDifferences(java.util.Map<java.lang.String,Scanner.TimeNSize> currentScan, java.util.Map<java.lang.String,Scanner.TimeNSize> oldScan) Report the adds/changes/removes to the registered listeners
private void	reportRemoval(java.lang.String filename) Report a file removal to the FileRemovedListeners
private void	reportScanEnd(int cycle) sign
private void	reportScanStart(int cycle) signal any scan cycle listeners that a scan has started
void	scan() Perform a pass of the scanner and report changes
private void	scanFile(java.io.File f, java.util.Map<java.lang.String,Scanner.TimeNSize> scanInfoMap, int depth) Get last modified time on a single file or recurse if the file is a directory.
void	scanFiles() Recursively scan all files in the designated directories.
void	schedule()
void	setFilenameFilter(java.io.FilenameFilter filter) Apply a filter to files found in the scan directory.
void	setRecursive(boolean recursive)
void	setReportDirs(boolean dirs) Set if found directories should be reported.
void	setReportExistingFilesOnStartup(boolean reportExisting) Whether or not an initial scan will report all files as being added.
void	setScanDepth(int scanDepth) Set the scanDepth.
void	setScanDirs(java.util.List<java.io.File> dirs)
void	setScanInterval(int scanInterval) Set the scan interval
private void	warn(java.lang.Object listener, java.lang.String filename, java.lang.Throwable th)

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, toString, wait, wait, wait

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

start, stop

Field Detail

LOG

private static final Logger LOG

__scannerId

private static int __scannerId

_scanInterval

private int _scanInterval

_scanCount

private int _scanCount

_listeners

private final java.util.List<Scanner.Listener> _listeners

_prevScan

private final java.util.Map<java.lang.String,Scanner.TimeNSize> _prevScan

_currentScan

private final java.util.Map<java.lang.String,Scanner.TimeNSize> _currentScan

_filter

private java.io.FilenameFilter _filter

_scanDirs

private final java.util.List<java.io.File> _scanDirs

_running

private volatile boolean _running

_reportExisting

private boolean _reportExisting

_reportDirs

private boolean _reportDirs

_timer

private java.util.Timer _timer

_task

private java.util.TimerTask _task

_scanDepth

private int _scanDepth

_notifications

private final java.util.Map<java.lang.String,Scanner.Notification> _notifications

Constructor Detail

Scanner

public Scanner()

Method Detail

getScanInterval

public int getScanInterval()

Get the scan interval

Returns:

interval between scans in seconds

setScanInterval

public void setScanInterval(int scanInterval)

Set the scan interval

Parameters:

scanInterval - pause between scans in seconds, or 0 for no scan after the initial scan.

setScanDirs

public void setScanDirs(java.util.List<java.io.File> dirs)

addScanDir

public void addScanDir(java.io.File dir)

getScanDirs

public java.util.List<java.io.File> getScanDirs()

setRecursive

public void setRecursive(boolean recursive)

Parameters:

recursive - True if scanning is recursive

See Also:

setScanDepth(int)

getRecursive

public boolean getRecursive()

Returns:

True if scanning is fully recursive (scandepth==-1)

See Also:

getScanDepth()

getScanDepth

public int getScanDepth()

Get the scanDepth.

Returns:

the scanDepth

setScanDepth

public void setScanDepth(int scanDepth)

Set the scanDepth.

Parameters:

scanDepth - the scanDepth to set

setFilenameFilter

public void setFilenameFilter(java.io.FilenameFilter filter)

Apply a filter to files found in the scan directory. Only files matching the filter will be reported as added/changed/removed.

Parameters:

filter - the filename filter to use

getFilenameFilter

public java.io.FilenameFilter getFilenameFilter()

Get any filter applied to files in the scan dir.

Returns:

the filename filter

setReportExistingFilesOnStartup

public void setReportExistingFilesOnStartup(boolean reportExisting)

Whether or not an initial scan will report all files as being added.

Parameters:

reportExisting - if true, all files found on initial scan will be reported as being added, otherwise not

getReportExistingFilesOnStartup

public boolean getReportExistingFilesOnStartup()

setReportDirs

public void setReportDirs(boolean dirs)

Set if found directories should be reported.

Parameters:

dirs - true to report directory changes as well

getReportDirs

public boolean getReportDirs()

addListener

public void addListener(Scanner.Listener listener)

Add an added/removed/changed listener

Parameters:

listener - the listener to add

removeListener

public void removeListener(Scanner.Listener listener)

Remove a registered listener

Parameters:

listener - the Listener to be removed

doStart

public void doStart()

Start the scanning action.

Overrides:

doStart in class AbstractLifeCycle

newTimerTask

public java.util.TimerTask newTimerTask()

newTimer

public java.util.Timer newTimer()

schedule

public void schedule()

doStop

public void doStop()

Stop the scanning.

Overrides:

doStop in class AbstractLifeCycle

exists

public boolean exists(java.lang.String path)

Parameters:

path - tests if the path exists

Returns:

true if the path exists in one of the scandirs

scan

public void scan()

Perform a pass of the scanner and report changes

scanFiles

public void scanFiles()

Recursively scan all files in the designated directories.

reportDifferences

public void reportDifferences(java.util.Map<java.lang.String,Scanner.TimeNSize> currentScan,
                              java.util.Map<java.lang.String,Scanner.TimeNSize> oldScan)

Report the adds/changes/removes to the registered listeners

Parameters:

currentScan - the info from the most recent pass

oldScan - info from the previous pass

scanFile

private void scanFile(java.io.File f,
                      java.util.Map<java.lang.String,Scanner.TimeNSize> scanInfoMap,
                      int depth)

Get last modified time on a single file or recurse if the file is a directory.

Parameters:

f - file or directory

scanInfoMap - map of filenames to last modified times

warn

private void warn(java.lang.Object listener,
                  java.lang.String filename,
                  java.lang.Throwable th)

reportAddition

private void reportAddition(java.lang.String filename)

Report a file addition to the registered FileAddedListeners

Parameters:

filename - the filename

reportRemoval

private void reportRemoval(java.lang.String filename)

Report a file removal to the FileRemovedListeners

Parameters:

filename - the filename

reportChange

private void reportChange(java.lang.String filename)

Report a file change to the FileChangedListeners

Parameters:

filename - the filename

reportBulkChanges

private void reportBulkChanges(java.util.List<java.lang.String> filenames)

reportScanStart

private void reportScanStart(int cycle)

signal any scan cycle listeners that a scan has started

reportScanEnd

private void reportScanEnd(int cycle)

sign