Configures a Consumer Endpoint for the
'org.springframework.integration.file.remote.handler.FileTransferringMessageHandler'
for the 'FtpRemoteFileTemplate' that writes files to a remote FTP endpoint.
Identifies channel attached to this adapter. This channel could be the receiving
channel.
Specifies the order for invocation when this
endpoint is connected as a
subscriber to a channel. This is
particularly relevant when that channel
is using a "failover"
dispatching strategy, or when a failure in
the delivery to one
subscriber should signal that
the message should not be sent to
subscribers with a higher 'order'
attribute. It has no effect
when this
endpoint itself is a Polling Consumer for a channel
with a queue.
Configures a 'SourcePollingChannelAdapter' Endpoint for the
'org.springframework.integration.ftp.inbound.FtpInboundFileSynchronizingMessageSource' that
synchronizes a local directory with the contents of a remote FTP endpoint.
Allows you to provide a SpEL expression to
generate the file name of
the local (transferred) file. The root
object of the SpEL
evaluation is the name of the original
file.
For example, a valid expression would be "#this.toUpperCase() +
'.a'" where #this represents the
original name of the remote
file.
Allows you to specify a reference to a
[org.springframework.integration.file.filters.FileListFilter]
bean. This filter is applied to files after they have been
retrieved. The default is an AcceptOnceFileListFilter which means that,
even if a new instance of a file is retrieved from the remote server,
a message won't be generated. The filter provided here is combined
with a filter that prevents the message source from processing
files that are currently being downloaded.
Identifies the directory path (e.g.,
"/local/mytransfers") where files
will be transferred TO.
Tells this adapter if the local directory must
be auto-created if it
doesn't exist. Default is TRUE.
Specify whether to delete the remote source
file after copying.
By default, the remote files will NOT be
deleted.
Specify whether to preserve the modified timestamp from the remote source
file on the local file after copying.
By default, the remote timestamp will NOT be
preserved.
Reference to a custom DirectoryScanner implementation.
Configures a 'SourcePollingChannelAdapter' Endpoint for the
'org.springframework.integration.ftp.inbound.FtpInboundStreamingMessageSource'.
Configures a Consumer Endpoint for the
'org.springframework.integration.ftp.gateway.FtpOutboundGateway'
used to issue FTP commands.
FTP command.
The SpEL expression to evaluate FTP client working directory against request message.
The 'MessageSessionCallback' bean reference to perform custom operation(s) on 'Session'
with 'requestMessage'.
FTP command options; for ls, -1 means just
return the file names
(otherwise file
metadata is returned, -dirs
means include directories (not included by
default),
-links means
include links (not included by default); for get, -P means
preserve
timestamp from remote file.
SpEL expression representing the path in the
command (e.g. ls path to
list the files in directory path).
SpEL expression representing the path for the
new filename when using the 'mv' command. Defaults
to "headers.['file_renameTo']".
Identifies the request channel attached to
this
gateway.
Identifies the reply channel attached to this
gateway.
Allows you to specify a reference to
[org.springframework.integration.file.filters.FileListFilter]
bean. This filter acts against the remote server view when using the 'ls'
or 'mget' commands.
Only one of 'filter', 'filename-pattern', or 'filename-regex' is allowed.
Allows you to provide file name pattern to
determine the file names retrieved by the 'ls' and 'mget' commands
and is based
on simple pattern matching algorithm (e.g., "*.txt, fo*.txt"
etc.)
Only one of 'filter', 'filename-pattern', or 'filename-regex' is allowed.
Allows you to provide Regular Expression to
determine the file names retrieved by the 'ls' and 'mget' commands.
(e.g.,
"f[o]+\.txt" etc.)
Only one of 'filter', 'filename-pattern', or 'filename-regex' is allowed.
Allows you to specify a reference to
[org.springframework.integration.file.filters.FileListFilter]
bean. This filter acts on the local file system when using the 'mput' command.
Only one of 'mput-filter', 'mput-pattern', or 'mput-regex' is allowed.
Allows you to provide file name pattern to
determine the file names sent by the 'mput' command
and is based
on simple pattern matching algorithm (e.g., "*.txt, fo*.txt"
etc.)
Only one of 'mput-filter', 'mput-pattern', or 'mput-regex' is allowed.
Allows you to provide Regular Expression to
determine the file names sent by the 'mput' command
(e.g.,
"f[o]+\.txt" etc.)
Only one of 'mput-filter', 'mput-pattern', or 'mput-regex' is allowed.
Allows you to provide a SpEL expression to
generate the file name of
the local (transferred) file. The root
object of the SpEL
evaluation is the request Message, but the name of the original
remote file is also provided as the 'remoteFileName' variable.
For example, a valid expression would be:
"#remoteFileName.toUpperCase() + headers.foo".
Only used with 'get' and 'mget' commands.
Identifies directory path (e.g.,
"/local/mytransfers") where file will be
transferred TO.
This attribute is mutually exclusive with 'local-directory-expression'.
Specifies SpEL expression to
generate the directory path where file will be
transferred TO, when using 'get' and 'mget' commands.
The root object of the SpEL evaluation is the request Message,
but the name of the source
remote directory is also provided as the 'remoteDirectory' variable.
For example, a valid expression might be:
"'/local/' + #remoteDirectory.toUpperCase() + headers.foo".
Only used with 'get' and 'mget' commands.
This attribute is mutually exclusive with 'local-directory'.
Tells this adapter if local directory must be
auto-created if it
doesn''t exist. Default is TRUE.
Specifies the order for invocation when this
endpoint is connected as a
subscriber to a channel. This is
particularly relevant when that channel
is using a "failover"
dispatching strategy, or when a failure in the
delivery to one
subscriber should signal that
the message should not be sent to
subscribers with a higher 'order'
attribute. It has no effect
when
this
endpoint itself is a Polling Consumer for a channel with
a
queue.
Specify whether this outbound gateway must return a non-null value. This value is
'true' by default, and a ReplyRequiredException will be thrown when
the underlying service returns a null value.
Identifies channel attached to this adapter.
The channel to which messages will be sent
by this adapter.
Allows you to provide a file name pattern to
determine the file names
that need to be scanned.
This is based on
simple pattern matching (e.g., "*.txt, fo*.txt"
etc.)
Allows you to provide a Regular Expression to
determine the file names
that need to be scanned.
(e.g.,
"f[o]+\.txt" etc.)
Allows you to specify a reference to a
[org.springframework.integration.file.filters.FileListFilter]
bean. This filter is applied to files on the remote server and
only files that pass the filter are retrieved.
Identifies the remote temporary directory path (e.g., "/remote/temp/mytransfers")
Allows you to provide remote file/directory
separator character. DEFAULT:
'/'
Identifies the remote directory path (e.g., "/remote/mytransfers")
Mutually exclusive with 'remote-directory-expression'.
Specify a SpEL expression which
will be used to evaluate the directory
path to where the files will be transferred
(e.g., "headers.['remote_dir'] + '/myTransfers'" for outbound endpoints)
There is no root object (message) for inbound endpoints
(e.g., "@someBean.fetchDirectory");
Extension used when downloading files. We change
it right after we know it's downloaded.