org.springframework.integration.file

Class WatchServiceDirectoryScanner

java.lang.Object

org.springframework.integration.file.DefaultDirectoryScanner

org.springframework.integration.file.WatchServiceDirectoryScanner

All Implemented Interfaces:

org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, DirectoryScanner

Deprecated.

since 4.3 in favor of internal WatchService logic in the FileReadingMessageSource. Will be removed in Spring Integration 5.0.

@Deprecated
 @UsesJava7
public class WatchServiceDirectoryScanner
extends DefaultDirectoryScanner
implements org.springframework.context.SmartLifecycle

Directory scanner that uses Java 7 WatchService. The initial state of the directory is collected during start(). Subsequent polls return new files as reported by ENTRY_CREATE events.

While initially walking the directory, any subdirectories encountered are registered to watch for creation events.

If subdirectories are subsequently added, they are walked and registered for new creation events, too.

When a StandardWatchEventKinds.OVERFLOW WatchKey event is occurred, the directory is rescanned to avoid the loss for any new entries according to the "missed events" logic around StandardWatchEventKinds.OVERFLOW.

Since:

4.2

Author:

Hezi Schrager, Gary Russell, Artem Bilan

Constructor Summary

Constructors

Constructor and Description
WatchServiceDirectoryScanner(String directory) Deprecated. Construct an instance for the given directory.

Method Summary

Modifier and Type	Method and Description
int	getPhase() Deprecated.
boolean	isAutoStartup() Deprecated.
boolean	isRunning() Deprecated.
protected File[]	listEligibleFiles(File directory) Deprecated. Subclasses may refine the listing strategy by overriding this method.
void	setAutoStartup(boolean autoStartup) Deprecated.
void	setPhase(int phase) Deprecated. see getPhase()
void	setRunning(boolean running) Deprecated.
void	start() Deprecated.
void	stop() Deprecated.
void	stop(Runnable callback) Deprecated.

Methods inherited from class org.springframework.integration.file.DefaultDirectoryScanner

getFilter, getLocker, listFiles, setFilter, setLocker, tryClaim

Methods inherited from class java.lang.Object

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

Constructor Detail

WatchServiceDirectoryScanner

public WatchServiceDirectoryScanner(String directory)

Deprecated.

Construct an instance for the given directory.

Parameters:

directory - the directory.

Method Detail

getPhase

public int getPhase()

Deprecated.

Specified by:

getPhase in interface org.springframework.context.Phased

setPhase

public void setPhase(int phase)

Deprecated.

see getPhase()

Parameters:

phase - the phase.

isRunning

public boolean isRunning()

Deprecated.

Specified by:

isRunning in interface org.springframework.context.Lifecycle

setRunning

public void setRunning(boolean running)

Deprecated.

Parameters:

running - true if running.

See Also:

isRunning()

isAutoStartup

public boolean isAutoStartup()

Deprecated.

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

setAutoStartup

public void setAutoStartup(boolean autoStartup)

Deprecated.

Parameters:

autoStartup - true to auto start.

See Also:

isAutoStartup()

start

public void start()

Deprecated.

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Deprecated.

Specified by:

stop in interface org.springframework.context.Lifecycle

stop

public void stop(Runnable callback)

Deprecated.

Specified by:

stop in interface org.springframework.context.SmartLifecycle

listEligibleFiles

protected File[] listEligibleFiles(File directory)

Deprecated.

Description copied from class: DefaultDirectoryScanner

Subclasses may refine the listing strategy by overriding this method. The files returned here are passed onto the filter.

Overrides:

listEligibleFiles in class DefaultDirectoryScanner

Parameters:

directory - root directory to use for listing

Returns:

the files this scanner should consider