Package 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:

DisposableBean, FactoryBean<AbstractRemoteFileOutboundGateway<F>>, InitializingBean, Lifecycle, Phased, SmartLifecycle, ComponentsRegistration

Direct Known Subclasses:

FtpOutboundGatewaySpec, SftpOutboundGatewaySpec, SmbOutboundGatewaySpec

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, Gary Russell

Field Summary

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	RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Summary

Modifier and Type	Method	Description
S	autoCreateDirectory(boolean autoCreateDirectory)	Determine whether the remote directory should automatically be created when sending files to the remote system.
S	autoCreateLocalDirectory(boolean autoCreateLocalDirectory)	A boolean flag to identify if local directory should be created automatically.
S	charset(String charset)	Set the charset to use when converting String payloads to bytes as the content of the remote file.
S	chmod(int chmod)	Set the file permissions after uploading, e.g.
S	fileExistsMode(FileExistsMode fileExistsMode)	Determine the action to take when using GET and MGET operations when the file already exists locally, or PUT and MPUT when the file exists on the remote system.
S	fileNameExpression(String fileNameExpression)	Set the file name expression to determine the full path to the remote file.
S	fileNameExpression(Expression fileNameExpression)	Set the file name expression to determine the full path to the remote file.
<P> S	fileNameFunction(Function<Message<P>,String> fileNameFunction)	Set the file name function to determine the full path to the remote file.
S	fileNameGenerator(FileNameGenerator fileNameGenerator)	Set the file name generator used to generate the remote filename to be used when transferring files to the remote system.
S	filter(FileListFilter<F> filter)	Set a FileListFilter to filter remote files.
S	filterExpression(String expression)	Configure the ExpressionFileListFilter.
S	filterFunction(Function<F,Boolean> filterFunction)	Configure the ExpressionFileListFilter.
Map<Object,String>	getComponentsToRegister()
S	localDirectory(File localDirectory)	Specify a directory path where remote files will be transferred to.
<P> S	localDirectory(Function<Message<P>,String> localDirectoryFunction)	Specify a Function 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.
S	localDirectoryExpression(Expression localDirectoryExpression)	Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
S	localFilenameExpression(String localFilenameExpression)	Specify a SpEL expression for local files renaming after downloading.
S	localFilenameExpression(Expression localFilenameExpression)	Specify a SpEL expression for local files renaming after downloading.
<P> S	localFilenameFunction(Function<Message<P>,String> localFilenameFunction)	Specify a Function 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(Function<File,Boolean> filterFunction)	Configure the ExpressionFileListFilter.
S	options(String options)	Specify the array of options for various gateway commands.
S	options(AbstractRemoteFileOutboundGateway.Option... options)	Specify the array of AbstractRemoteFileOutboundGateway.Option 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	remoteDirectoryExpression(String remoteDirectoryExpression)	Set the remote directory expression used to determine the remote directory to which files will be sent.
S	remoteDirectoryExpression(Expression remoteDirectoryExpression)	Set the remote directory expression used to determine the remote directory to which files will be sent.
<P> S	remoteDirectoryFunction(Function<Message<P>,String> remoteDirectoryFunction)	Specify a Function for remote directory.
S	remoteFileSeparator(String remoteFileSeparator)	Set the file separator when dealing with remote files; default '/'.
S	renameExpression(String expression)	Specify a SpEL expression for files renaming during transfer.
S	renameExpression(Expression expression)	Specify a SpEL expression for files renaming during transfer.
<P> S	renameFunction(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.
S	temporaryRemoteDirectoryExpression(String temporaryRemoteDirectoryExpression)	Set a temporary remote directory expression; used when transferring files to the remote system.
S	temporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)	Set a temporary remote directory expression; used when transferring files to the remote system.
<P> S	temporaryRemoteDirectoryFunction(Function<Message<P>,String> temporaryRemoteDirectoryFunction)	Set a temporary remote directory function; used when transferring files to the remote system.
S	useTemporaryFileName(boolean useTemporaryFileName)	Set whether a temporary file name is used when sending files to the remote system.

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

_this, afterPropertiesSet, destroy, doGet, get, 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

Constructor Details

RemoteFileOutboundGatewaySpec

protected RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway)

Method Details

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(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:

• AbstractRemoteFileOutboundGateway.setFilter(FileListFilter)
• ExpressionFileListFilter

filterFunction

public S filterFunction(Function<F,Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

• AbstractRemoteFileOutboundGateway.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:

• AbstractRemoteFileOutboundGateway.setFilter(FileListFilter)
• ExpressionFileListFilter

mputFilterFunction

public S mputFilterFunction(Function<File,Boolean> filterFunction)

Configure the ExpressionFileListFilter.

Parameters:

filterFunction - the Function for files filtering.

Returns:

the spec.

See Also:

• AbstractRemoteFileOutboundGateway.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(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.

localFilenameFunction

public <P> S localFilenameFunction(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.

Since:

5.2

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

fileExistsMode

public S fileExistsMode(FileExistsMode fileExistsMode)

Determine the action to take when using GET and MGET operations when the file already exists locally, or PUT and MPUT when the file exists on the remote system.

Parameters:

fileExistsMode - the fileExistsMode to set.

Returns:

the current Spec

autoCreateDirectory

public S autoCreateDirectory(boolean autoCreateDirectory)

Determine whether the remote directory should automatically be created when sending files to the remote system.

Parameters:

autoCreateDirectory - true to create the directory.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setAutoCreateDirectory(boolean)

remoteDirectoryExpression

public S remoteDirectoryExpression(String remoteDirectoryExpression)

Set the remote directory expression used to determine the remote directory to which files will be sent.

Parameters:

remoteDirectoryExpression - the remote directory expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)

remoteDirectoryFunction

public <P> S remoteDirectoryFunction(Function<Message<P>,String> remoteDirectoryFunction)

Specify a Function for remote directory.

Type Parameters:

P - the expected payload type.

Parameters:

remoteDirectoryFunction - the Function to use.

Returns:

the Spec.

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)
• FunctionExpression

remoteDirectoryExpression

public S remoteDirectoryExpression(Expression remoteDirectoryExpression)

Set the remote directory expression used to determine the remote directory to which files will be sent.

Parameters:

remoteDirectoryExpression - the remote directory expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)

temporaryRemoteDirectoryExpression

public S temporaryRemoteDirectoryExpression(String temporaryRemoteDirectoryExpression)

Set a temporary remote directory expression; used when transferring files to the remote system.

Parameters:

temporaryRemoteDirectoryExpression - the temporary remote directory expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)

temporaryRemoteDirectoryFunction

public <P> S temporaryRemoteDirectoryFunction(Function<Message<P>,String> temporaryRemoteDirectoryFunction)

Set a temporary remote directory function; used when transferring files to the remote system.

Type Parameters:

P - the expected payload type.

Parameters:

temporaryRemoteDirectoryFunction - the file name expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)

temporaryRemoteDirectoryExpression

public S temporaryRemoteDirectoryExpression(Expression temporaryRemoteDirectoryExpression)

Set a temporary remote directory expression; used when transferring files to the remote system.

Parameters:

temporaryRemoteDirectoryExpression - the temporary remote directory expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setRemoteDirectoryExpression(org.springframework.expression.Expression)

fileNameExpression

public S fileNameExpression(String fileNameExpression)

Set the file name expression to determine the full path to the remote file.

Parameters:

fileNameExpression - the file name expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setFileNameExpression(org.springframework.expression.Expression)

fileNameFunction

public <P> S fileNameFunction(Function<Message<P>,String> fileNameFunction)

Set the file name function to determine the full path to the remote file.

Type Parameters:

P - the expected payload type.

Parameters:

fileNameFunction - the file name expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setFileNameExpression(org.springframework.expression.Expression)

fileNameExpression

public S fileNameExpression(Expression fileNameExpression)

Set the file name expression to determine the full path to the remote file.

Parameters:

fileNameExpression - the file name expression.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setFileNameExpression(org.springframework.expression.Expression)

useTemporaryFileName

public S useTemporaryFileName(boolean useTemporaryFileName)

Set whether a temporary file name is used when sending files to the remote system.

Parameters:

useTemporaryFileName - true to use a temporary file name.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setUseTemporaryFileName(boolean)

fileNameGenerator

public S fileNameGenerator(FileNameGenerator fileNameGenerator)

Set the file name generator used to generate the remote filename to be used when transferring files to the remote system.

Parameters:

fileNameGenerator - the file name generator.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setFileNameGenerator(org.springframework.integration.file.FileNameGenerator)

charset

public S charset(String charset)

Set the charset to use when converting String payloads to bytes as the content of the remote file. Default UTF-8.

Parameters:

charset - the charset.

Returns:

the current Spec

Since:

5.2

See Also:

• AbstractRemoteFileOutboundGateway.setCharset(java.lang.String)

getComponentsToRegister

public Map<Object,String> 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)