A file alteration monitor based on a home made file system scan and watching files matching a set of includes patterns. These patterns are Ant patterns (can use **, * or ?). This class takes 2 Handler as parameter and orchestrate the redeployment method when a matching file is modified (created, updated or deleted). Users have the possibility to execute a shell command during the redeployment. On a file change, the undeploy Handler is called, followed by the execution of the user command. Then the deploy Handler is invoked.

The watcher watches all files from the current directory and sub-directories.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Watcher.FileInfo

Field Summary

Modifier and Type	Field and Description
private volatile boolean	closed
private final String	cmd
private final File	cwd
private final Handler<Handler<Void>>	deploy
private final Map<File, Map<File, Watcher.FileInfo>>	fileMap
private final Set<File>	filesToWatch
private final long	gracePeriod
private final List<String>	includes
private long	lastChange This field is always access from the scan thread.
private static final Logger	LOGGER
private final List<File>	roots
private final long	scanPeriod
private final Handler<Handler<Void>>	undeploy

Constructor Summary

Access Constructor and Description

Access	Constructor and Description
public	Watcher(File the root directory root, List<String> the list of include patterns, should not be `null` or empty includes, Handler<Handler<Void>> the function called when deployment is required deploy, Handler<Handler<Void>> the function called when un-deployment is required undeploy, String an optional command executed after the un-deployment and before the deployment onRedeployCommand, long the amount of time in milliseconds to wait between two redeploy even if there are changes gracePeriod, long the time in millisecond between 2 file system scans scanPeriod) Creates a new `Watcher`.

public

Watcher(File

the root directory

root, List<String>

the list of include patterns, should not be null or empty

includes, Handler<Handler<Void>>

the function called when deployment is required

deploy, Handler<Handler<Void>>

the function called when un-deployment is required

undeploy, String

an optional command executed after the un-deployment and before the deployment

onRedeployCommand, long

the amount of time in milliseconds to wait between two redeploy even if there are changes

gracePeriod, long

the time in millisecond between 2 file system scans

scanPeriod)

Creates a new Watcher.

Method Summary

Modifier and Type	Method and Description
private void	addFilesToWatchedList(List<File> roots)
private void	addFileToWatchedList(File file)
private boolean	Returns: `true` if a change occurred requiring the redeployment. changesHaveOccurred() Checks whether or not a change has occurred in one of the watched file that match one of the given include pattern .
public void	close() Stops watching.
private void	executeUserCommand(Handler<Void> onCompletion)
pack-priv static List<File>	extractRoots(File root, List<String> includes)
protected boolean	Returns: `true` if the file matches at least one pattern, `false` otherwise. match(File the file file) Checks whether the given file matches one of the `includes` patterns.
public void	run() Implements java.lang.Runnable.run. The watching thread runnable method.
private List<String>	sanitizeIncludePatterns(List<String> includes)
private void	trigger() Redeployment process.
public Watcher	Returns: the current watcher. watch() Starts watching.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

closed	back to summary
private volatile boolean closed

cmd	back to summary
private final String cmd

cwd	back to summary
private final File cwd

deploy	back to summary
private final Handler<Handler<Void>> deploy

fileMap	back to summary
private final Map<File, Map<File, Watcher.FileInfo>> fileMap

filesToWatch	back to summary
private final Set<File> filesToWatch

gracePeriod	back to summary
private final long gracePeriod

includes	back to summary
private final List<String> includes

lastChange	back to summary
private long lastChange This field is always access from the scan thread. No need to be volatile.

LOGGER	back to summary
private static final Logger LOGGER

roots	back to summary
private final List<File> roots

scanPeriod	back to summary
private final long scanPeriod

undeploy	back to summary
private final Handler<Handler<Void>> undeploy

Constructor Detail

Watcher back to summary

Watcher	back to summary
public Watcher(File root, List<String> includes, Handler<Handler<Void>> deploy, Handler<Handler<Void>> undeploy, String onRedeployCommand, long gracePeriod, long scanPeriod) Creates a new `Watcher`. Parameters root:File the root directory includes:List<String> the list of include patterns, should not be `null` or empty deploy:Handler<Handler<Void>> the function called when deployment is required undeploy:Handler<Handler<Void>> the function called when un-deployment is required onRedeployCommand:String an optional command executed after the un-deployment and before the deployment gracePeriod:long the amount of time in milliseconds to wait between two redeploy even if there are changes scanPeriod:long the time in millisecond between 2 file system scans

public Watcher(File root, List<String> includes, Handler<Handler<Void>> deploy, Handler<Handler<Void>> undeploy, String onRedeployCommand, long gracePeriod, long scanPeriod)

Creates a new Watcher.

Parameters

root:File: the root directory
includes:List<String>: the list of include patterns, should not be null or empty
deploy:Handler<Handler<Void>>: the function called when deployment is required
undeploy:Handler<Handler<Void>>: the function called when un-deployment is required
onRedeployCommand:String: an optional command executed after the un-deployment and before the deployment
gracePeriod:long: the amount of time in milliseconds to wait between two redeploy even if there are changes
scanPeriod:long: the time in millisecond between 2 file system scans

Method Detail

addFilesToWatchedList	back to summary
private void addFilesToWatchedList(List<File> roots)

addFileToWatchedList	back to summary
private void addFileToWatchedList(File file)

changesHaveOccurred back to summary

changesHaveOccurred	back to summary
private boolean changesHaveOccurred() Checks whether or not a change has occurred in one of the watched file that match one of the given include pattern . Are detected: new files, modified file and deleted files. File modification is detected using `File#lastModified()`, so the behavior depends on the file system precision. Returns:boolean `true` if a change occurred requiring the redeployment.

private boolean changesHaveOccurred()

Checks whether or not a change has occurred in one of the watched file that match one of the given include pattern . Are detected: new files, modified file and deleted files. File modification is detected using File#lastModified(), so the behavior depends on the file system precision.

Returns:boolean: true if a change occurred requiring the redeployment.

close	back to summary
public void close() Stops watching. This method stops the underlying `WatchService`.

executeUserCommand	back to summary
private void executeUserCommand(Handler<Void> onCompletion)

extractRoots	back to summary
pack-priv static List<File> extractRoots(File root, List<String> includes)

match back to summary

match	back to summary
protected boolean match(File file) Checks whether the given file matches one of the `includes` patterns. Parameters file:File the file Returns:boolean `true` if the file matches at least one pattern, `false` otherwise.

protected boolean match(File file)

Checks whether the given file matches one of the includes patterns.

Parameters

file:File: the file

Returns:boolean

true if the file matches at least one pattern, false otherwise.

run	back to summary
public void run() Implements java.lang.Runnable.run. The watching thread runnable method. Annotations @Override

run

back to summary

public void run()

Implements java.lang.Runnable.run.

The watching thread runnable method.

Annotations

@Override

sanitizeIncludePatterns	back to summary
private List<String> sanitizeIncludePatterns(List<String> includes)

trigger	back to summary
private void trigger() Redeployment process.

watch	back to summary
public Watcher watch() Starts watching. The watch processing is made in another thread started in this method. Returns:Watcher the current watcher.

watch

back to summary

public Watcher watch()

Starts watching. The watch processing is made in another thread started in this method.

Returns:Watcher: the current watcher.

io.vertx.core.impl.launcher.commands back to summary

private final Class Watcher.FileInfo

Class Inheritance

extends Object

java.lang.Object
io.vertx.core.impl.launcher.commands.Watcher.FileInfo

Field Summary

Modifier and Type	Field and Description
pack-priv long	lastModified
pack-priv long	length

Constructor Summary

Access	Constructor and Description
private	FileInfo(long lastModified, long length)

Method Summary

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

lastModified	back to summary
pack-priv long lastModified

length	back to summary
pack-priv long length

Constructor Detail

FileInfo	back to summary
private FileInfo(long lastModified, long length)

public Class Watcher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class Watcher.FileInfo

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail