org.springframework.integration.file.dsl

Class RemoteFileInboundChannelAdapterSpec<F,S extends RemoteFileInboundChannelAdapterSpec<F,S,MS>,MS extends AbstractInboundFileSynchronizingMessageSource<F>>

java.lang.Object

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

org.springframework.integration.dsl.MessageSourceSpec<S,MS>

org.springframework.integration.file.dsl.RemoteFileInboundChannelAdapterSpec<F,S,MS>

Type Parameters:

F - the target file type.

S - the target RemoteFileInboundChannelAdapterSpec implementation type.

MS - the target AbstractInboundFileSynchronizingMessageSource implementation type.

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<MS>, org.springframework.integration.dsl.ComponentsRegistration

public abstract class RemoteFileInboundChannelAdapterSpec<F,S extends RemoteFileInboundChannelAdapterSpec<F,S,MS>,MS extends AbstractInboundFileSynchronizingMessageSource<F>>
extends org.springframework.integration.dsl.MessageSourceSpec<S,MS>
implements org.springframework.integration.dsl.ComponentsRegistration

A MessageSourceSpec for an AbstractInboundFileSynchronizingMessageSource.

Since:

5.0

Field Summary

Fields

Modifier and Type	Field and Description
protected AbstractInboundFileSynchronizer<F>	synchronizer

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

logger, PARSER, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteFileInboundChannelAdapterSpec(AbstractInboundFileSynchronizer<F> synchronizer)

Method Summary

Modifier and Type	Method and Description
S	autoCreateLocalDirectory(boolean autoCreateLocalDirectory) Configure whether the local directory should be created by the adapter.
S	deleteRemoteFiles(boolean deleteRemoteFiles) Set to true to enable deletion of remote files after successful transfer.
S	filter(FileListFilter<F> filter) Configure a FileListFilter to be applied to the remote files before copying them.
S	filterExpression(java.lang.String expression) Configure the ExpressionFileListFilter.
S	filterFunction(java.util.function.Function<F,java.lang.Boolean> filterFunction) Configure the ExpressionFileListFilter.
java.util.Map<java.lang.Object,java.lang.String>	getComponentsToRegister()
S	localDirectory(java.io.File localDirectory) Configure the local directory to copy files to.
S	localFilename(java.util.function.Function<java.lang.String,java.lang.String> localFilenameFunction) Configure a Function to be invoked to generate the local file name; argument passed to the apply method is the remote file name.
S	localFilenameExpression(org.springframework.expression.Expression localFilenameExpression) Configure a SpEL expression to generate the local file name; the root object for the evaluation is the remote file name.
S	localFilenameExpression(java.lang.String localFilenameExpression) Configure a SpEL expression to generate the local file name; the root object for the evaluation is the remote file name.
S	localFilter(FileListFilter<java.io.File> localFileListFilter) A FileListFilter used to determine which files will generate messages after they have been synchronized.
S	maxFetchSize(int maxFetchSize) Specify the maximum number of remote files that will be fetched on each fetch attempt.
abstract S	patternFilter(java.lang.String pattern) Configure a simple pattern filter (e.g.
S	preserveTimestamp(boolean preserveTimestamp) Set to true to enable the preservation of the remote file timestamp when transferring.
abstract S	regexFilter(java.lang.String regex) Configure a regex pattern filter (e.g.
S	remoteDirectory(java.lang.String remoteDirectory) Specify the full path to the remote directory.
S	remoteDirectoryExpression(org.springframework.expression.Expression remoteDirectoryExpression) Specify an expression that evaluates to the full path to the remote directory.
S	remoteFileSeparator(java.lang.String remoteFileSeparator) Configure the file name path separator used by the remote system.
S	temporaryFileSuffix(java.lang.String temporaryFileSuffix) Configure a suffix to temporarily apply to the local filename; when copied the file is renamed to its final name.

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

_this, doGet, get, getId, getObject, getObjectType, id, isSingleton

Methods inherited from class java.lang.Object

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

Field Detail

synchronizer

protected final AbstractInboundFileSynchronizer<F> synchronizer

Constructor Detail

RemoteFileInboundChannelAdapterSpec

protected RemoteFileInboundChannelAdapterSpec(AbstractInboundFileSynchronizer<F> synchronizer)

Method Detail

autoCreateLocalDirectory

public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)

Configure whether the local directory should be created by the adapter.

Parameters:

autoCreateLocalDirectory - the autoCreateLocalDirectory

Returns:

the spec.

localDirectory

public S localDirectory(java.io.File localDirectory)

Configure the local directory to copy files to.

Parameters:

localDirectory - the localDirectory.

Returns:

the spec.

localFilter

public S localFilter(FileListFilter<java.io.File> localFileListFilter)

A FileListFilter used to determine which files will generate messages after they have been synchronized.

Parameters:

localFileListFilter - the localFileListFilter.

Returns:

the spec.

See Also:

AbstractInboundFileSynchronizingMessageSource.setLocalFilter(FileListFilter)

remoteFileSeparator

public S remoteFileSeparator(java.lang.String remoteFileSeparator)

Configure the file name path separator used by the remote system. Defaults to '/'.

Parameters:

remoteFileSeparator - the remoteFileSeparator.

Returns:

the spec.

localFilenameExpression

public S localFilenameExpression(java.lang.String localFilenameExpression)

Configure a SpEL expression to generate the local file name; the root object for the evaluation is the remote file name.

Parameters:

localFilenameExpression - the localFilenameExpression.

Returns:

the spec.

localFilename

public S localFilename(java.util.function.Function<java.lang.String,java.lang.String> localFilenameFunction)

Configure a Function to be invoked to generate the local file name; argument passed to the apply method is the remote file name.

Parameters:

localFilenameFunction - the localFilenameFunction.

Returns:

the spec.

See Also:

FunctionExpression

localFilenameExpression

public S localFilenameExpression(org.springframework.expression.Expression localFilenameExpression)

Configure a SpEL expression to generate the local file name; the root object for the evaluation is the remote file name.

Parameters:

localFilenameExpression - the localFilenameExpression.

Returns:

the spec.

temporaryFileSuffix

public S temporaryFileSuffix(java.lang.String temporaryFileSuffix)

Configure a suffix to temporarily apply to the local filename; when copied the file is renamed to its final name. Default: '.writing'.

Parameters:

temporaryFileSuffix - the temporaryFileSuffix.

Returns:

the spec.

remoteDirectory

public S remoteDirectory(java.lang.String remoteDirectory)

Specify the full path to the remote directory.

Parameters:

remoteDirectory - the remoteDirectory.

Returns:

the spec.

See Also:

AbstractInboundFileSynchronizer.setRemoteDirectory(String)

remoteDirectoryExpression

public S remoteDirectoryExpression(org.springframework.expression.Expression remoteDirectoryExpression)

Specify an expression that evaluates to the full path to the remote directory.

Parameters:

remoteDirectoryExpression - The remote directory expression.

Returns:

the spec.

filter

public S filter(FileListFilter<F> filter)

Configure a FileListFilter to be applied to the remote files before copying them.

Parameters:

filter - the filter.

Returns:

the spec.

filterExpression

public S filterExpression(java.lang.String expression)

Configure the ExpressionFileListFilter.

Parameters:

expression - the SpEL expression for files filtering.

Returns:

the spec.

See Also:

FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter

filterFunction

public S filterFunction(java.util.function.Function<F,java.lang.Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter

patternFilter

public abstract S patternFilter(java.lang.String pattern)

Configure a simple pattern filter (e.g. '*.txt').

Parameters:

pattern - the pattern.

Returns:

the spec.

See Also:

filter(FileListFilter)

regexFilter

public abstract S regexFilter(java.lang.String regex)

Configure a regex pattern filter (e.g. '[0-9].*.txt').

Parameters:

regex - the regex.

Returns:

the spec.

See Also:

filter(FileListFilter)

deleteRemoteFiles

public S deleteRemoteFiles(boolean deleteRemoteFiles)

Set to true to enable deletion of remote files after successful transfer.

Parameters:

deleteRemoteFiles - true to delete.

Returns:

the spec.

preserveTimestamp

public S preserveTimestamp(boolean preserveTimestamp)

Set to true to enable the preservation of the remote file timestamp when transferring.

Parameters:

preserveTimestamp - true to preserve.

Returns:

the spec.

maxFetchSize

public S maxFetchSize(int maxFetchSize)

Specify the maximum number of remote files that will be fetched on each fetch attempt. A small number is recommended when multiple application instances are running, to avoid one instance from "grabbing" all the files.

Parameters:

maxFetchSize - the max fetch size.

Returns:

the spec.

See Also:

MessageSourceManagement.setMaxFetchSize(int)

getComponentsToRegister

public java.util.Map<java.lang.Object,java.lang.String> getComponentsToRegister()

Specified by:

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