org.springframework.integration.file.dsl

Class RemoteFileOutboundGatewaySpec<F,S extends RemoteFileOutboundGatewaySpec<F,S>>

java.lang.Object

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

org.springframework.integration.dsl.MessageHandlerSpec<S,AbstractRemoteFileOutboundGateway<F>>

org.springframework.integration.file.dsl.RemoteFileOutboundGatewaySpec<F,S>

Type Parameters:

F - the target file type.

S - the target RemoteFileOutboundGatewaySpec implementation type.

All Implemented Interfaces:

FactoryBean<AbstractRemoteFileOutboundGateway<F>>, ComponentsRegistration

Direct Known Subclasses:

FtpOutboundGatewaySpec, SftpOutboundGatewaySpec

public abstract class RemoteFileOutboundGatewaySpec<F,S extends RemoteFileOutboundGatewaySpec<F,S>>
extends MessageHandlerSpec<S,AbstractRemoteFileOutboundGateway<F>>
implements ComponentsRegistration

The MessageHandlerSpec for the AbstractRemoteFileOutboundGateway.

Since:

5.0

Author:

Artem Bilan

Field Summary

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

logger, PARSER, target

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Summary

Modifier and Type	Method and Description
S	autoCreateLocalDirectory(boolean autoCreateLocalDirectory) A boolean flag to identify if local directory should be created automatically.
S	chmod(int chmod) Set the file permissions after uploading, e.g.
S	filter(FileListFilter<F> filter) Set a FileListFilter to filter remote files.
S	filterExpression(String expression) Configure the ExpressionFileListFilter.
S	filterFunction(java.util.function.Function<F,Boolean> filterFunction) Configure the ExpressionFileListFilter.
Collection<Object>	getComponentsToRegister()
S	localDirectory(File localDirectory) Specify a directory path where remote files will be transferred to.
<P> S	localDirectory(java.util.function.Function<Message<P>,String> localDirectoryFunction) Specify a Function to evaluate directory path where remote files will be transferred to.
S	localDirectoryExpression(Expression localDirectoryExpression) Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
S	localDirectoryExpression(String localDirectoryExpression) Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
<P> S	localFilename(java.util.function.Function<Message<P>,String> localFilenameFunction) Specify a Function for local files renaming after downloading.
S	localFilenameExpression(Expression localFilenameExpression) Specify a SpEL expression for local files renaming after downloading.
S	localFilenameExpression(String localFilenameExpression) Specify a SpEL expression for local files renaming after downloading.
S	mputFilter(FileListFilter<File> filter) A FileListFilter that runs against the local file system view when using MPUT command.
S	mputFilterExpression(String expression) Configure the ExpressionFileListFilter.
S	mputFilterFunction(java.util.function.Function<File,Boolean> filterFunction) Configure the ExpressionFileListFilter.
S	options(AbstractRemoteFileOutboundGateway.Option... options) Specify the array of AbstractRemoteFileOutboundGateway.Option for various gateway commands.
S	options(String options) Specify the array of options for various gateway commands.
abstract S	patternFileNameFilter(String pattern) Specify a simple pattern to match remote files (e.g.
S	patternMputFilter(String pattern) A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.
abstract S	regexFileNameFilter(String regex) Specify a simple pattern to match remote files (e.g.
S	regexMputFilter(String regex) A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.
S	remoteFileSeparator(String remoteFileSeparator) Set the file separator when dealing with remote files; default '/'.
S	renameExpression(Expression expression) Specify a SpEL expression for files renaming during transfer.
S	renameExpression(String expression) Specify a SpEL expression for files renaming during transfer.
<P> S	renameFunction(java.util.function.Function<Message<P>,String> renameFunction) Specify a Function for files renaming during transfer.
S	temporaryFileSuffix(String temporaryFileSuffix) Set the temporary suffix to use when transferring files to the remote system.

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

Constructor Detail

RemoteFileOutboundGatewaySpec

protected RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Detail

options

public S options(String options)

Specify the array of options for various gateway commands.

Parameters:

options - the options to set.

Returns:

the spec

See Also:

options(AbstractRemoteFileOutboundGateway.Option...)

options

public S options(AbstractRemoteFileOutboundGateway.Option... options)

Specify the array of AbstractRemoteFileOutboundGateway.Option for various gateway commands.

Parameters:

options - the options to set.

Returns:

the spec

remoteFileSeparator

public S remoteFileSeparator(String remoteFileSeparator)

Set the file separator when dealing with remote files; default '/'.

Parameters:

remoteFileSeparator - the separator.

Returns:

the spec

localDirectory

public S localDirectory(File localDirectory)

Specify a directory path where remote files will be transferred to.

Parameters:

localDirectory - the localDirectory to set

Returns:

the spec

localDirectoryExpression

public S localDirectoryExpression(String localDirectoryExpression)

Specify a SpEL expression to evaluate directory path where remote files will be transferred to.

Parameters:

localDirectoryExpression - the SpEL to determine the local directory.

Returns:

the spec

localDirectory

public <P> S localDirectory(java.util.function.Function<Message<P>,String> localDirectoryFunction)

Specify a Function to evaluate directory path where remote files will be transferred to.

Type Parameters:

P - the expected payload type.

Parameters:

localDirectoryFunction - the Function to determine the local directory.

Returns:

the spec

localDirectoryExpression

public S localDirectoryExpression(Expression localDirectoryExpression)

Specify a SpEL expression to evaluate directory path where remote files will be transferred to.

Parameters:

localDirectoryExpression - a SpEL expression to evaluate the local directory.

Returns:

the Spec.

autoCreateLocalDirectory

public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)

A boolean flag to identify if local directory should be created automatically. Defaults to true.

Parameters:

autoCreateLocalDirectory - the autoCreateLocalDirectory to set

Returns:

the Spec.

temporaryFileSuffix

public S temporaryFileSuffix(String temporaryFileSuffix)

Set the temporary suffix to use when transferring files to the remote system. Default .writing.

Parameters:

temporaryFileSuffix - the temporaryFileSuffix to set

Returns:

the Spec.

filter

public S filter(FileListFilter<F> filter)

Set a FileListFilter to filter remote files.

Parameters:

filter - the filter to set

Returns:

the Spec.

filterExpression

public S 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 S filterFunction(java.util.function.Function<F,Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter

mputFilter

public S mputFilter(FileListFilter<File> filter)

A FileListFilter that runs against the local file system view when using MPUT command.

Parameters:

filter - the filter to set

Returns:

the Spec.

patternMputFilter

public S patternMputFilter(String pattern)

A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.

Parameters:

pattern - the SimplePatternFileListFilter for MPUT command.

Returns:

the Spec.

regexMputFilter

public S regexMputFilter(String regex)

A SimplePatternFileListFilter that runs against the local file system view when using MPUT command.

Parameters:

regex - the SimplePatternFileListFilter for MPUT command.

Returns:

the Spec.

mputFilterExpression

public S mputFilterExpression(String expression)

Configure the ExpressionFileListFilter.

Parameters:

expression - the SpEL expression for files filtering.

Returns:

the spec.

See Also:

FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter

mputFilterFunction

public S mputFilterFunction(java.util.function.Function<File,Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

FileReadingMessageSource.setFilter(FileListFilter), ExpressionFileListFilter

renameExpression

public S renameExpression(String expression)

Specify a SpEL expression for files renaming during transfer.

Parameters:

expression - the String in SpEL syntax.

Returns:

the Spec.

renameExpression

public S renameExpression(Expression expression)

Specify a SpEL expression for files renaming during transfer.

Parameters:

expression - the String in SpEL syntax.

Returns:

the Spec.

renameFunction

public <P> S renameFunction(java.util.function.Function<Message<P>,String> renameFunction)

Specify a Function for files renaming during transfer.

Type Parameters:

P - the expected payload type.

Parameters:

renameFunction - the Function to use.

Returns:

the Spec.

localFilenameExpression

public S localFilenameExpression(String localFilenameExpression)

Specify a SpEL expression for local files renaming after downloading.

Parameters:

localFilenameExpression - the SpEL expression to use.

Returns:

the Spec.

localFilename

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

Specify a Function for local files renaming after downloading.

Type Parameters:

P - the expected payload type.

Parameters:

localFilenameFunction - the Function to use.

Returns:

the Spec.

localFilenameExpression

public S localFilenameExpression(Expression localFilenameExpression)

Specify a SpEL expression for local files renaming after downloading.

Parameters:

localFilenameExpression - a SpEL expression to evaluate the local file name.

Returns:

the Spec.

chmod

public S chmod(int chmod)

Set the file permissions after uploading, e.g. 0600 for owner read/write.

Parameters:

chmod - the permissions.

Returns:

the current Spec

getComponentsToRegister

public Collection<Object> getComponentsToRegister()

Specified by:

getComponentsToRegister in interface ComponentsRegistration

patternFileNameFilter

public abstract S patternFileNameFilter(String pattern)

Specify a simple pattern to match remote files (e.g. '*.txt').

Parameters:

pattern - the pattern.

Returns:

the spec.

See Also:

AbstractSimplePatternFileListFilter, filter(org.springframework.integration.file.filters.FileListFilter)

regexFileNameFilter

public abstract S regexFileNameFilter(String regex)

Specify a simple pattern to match remote files (e.g. '[0-9].*.txt').

Parameters:

regex - the regex pattern.

Returns:

the spec.

See Also:

AbstractRegexPatternFileListFilter, filter(org.springframework.integration.file.filters.FileListFilter)