Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 2.63 KB

README.adoc

File metadata and controls

59 lines (40 loc) · 2.63 KB

FTP Sink

FTP sink is a simple option to push files to an FTP server from incoming messages.

It uses an ftp-outbound-adapter, therefore incoming messages can be either a java.io.File object, a String (content of the file) or an array of bytes (file content as well).

To use this sink, you need a username and a password to login.

Note
 By default Spring Integration will use o.s.i.file.DefaultFileNameGenerator if none is specified. DefaultFileNameGenerator will determine the file name based on the value of the file_name header (if it exists) in the MessageHeaders, or if the payload of the Message is already a java.io.File, then it will use the original name of that file.

Headers

  • file_name (See note above)

Payload

  • java.io.File

  • java.io.InputStream

  • byte[]

  • String

Output

N/A (writes to the FTP server).

Options

The ftp sink has the following options:

Properties grouped by prefix:

ftp.consumer

auto-create-dir

Whether or not to create the remote directory. (Boolean, default: true)

filename-expression

A SpEL expression to generate the remote file name. (String, default: <none>)

mode

Action to take if the remote file already exists. (FileExistsMode, default: <none>, possible values: APPEND,APPEND_NO_FLUSH,FAIL,IGNORE,REPLACE,REPLACE_IF_MODIFIED)

remote-dir

The remote FTP directory. (String, default: /)

remote-file-separator

The remote file separator. (String, default: /)

temporary-remote-dir

A temporary directory where the file will be written if '#isUseTemporaryFilename()' is true. (String, default: /)

tmp-file-suffix

The suffix to use while the transfer is in progress. (String, default: .tmp)

use-temporary-filename

Whether or not to write to a temporary file and rename. (Boolean, default: true)

ftp.factory

cache-sessions

Cache sessions. (Boolean, default: <none>)

client-mode

The client mode to use for the FTP session. (ClientMode, default: <none>, possible values: ACTIVE,PASSIVE)

host

The host name of the server. (String, default: localhost)

password

The password to use to connect to the server. (String, default: <none>)

port

The port of the server. (Integer, default: 21)

username

The username to use to connect to the server. (String, default: <none>)