net.roboconf.dm.templating.internal.templates

Class TemplateWatcher

java.lang.Object

org.apache.commons.io.monitor.FileAlterationListenerAdaptor

net.roboconf.dm.templating.internal.templates.TemplateWatcher

All Implemented Interfaces:

org.apache.commons.io.monitor.FileAlterationListener

public class TemplateWatcher
extends org.apache.commons.io.monitor.FileAlterationListenerAdaptor

A file system watcher dedicated to the Roboconf application templates.

Author:

Pierre Bourret - Université Joseph Fourier

Constructor Summary

Constructors

Constructor and Description
TemplateWatcher(TemplatingManager manager, File templateDir, long pollInterval) Constructor.

Method Summary

Modifier and Type	Method and Description
TemplateEntry	compileTemplate(File templateFile) Compiles the given template file and create the associated template entry.
Collection<TemplateEntry>	findTemplatesForApplication(String appName) Finds the templates that can apply to a given application.
void	onFileChange(File file)
void	onFileCreate(File file)
void	onFileDelete(File file)
void	onStart(org.apache.commons.io.monitor.FileAlterationObserver observer)
void	start() Starts this template watcher.
void	stop() Stops this template watcher.

Methods inherited from class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

onDirectoryChange, onDirectoryCreate, onDirectoryDelete, onStop

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateWatcher

public TemplateWatcher(TemplatingManager manager,
                       File templateDir,
                       long pollInterval)

Constructor.

Parameters:

manager - the templating manager, to which event handling is delegated.

templateDir - the templates directory to watch.

pollInterval - the poll interval.

Throws:

IOException - if there is a problem watching the template directory.

Method Detail

start

public void start()

Starts this template watcher. GuardedBy this.manager.globalLock.writeLock()

stop

public void stop()

Stops this template watcher. GuardedBy this.manager.globalLock.writeLock()

findTemplatesForApplication

public Collection<TemplateEntry> findTemplatesForApplication(String appName)

Finds the templates that can apply to a given application.

The templates contained in the returned set may have been removed at the time they are accessed.

Parameters:

appName - the name of the application, or null to only get the global templates

Returns:

a non-null list

onStart

public void onStart(org.apache.commons.io.monitor.FileAlterationObserver observer)

Specified by:

onStart in interface org.apache.commons.io.monitor.FileAlterationListener

Overrides:

onStart in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

onFileCreate

public void onFileCreate(File file)

Specified by:

onFileCreate in interface org.apache.commons.io.monitor.FileAlterationListener

Overrides:

onFileCreate in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

onFileChange

public void onFileChange(File file)

Specified by:

onFileChange in interface org.apache.commons.io.monitor.FileAlterationListener

Overrides:

onFileChange in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

onFileDelete

public void onFileDelete(File file)

Specified by:

onFileDelete in interface org.apache.commons.io.monitor.FileAlterationListener

Overrides:

onFileDelete in class org.apache.commons.io.monitor.FileAlterationListenerAdaptor

compileTemplate

public TemplateEntry compileTemplate(File templateFile)

Compiles the given template file and create the associated template entry.

IO and compile errors are logged but not rethrown.

Parameters:

templateFile - the template file to compile

Returns:

the created template entry, or null if any problem occurred