info.magnolia.dirwatch

Class DirectoryWatcherService

java.lang.Object

info.magnolia.dirwatch.DirectoryWatcherService

@Singleton
public class DirectoryWatcherService
extends Object

Service to watch for added and removed files and especially for file changes.

This creates a DirectoryWatcher, i.e. our low-level implementation of Java's WatchService API. This watcher is then only started (submitted for execution) upon first request to register a directory.

Constructor Summary

Constructors

Constructor and Description
DirectoryWatcherService() Deprecated. Since 5.4.5, Please use DirectoryWatcherService(MagnoliaConfigurationProperties) instead.
DirectoryWatcherService(info.magnolia.init.MagnoliaConfigurationProperties properties)

Method Summary

Modifier and Type	Method and Description
void	register(Path path, com.google.common.base.Predicate<Path> filterPredicate, WatcherCallback callback) Registers a directory to the DirectoryWatcher, with given filtering predicate and callback.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectoryWatcherService

public DirectoryWatcherService(info.magnolia.init.MagnoliaConfigurationProperties properties)
                        throws IOException

Throws:

IOException

DirectoryWatcherService

@Deprecated
public DirectoryWatcherService()
                                    throws IOException

Deprecated. Since 5.4.5, Please use DirectoryWatcherService(MagnoliaConfigurationProperties) instead.

Throws:

IOException

Method Detail

start

public void start()

register

public void register(Path path,
                     com.google.common.base.Predicate<Path> filterPredicate,
                     WatcherCallback callback)
              throws IOException

Registers a directory to the DirectoryWatcher, with given filtering predicate and callback.

Throws:

IOException

stop

public void stop()