Package org.springframework.integration.file.dsl

Class FileInboundChannelAdapterSpec

java.lang.Object

org.springframework.integration.dsl.IntegrationComponentSpec<S,H>

org.springframework.integration.dsl.MessageSourceSpec<FileInboundChannelAdapterSpec,FileReadingMessageSource>

org.springframework.integration.file.dsl.FileInboundChannelAdapterSpec

All Implemented Interfaces:

org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean<FileReadingMessageSource>, org.springframework.beans.factory.InitializingBean, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle, org.springframework.integration.dsl.ComponentsRegistration

public class FileInboundChannelAdapterSpec
extends org.springframework.integration.dsl.MessageSourceSpec<FileInboundChannelAdapterSpec,FileReadingMessageSource>
implements org.springframework.integration.dsl.ComponentsRegistration

A MessageSourceSpec for a FileReadingMessageSource.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field	Description
protected final FileListFilterFactoryBean	fileListFilterFactoryBean

Fields inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

logger, PARSER, target

Fields inherited from interface org.springframework.beans.factory.FactoryBean

OBJECT_TYPE_ATTRIBUTE

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FileInboundChannelAdapterSpec()
protected	FileInboundChannelAdapterSpec(Comparator<File> receptionOrderComparator)

Method Summary

Modifier and Type	Method	Description
FileInboundChannelAdapterSpec	autoCreateDirectory(boolean autoCreateDirectory)	Specify whether to create the source directory automatically if it does not yet exist upon initialization.
FileInboundChannelAdapterSpec	filter(FileListFilter<File> filter)	Configure the filter.
FileInboundChannelAdapterSpec	filterExpression(String expression)	Configure the ExpressionFileListFilter.
FileInboundChannelAdapterSpec	filterFunction(Function<File,Boolean> filterFunction)	Configure the ExpressionFileListFilter.
Map<Object,String>	getComponentsToRegister()
FileInboundChannelAdapterSpec	ignoreHidden(boolean ignoreHidden)	Configure an IgnoreHiddenFileListFilter if ignoreHidden == true.
FileInboundChannelAdapterSpec	locker(FileLocker locker)	Set a FileLocker to be used to guard files against duplicate processing.
FileInboundChannelAdapterSpec	nioLocker()	Configure an NioFileLocker.
FileInboundChannelAdapterSpec	patternFilter(String pattern)	Configure a SimplePatternFileListFilter.
FileInboundChannelAdapterSpec	preventDuplicates(boolean preventDuplicates)	Configure an AcceptOnceFileListFilter if preventDuplicates == true, otherwise - AcceptAllFileListFilter.
FileInboundChannelAdapterSpec	recursive(boolean recursive)	A convenient flag to determine if target message source should use a RecursiveDirectoryScanner or stay with a default one.
FileInboundChannelAdapterSpec	regexFilter(String regex)	Configure a RegexPatternFileListFilter.
FileInboundChannelAdapterSpec	scanEachPoll(boolean scanEachPoll)	Set this flag if you want to make sure the internal queue is refreshed with the latest content of the input directory on each poll.
FileInboundChannelAdapterSpec	scanner(DirectoryScanner scanner)	Specify a custom scanner.
FileInboundChannelAdapterSpec	useWatchService(boolean useWatchService)	Switch this FileReadingMessageSource to use its internal WatchService directory scanner.
FileInboundChannelAdapterSpec	watchDirPredicate(Predicate<Path> watchDirPredicate)	Set a Predicate to check if it is eligible for WatchService.
FileInboundChannelAdapterSpec	watchEvents(FileReadingMessageSource.WatchEventType... watchEvents)	The WatchService event types.
FileInboundChannelAdapterSpec	watchMaxDepth(int watchMaxDepth)	Set a depth for files walk API.

Methods inherited from class org.springframework.integration.dsl.MessageSourceSpec

messageHeaders

Methods inherited from class org.springframework.integration.dsl.IntegrationComponentSpec

_this, afterPropertiesSet, destroy, doGet, getId, getObject, getObjectType, getPhase, id, isAutoStartup, isRunning, start, stop, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.FactoryBean

isSingleton

Field Details

fileListFilterFactoryBean

protected final FileListFilterFactoryBean fileListFilterFactoryBean

Constructor Details

FileInboundChannelAdapterSpec

protected FileInboundChannelAdapterSpec()

FileInboundChannelAdapterSpec

protected FileInboundChannelAdapterSpec(@Nullable
 Comparator<File> receptionOrderComparator)

Method Details

recursive

public FileInboundChannelAdapterSpec recursive(boolean recursive)

A convenient flag to determine if target message source should use a RecursiveDirectoryScanner or stay with a default one.

Parameters:

recursive - to set or not a RecursiveDirectoryScanner.

Returns:

the spec.

Since:

5.5

See Also:

• RecursiveDirectoryScanner

scanner

public FileInboundChannelAdapterSpec scanner(DirectoryScanner scanner)

Specify a custom scanner.

Parameters:

scanner - the scanner.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setScanner(DirectoryScanner)

autoCreateDirectory

public FileInboundChannelAdapterSpec autoCreateDirectory(boolean autoCreateDirectory)

Specify whether to create the source directory automatically if it does not yet exist upon initialization. By default, this value is true. If set to false and the source directory does not exist, an Exception will be thrown upon initialization.

Parameters:

autoCreateDirectory - the autoCreateDirectory.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setAutoCreateDirectory(boolean)

filter

public FileInboundChannelAdapterSpec filter(FileListFilter<File> filter)

Configure the filter.

Parameters:

filter - the filter.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setFilter(FileListFilter)

filterExpression

public FileInboundChannelAdapterSpec filterExpression(String expression)

Configure the ExpressionFileListFilter.

Parameters:

expression - the SpEL expression for files filtering.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setFilter(FileListFilter)
• ExpressionFileListFilter

filterFunction

public FileInboundChannelAdapterSpec filterFunction(Function<File,Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setFilter(FileListFilter)
• ExpressionFileListFilter

preventDuplicates

public FileInboundChannelAdapterSpec preventDuplicates(boolean preventDuplicates)

Configure an AcceptOnceFileListFilter if preventDuplicates == true, otherwise - AcceptAllFileListFilter.

Parameters:

preventDuplicates - true to configure an AcceptOnceFileListFilter.

Returns:

the spec.

ignoreHidden

public FileInboundChannelAdapterSpec ignoreHidden(boolean ignoreHidden)

Configure an IgnoreHiddenFileListFilter if ignoreHidden == true.

Parameters:

ignoreHidden - true to configure an IgnoreHiddenFileListFilter.

Returns:

the spec.

patternFilter

public FileInboundChannelAdapterSpec patternFilter(String pattern)

Configure a SimplePatternFileListFilter.

Parameters:

pattern - The pattern.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setFilter(FileListFilter)
• filter(FileListFilter)

regexFilter

public FileInboundChannelAdapterSpec regexFilter(String regex)

Configure a RegexPatternFileListFilter.

Parameters:

regex - The regex.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setFilter(FileListFilter)
• filter(FileListFilter)

locker

public FileInboundChannelAdapterSpec locker(FileLocker locker)

Set a FileLocker to be used to guard files against duplicate processing.

Parameters:

locker - the locker.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setLocker(FileLocker)

nioLocker

public FileInboundChannelAdapterSpec nioLocker()

Configure an NioFileLocker.

Returns:

the spec.

See Also:

• locker(FileLocker)

scanEachPoll

public FileInboundChannelAdapterSpec scanEachPoll(boolean scanEachPoll)

Set this flag if you want to make sure the internal queue is refreshed with the latest content of the input directory on each poll.

Parameters:

scanEachPoll - the scanEachPoll.

Returns:

the spec.

See Also:

• FileReadingMessageSource.setScanEachPoll(boolean)

useWatchService

public FileInboundChannelAdapterSpec useWatchService(boolean useWatchService)

Switch this FileReadingMessageSource to use its internal WatchService directory scanner.

Parameters:

useWatchService - the boolean flag to enable the use of a WatchService.

Returns:

the spec.

See Also:

• watchEvents(org.springframework.integration.file.FileReadingMessageSource.WatchEventType...)
• FileReadingMessageSource.setUseWatchService(boolean)

watchEvents

public FileInboundChannelAdapterSpec watchEvents(FileReadingMessageSource.WatchEventType... watchEvents)

The WatchService event types. If useWatchService(boolean) isn't true, this option is ignored.

Parameters:

watchEvents - the set of FileReadingMessageSource.WatchEventType.

Returns:

the spec.

See Also:

• useWatchService(boolean)
• FileReadingMessageSource.setWatchEvents(org.springframework.integration.file.FileReadingMessageSource.WatchEventType...)

watchMaxDepth

public FileInboundChannelAdapterSpec watchMaxDepth(int watchMaxDepth)

Set a depth for files walk API.

Parameters:

watchMaxDepth - the depth for files walk.

Returns:

the spec.

Since:

6.1

See Also:

• useWatchService(boolean)
• FileReadingMessageSource.setWatchMaxDepth(int)

watchDirPredicate

public FileInboundChannelAdapterSpec watchDirPredicate(Predicate<Path> watchDirPredicate)

Set a Predicate to check if it is eligible for WatchService.

Parameters:

watchDirPredicate - the Predicate to check dirs for walking.

Returns:

the spec.

Since:

6.1

See Also:

• useWatchService(boolean)
• FileReadingMessageSource.setWatchDirPredicate(Predicate)

getComponentsToRegister

public Map<Object,String> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface org.springframework.integration.dsl.ComponentsRegistration