F - the target file type.S - the target RemoteFileOutboundGatewaySpec implementation type.public abstract class RemoteFileOutboundGatewaySpec<F,S extends RemoteFileOutboundGatewaySpec<F,S>> extends org.springframework.integration.dsl.MessageHandlerSpec<S,AbstractRemoteFileOutboundGateway<F>>
MessageHandlerSpec for the AbstractRemoteFileOutboundGateway.| Modifier | Constructor and Description |
|---|---|
protected |
RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway) |
| 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 |
localDirectory(java.io.File localDirectory)
Specify a directory path where remote files will be transferred to.
|
<P> S |
localDirectory(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> localDirectoryFunction)
Specify a
Function to evaluate directory path where remote files will be transferred to. |
S |
localDirectoryExpression(org.springframework.expression.Expression localDirectoryExpression)
Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
|
S |
localDirectoryExpression(java.lang.String localDirectoryExpression)
Specify a SpEL expression to evaluate directory path where remote files will be transferred to.
|
<P> S |
localFilename(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> localFilenameFunction)
Specify a
Function for local files renaming after downloading. |
S |
localFilenameExpression(org.springframework.expression.Expression localFilenameExpression)
Specify a SpEL expression for local files renaming after downloading.
|
S |
localFilenameExpression(java.lang.String localFilenameExpression)
Specify a SpEL expression for local files renaming after downloading.
|
S |
mputFilter(FileListFilter<java.io.File> filter)
A
FileListFilter that runs against the local file system view when
using MPUT command. |
S |
options(AbstractRemoteFileOutboundGateway.Option... options)
Specify the array of
AbstractRemoteFileOutboundGateway.Option
for various gateway commands. |
S |
options(java.lang.String options)
Specify the array of options for various gateway commands.
|
abstract S |
patternFileNameFilter(java.lang.String pattern)
Specify a simple pattern to match remote files (e.g.
|
S |
patternMputFilter(java.lang.String pattern)
A
SimplePatternFileListFilter that runs against the local file system view when
using MPUT command. |
abstract S |
regexFileNameFilter(java.lang.String regex)
Specify a simple pattern to match remote files (e.g.
|
S |
regexMpuFilter(java.lang.String regex)
A
SimplePatternFileListFilter that runs against the local file system view when
using MPUT command. |
S |
remoteFileSeparator(java.lang.String remoteFileSeparator)
Set the file separator when dealing with remote files; default '/'.
|
S |
renameExpression(org.springframework.expression.Expression expression)
Specify a SpEL expression for files renaming during transfer.
|
S |
renameExpression(java.lang.String expression)
Specify a SpEL expression for files renaming during transfer.
|
<P> S |
renameFunction(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> renameFunction)
Specify a
Function for files renaming during transfer. |
S |
temporaryFileSuffix(java.lang.String temporaryFileSuffix)
Set the temporary suffix to use when transferring files to the remote system.
|
protected RemoteFileOutboundGatewaySpec(AbstractRemoteFileOutboundGateway<F> outboundGateway)
public S options(java.lang.String options)
options - the options to set.options(AbstractRemoteFileOutboundGateway.Option...)public S options(AbstractRemoteFileOutboundGateway.Option... options)
AbstractRemoteFileOutboundGateway.Option
for various gateway commands.options - the options to set.public S remoteFileSeparator(java.lang.String remoteFileSeparator)
remoteFileSeparator - the separator.public S localDirectory(java.io.File localDirectory)
localDirectory - the localDirectory to setpublic S localDirectoryExpression(java.lang.String localDirectoryExpression)
localDirectoryExpression - the SpEL to determine the local directory.public <P> S localDirectory(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> localDirectoryFunction)
Function to evaluate directory path where remote files will be transferred to.P - the expected payload type.localDirectoryFunction - the Function to determine the local directory.public S localDirectoryExpression(org.springframework.expression.Expression localDirectoryExpression)
localDirectoryExpression - a SpEL expression to evaluate the local directory.public S autoCreateLocalDirectory(boolean autoCreateLocalDirectory)
boolean flag to identify if local directory should be created automatically.
Defaults to true.autoCreateLocalDirectory - the autoCreateLocalDirectory to setpublic S temporaryFileSuffix(java.lang.String temporaryFileSuffix)
.writing.temporaryFileSuffix - the temporaryFileSuffix to setpublic S filter(FileListFilter<F> filter)
FileListFilter to filter remote files.filter - the filter to setpublic S mputFilter(FileListFilter<java.io.File> filter)
FileListFilter that runs against the local file system view when
using MPUT command.filter - the filter to setpublic S patternMputFilter(java.lang.String pattern)
SimplePatternFileListFilter that runs against the local file system view when
using MPUT command.pattern - the SimplePatternFileListFilter for MPUT command.public S regexMpuFilter(java.lang.String regex)
SimplePatternFileListFilter that runs against the local file system view when
using MPUT command.regex - the SimplePatternFileListFilter for MPUT command.public S renameExpression(java.lang.String expression)
expression - the String in SpEL syntax.public S renameExpression(org.springframework.expression.Expression expression)
expression - the String in SpEL syntax.public <P> S renameFunction(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> renameFunction)
Function for files renaming during transfer.P - the expected payload type.renameFunction - the Function to use.public S localFilenameExpression(java.lang.String localFilenameExpression)
localFilenameExpression - the SpEL expression to use.public <P> S localFilename(java.util.function.Function<org.springframework.messaging.Message<P>,java.lang.String> localFilenameFunction)
Function for local files renaming after downloading.P - the expected payload type.localFilenameFunction - the Function to use.public S localFilenameExpression(org.springframework.expression.Expression localFilenameExpression)
localFilenameExpression - a SpEL expression to evaluate the local file name.public S chmod(int chmod)
chmod - the permissions.public abstract S patternFileNameFilter(java.lang.String pattern)
pattern - the pattern.AbstractSimplePatternFileListFilter,
filter(org.springframework.integration.file.filters.FileListFilter)public abstract S regexFileNameFilter(java.lang.String regex)
regex - the regex pattern.AbstractRegexPatternFileListFilter,
filter(org.springframework.integration.file.filters.FileListFilter)