org.apache.gobblin.util.filesystem

Class PathAlterationObserverScheduler

java.lang.Object

org.apache.gobblin.util.filesystem.PathAlterationObserverScheduler

All Implemented Interfaces:

Runnable

public final class PathAlterationObserverScheduler
extends Object
implements Runnable

A runnable that spawns a monitoring thread triggering any registered PathAlterationObserver at a specified interval. Based on FileAlterationMonitor, implemented monitoring thread to periodically check the monitored file in thread pool.

Constructor Summary

Constructors

Constructor and Description
PathAlterationObserverScheduler()
PathAlterationObserverScheduler(long interval)

Method Summary

Modifier and Type	Method and Description
void	addObserver(PathAlterationObserver observer) Add a file system observer to this monitor.
void	addPathAlterationObserver(PathAlterationListener listener, com.google.common.base.Optional<PathAlterationObserver> observerOptional, org.apache.hadoop.fs.Path rootDirPath) Create and attach PathAlterationObserverSchedulers for the given root directory and any nested subdirectories under the root directory to the given PathAlterationObserverScheduler.
Iterable<PathAlterationObserver>	getObservers() Returns the set of PathAlterationObserver registered with this monitor.
void	removeObserver(PathAlterationObserver observer) Remove a file system observer from this monitor.
void	run()
void	start() Start monitoring.
void	stop() Stop monitoring
void	stop(long stopInterval) Stop monitoring

Methods inherited from class java.lang.Object

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

Constructor Detail

PathAlterationObserverScheduler

public PathAlterationObserverScheduler()

PathAlterationObserverScheduler

public PathAlterationObserverScheduler(long interval)

Method Detail

addObserver

public void addObserver(PathAlterationObserver observer)

Add a file system observer to this monitor.

Parameters:

observer - The file system observer to add

removeObserver

public void removeObserver(PathAlterationObserver observer)

Remove a file system observer from this monitor.

Parameters:

observer - The file system observer to remove

getObservers

public Iterable<PathAlterationObserver> getObservers()

Returns the set of PathAlterationObserver registered with this monitor.

Returns:

The set of PathAlterationObserver

start

public void start()
           throws IOException

Start monitoring.

Throws:

IOException - if an error occurs initializing the observer

stop

public void stop()
          throws IOException,
                 InterruptedException

Stop monitoring

Throws:

Exception - if an error occurs initializing the observer

IOException

InterruptedException

stop

public void stop(long stopInterval)
          throws IOException,
                 InterruptedException

Stop monitoring

Parameters:

stopInterval - the amount of time in milliseconds to wait for the thread to finish. A value of zero will wait until the thread is finished (see Thread.join(long)).

Throws:

IOException - if an error occurs initializing the observer

InterruptedException

Since:

2.1

run

public void run()

Specified by:

run in interface Runnable

addPathAlterationObserver

public void addPathAlterationObserver(PathAlterationListener listener,
                                      com.google.common.base.Optional<PathAlterationObserver> observerOptional,
                                      org.apache.hadoop.fs.Path rootDirPath)
                               throws IOException

Create and attach PathAlterationObserverSchedulers for the given root directory and any nested subdirectories under the root directory to the given PathAlterationObserverScheduler.

Parameters:

detector - a PathAlterationObserverScheduler

listener - a PathAlterationListener

observerOptional - Optional observer object. For testing routine, this has been initialized by user. But for general usage, the observer object is created inside this method.

rootDirPath - root directory

Throws:

IOException