Versions Compared

Old Version 91

changes.mady.by.user Henryk Konsek

Saved on

compared with

New Version 92

changes.mady.by.user Henryk Konsek

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

...

Info
titleMore options

See File for more options as all the options from File is inherited.

Div
classconfluenceTableSmall

Name

Default Value

Description

username

null

Specifies the username to use to log in to the remote file systen.

password

null

Specifies the password to use to log in to the remote file system.

binary

false

Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).

disconnect

false

Camel 2.2: Whether or not to disconnect from remote FTP server right after use. Can be used for both consumer and producer. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead.

localWorkDirectory

null

When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. See below for more details.

passiveMode

false

FTP and FTPS only: Specifies whether to use passive mode connections. Default is active mode (false).

securityProtocol

TLS

FTPS only: Sets the underlying security protocol. The following values are defined:
TLS: Transport Layer Security
SSL: Secure Sockets Layer

disableSecureDataChannelDefaults

false

Camel 2.4: FTPS only: Whether or not to disable using default values for execPbsz and execProt when using secure data transfer. You can set this option to true if you want to be in absolute full control what the options execPbsz and execProt should be used.

download

true

Camel 2.11: Whether the FTP consumer should download the file. If this option is set to false, then the message body will be null, but the consumer will still trigger a Camel Exchange that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded.

streamDownload

false

Camel 2.11: Whether the consumer should download the entire file up front, the default behavior, or if it should pass an InputStream read from the remote resource rather than an in-memory array as the in body of the Camel Exchange.  This option is ignored if download is false or is localWorkDirectory is provided.  This option is useful for working with large remote files.

execProt

null

Camel 2.4: FTPS only: Will by default use option P if secure data channel defaults hasn't been disabled. Possible values are:
C: Clear
S: Safe (SSL protocol only)
E: Confidential (SSL protocol only)
P: Private

execPbsz

null

Camel 2.4: FTPS only: This option specifies the buffer size of the secure data channel. If option useSecureDataChannel has been enabled and this option has not been explicit set, then value 0 is used.

isImplicit

false

FTPS only: Sets the security mode(implicit/explicit). Default is explicit (false).

knownHostsFile

null

SFTP only: Sets the known_hosts file, so that the SFTP endpoint can do host key verification.

knownHostsUri

null

SFTP only: Camel 2.11.1: Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.

keyPair

null

SFTP only: Camel 2.12.0: Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys.

privateKeyFile

null

SFTP only: Set the private key file to that the SFTP endpoint can do private key verification.

privateKeyUri

null

SFTP only: Camel 2.11.1: Set the private key file (loaded from classpath by default) to that the SFTP endpoint can do private key verification.

privateKey

null

SFTP only: Camel 2.11.1: Set the private key as byte[] to that the SFTP endpoint can do private key verification.

privateKeyFilePassphrase

null

SFTP only: Deprecated: use privateKeyPassphrase instead. Set the private key file passphrase to that the SFTP endpoint can do private key verification.

privateKeyPassphrase

null

SFTP only: Camel 2.11.1: Set the private key file passphrase to that the SFTP endpoint can do private key verification.

preferredAuthentications

null

SFTP only: Camel 2.10.7,

Wiki Markup
{div:class=confluenceTableSmall} || Name || Default Value || Description || | {{username}} | {{null}} | Specifies the username to use to log in to the remote file systen. | | {{password}} | {{null}} | Specifies the password to use to log in to the remote file system. | | {{binary}} | {{false}} | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII ({{false}}). | | {{disconnect}} | {{false}} | *Camel 2.2:* Whether or not to disconnect from remote FTP server right after use. Can be used for both consumer and producer. Disconnect will only disconnect the current connection to the FTP server. If you have a consumer which you want to stop, then you need to stop the consumer/route instead. | | {{localWorkDirectory}} | {{null}} | When consuming, a local work directory can be used to store the remote file content directly in local files, to avoid loading the content into memory. This is beneficial, if you consume a very big remote file and thus can conserve memory. See below for more details. | | {{passiveMode}} | {{false}} | *FTP and FTPS only*: Specifies whether to use passive mode connections. Default is active mode ({{false}}). | | {{securityProtocol}} | {{TLS}} | *FTPS only:* Sets the underlying security protocol. The following values are defined: \\ {{TLS}}: Transport Layer Security \\ {{SSL}}: Secure Sockets Layer | | {{disableSecureDataChannelDefaults}} | {{false}} | *Camel 2.4: FTPS only*: Whether or not to disable using default values for {{execPbsz}} and {{execProt}} when using secure data transfer. You can set this option to {{true}} if you want to be in absolute full control what the options {{execPbsz}} and {{execProt}} should be used. | | {{download}} | {{true}} | *Camel 2.11:* Whether the FTP consumer should download the file. If this option is set to {{false}}, then the message body will be {{null}}, but the consumer will still trigger a Camel [Exchange] that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded. | | streamDownload\\ | false | *Camel 2.11:* Whether the consumer should download the entire file up front, the default behavior, or if it should pass an InputStream read from the remote resource rather than an in-memory array as the in body of the Camel [Exchange].  This option is ignored if download is false or is localWorkDirectory is provided.  This option is useful for working with large remote files. | | {{execProt}} | {{null}} | *Camel 2.4: FTPS only*: Will by default use option {{P}} if secure data channel defaults hasn't been disabled. Possible values are: \\ {{C}}: Clear \\ {{S}}: Safe (SSL protocol only) \\ {{E}}: Confidential (SSL protocol only) \\ {{P}}: Private | | {{execPbsz}} | {{null}} | *Camel 2.4: FTPS only*: This option specifies the buffer size of the secure data channel. If option {{useSecureDataChannel}} has been enabled and this option has not been explicit set, then value {{0}} is used. | | {{isImplicit}} | {{false}} | *FTPS only:* Sets the security mode(implicit/explicit). Default is explicit ({{false}}). | | {{knownHostsFile}} | {{null}} | *SFTP only:* Sets the {{known_hosts}} file, so that the SFTP endpoint can do host key verification. | | {{knownHostsUri}} | {{null}} | *SFTP only:* *Camel 2.11.1:* Sets the {{known_hosts}} file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. | | {{keyPair}} | {{null}} | *SFTP only:* *Camel 2.12.0:* Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys. | | {{privateKeyFile}} | {{null}} | *SFTP only:* Set the private key file to that the SFTP endpoint can do private key verification. | | {{privateKeyUri}} | {{null}} | *SFTP only:* *Camel 2.11.1:* Set the private key file (loaded from classpath by default) to that the SFTP endpoint can do private key verification. | | {{privateKey}} | {{null}} | *SFTP only:* *Camel 2.11.1:* Set the private key as byte[] to that the SFTP endpoint can do private key verification. | | {{privateKeyFilePassphrase}} | {{null}} | *SFTP only:* *Deprecated:* use {{privateKeyPassphrase}} instead. Set the private key file passphrase to that the SFTP endpoint can do private key verification. | | {{privateKeyPassphrase}} | {{null}} | *SFTP only:* *Camel 2.11.1:* Set the private key file passphrase to that the SFTP endpoint can do private key verification. | | {{preferredAuthentications}} | {{null}} | *SFTP only:* *Camel 2.10.7,

2.11.2,2.12.0:

*

set

the

preferred

authentications

which

SFTP

endpoint

will

used.

Some

example

include:password,publickey.

If

not

specified

the

default

list

from

JSCH

will

be

used.

| | {{ciphers}} | {{null}} | *Camel

ciphers

null

Camel 2.8.2,

2.9:

SFTP

only

*

Set

a

comma

separated

list

of

ciphers

that

will

be

used

in

order

of

preference.

Possible

cipher

names

are

defined

by

[

JCraft

JSCH

|http://www

.

jcraft.com/jsch/].

Some

examples

include:

aes128-ctr,aes128-cbc,3des-ctr,3des-cbc,blowfish-cbc,aes192-cbc,aes256-cbc.

If

not

specified

the

default

list

from

JSCH

will

be

used.

| | {{fastExistsCheck}} | {{false}} | *Camel

fastExistsCheck

false

Camel 2.8.2,

2.9:

*

If

set

this

option

to

be

true,

camel-ftp

will

use

the

list

file

directly

to

check

if

the

file

exists.

Since

some

FTP

server

may

not

support

to

list

the

file

directly,

if

the

option

is

false,

camel-ftp

will

use

the

old

way

to

list

the

directory

and

check

if

the

file

exists.

Note

from

*

Camel

2.10.1

*

onwards

this

option

also

influences

{{

readLock=changed

}}

to

control

whether

it

performs

a

fast

check

to

update

file

information

or

not.

This

can

be

used

to

speed

up

the

process

if

the

FTP

server

has

a

lot

of

files.

| | {{strictHostKeyChecking}} | {{no}} | *SFTP only:* *Camel

strictHostKeyChecking

no

SFTP only: Camel 2.2:

*

Sets

whether

to

use

strict

host

key

checking.

Possible

values

are:

{{no}}, {{yes}} and {{ask}}. {{ask}} does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. *Note:* The default in Camel 2.1 and below was {{ask}}. | | {{maximumReconnectAttempts}} | {{3}} | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. | | {{reconnectDelay}} | {{1000}} | Delay in millis Camel will wait before performing a reconnect attempt. | | {{connectTimeout}} | {{10000}} | *Camel 2.4:* Is the connect timeout in millis. This corresponds to using {{ftpClient.connectTimeout}} for the FTP/FTPS. For SFTP this option is also used when attempting to connect. | | {{soTimeout}} | {{null}} | *FTP and FTPS Only:* *Camel 2.4:* Is the {{SocketOptions.SO_TIMEOUT}} value in millis. Note SFTP will automatic use the {{connectTimeout}} as the {{soTimeout}}. | | {{timeout}} | {{30000}} | *FTP and FTPS Only:* *Camel 2.4:* Is the data timeout in millis. This corresponds to using {{ftpClient.dataTimeout}} for the FTP/FTPS. For SFTP there is no data timeout. | | {{throwExceptionOnConnectFailed}} | {{false}} | *Camel 2.5:* Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom {{pollStrategy}} to deal with the exception, for example to stop the consumer or the likes. | | {{siteCommand}} | {{null}} | *FTP and FTPS Only:* *Camel 2.5:* To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use {{help site}} to see which site commands your FTP server supports. | | {{stepwise}} | {{true}} | *Camel 2.6:* Whether or not stepwise traversing directories should be used or not. Stepwise means that it will CD one directory at a time. See more details below. You can disable this in case you can't use this approach. | | {{separator}} | {{Auto}} | *Camel 2.6:* Dictates what path separator char to use when uploading files. {{Auto}} = Use the path provided without altering it. {{UNIX}} = Use unix style path separators. {{Windows}} = Use Windows style path separators. | | {{chmod}} | {{null}} | *SFTP Producer Only:* *Camel 2.9:* Allows you to set chmod on the stored file. For example {{chmod=640}}. | | {{compression}} | 0 | *SFTP Only:* *Camel

no, yes and ask. ask does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. Note: The default in Camel 2.1 and below was ask.

maximumReconnectAttempts

3

Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.

reconnectDelay

1000

Delay in millis Camel will wait before performing a reconnect attempt.

connectTimeout

10000

Camel 2.4: Is the connect timeout in millis. This corresponds to using ftpClient.connectTimeout for the FTP/FTPS. For SFTP this option is also used when attempting to connect.

soTimeout

null

FTP and FTPS Only: Camel 2.4: Is the SocketOptions.SO_TIMEOUT value in millis. Note SFTP will automatic use the connectTimeout as the soTimeout.

timeout

30000

FTP and FTPS Only: Camel 2.4: Is the data timeout in millis. This corresponds to using ftpClient.dataTimeout for the FTP/FTPS. For SFTP there is no data timeout.

throwExceptionOnConnectFailed

false

Camel 2.5: Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom pollStrategy to deal with the exception, for example to stop the consumer or the likes.

siteCommand

null

FTP and FTPS Only: Camel 2.5: To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use help site to see which site commands your FTP server supports.

stepwise

true

Camel 2.6: Whether or not stepwise traversing directories should be used or not. Stepwise means that it will CD one directory at a time. See more details below. You can disable this in case you can't use this approach.

separator

Auto

Camel 2.6: Dictates what path separator char to use when uploading files. Auto = Use the path provided without altering it. UNIX = Use unix style path separators. Windows = Use Windows style path separators.

chmod

null

SFTP Producer Only: Camel 2.9: Allows you to set chmod on the stored file. For example chmod=640.

compression

0

SFTP Only: Camel 2.8.3/2.9:

*

To

use

compression.

Specify

a

level

from

1

to

10.

*

Important:

*

You

must

manually

add

the

needed

JSCH

zlib

JAR

to

the

classpath

for

compression

support.

| | {{ftpClient}} | {{null}} | *FTP and FTPS Only:* *Camel

ftpClient

null

FTP and FTPS Only: Camel 2.1:

*

Allows

you

to

use

a

custom

{{

org.apache.commons.net.ftp.FTPClient

}}

instance.

| | {{ftpClientConfig}} | {{null}} | *FTP and FTPS Only:* *Camel

ftpClientConfig

null

FTP and FTPS Only: Camel 2.1:

*

Allows

you

to

use

a

custom

{{

org.apache.commons.net.ftp.FTPClientConfig

}}

instance.

| | {{serverAliveInterval}} | {{0}} | *SFTP Only:* *Camel 2.8* Allows you to set the serverAliveInterval of the sftp session | | {{serverAliveCountMax}} | {{1}} | *SFTP Only:* *Camel 2.8* Allows you to set the serverAliveCountMax of the sftp session | | {{ftpClient.trustStore.file}} | {{null}} | *FTPS Only:* Sets the trust store file, so that the FTPS client can look up for trusted certificates. | | {{ftpClient.trustStore.type}} | {{JKS}} | *FTPS Only:* Sets the trust store type. | | {{ftpClient.trustStore.algorithm}} | {{SunX509}} | *FTPS Only:* Sets the trust store algorithm. | | {{ftpClient.trustStore.password}} | {{null}} | *FTPS Only:* Sets the trust store password. | | {{ftpClient.keyStore.file}} | {{null}} | *FTPS Only:* Sets the key store file, so that the FTPS client can look up for the private certificate. | | {{ftpClient.keyStore.type}} | {{JKS}} | *FTPS Only:* Sets the key store type. | | {{ftpClient.keyStore.algorithm}} | {{SunX509}} | *FTPS Only:* Sets the key store algorithm. | | {{ftpClient.keyStore.password}} | {{null}} | *FTPS Only:* Sets the key store password. | | {{ftpClient.keyStore.keyPassword}} | {{null}} | *FTPS Only:* Sets the private key password. | | {{sslContextParameters}} | {{null}} | *FTPS Only:* *Camel 2.9:* Reference to a {{

serverAliveInterval

0

SFTP Only: Camel 2.8 Allows you to set the serverAliveInterval of the sftp session

serverAliveCountMax

1

SFTP Only: Camel 2.8 Allows you to set the serverAliveCountMax of the sftp session

ftpClient.trustStore.file

null

FTPS Only: Sets the trust store file, so that the FTPS client can look up for trusted certificates.

ftpClient.trustStore.type

JKS

FTPS Only: Sets the trust store type.

ftpClient.trustStore.algorithm

SunX509

FTPS Only: Sets the trust store algorithm.

ftpClient.trustStore.password

null

FTPS Only: Sets the trust store password.

ftpClient.keyStore.file

null

FTPS Only: Sets the key store file, so that the FTPS client can look up for the private certificate.

ftpClient.keyStore.type

JKS

FTPS Only: Sets the key store type.

ftpClient.keyStore.algorithm

SunX509

FTPS Only: Sets the key store algorithm.

ftpClient.keyStore.password

null

FTPS Only: Sets the key store password.

ftpClient.keyStore.keyPassword

null

FTPS Only: Sets the private key password.

sslContextParameters

null

FTPS Only: Camel 2.9: Reference to a org.apache.camel.util.jsse.SSLContextParameters

}}

in

the

[

Registry

|http://camel.apache.org/registry.html].  This reference overrides any configured SSL related options on ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See [Using the JSSE Configuration Utility|CAMEL:Camel Configuration Utilities]. | | {{proxy}} | {{null}} | *SFTP Only:* *Camel

.  This reference overrides any configured SSL related options on ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See Using the JSSE Configuration Utility.

proxy

null

SFTP Only: Camel 2.10.7,

2.11.1:

*

Reference

to

a

{{

com.jcraft.jsch.Proxy

}}

in

the

[

Registry

|http://camel.apache.org/registry.html].  This proxy is used to

.  This proxy is used to consume/send

messages

from

the

target

SFTP host. | | {{useList}} | {{true}} | *

SFTP host.

useList

true

FTP/FTPS

Only:

* *

Camel

2.12.1:

*

Whether

the

consumer

should

use

FTP

LIST

command

to

retrieve

directory

listing

to

see

which

files

exists.

If

this

option

is

set

to

{{

false

}}

,

then

{{

stepwise=false

}}

must

be

configured,

and

also

{{

fileName

}}

must

be

configured

to

a

fixed

name,

so

the

consumer

knows

the

name

of

the

file

to

retrieve.

When

doing

this

only

that

single

file

can

be

retrieved.

See

further

below

for

more

details.

| | {{ignoreFileNotFoundOrPermissionError}} | {{false}} | *Camel

ignoreFileNotFoundOrPermissionError

false

Camel 2.12.1:

*

Whether

the

consumer

should

ignore

when

a

file

was

attempted

to

be

retrieved

but

did

not

exist

(for

some

reason),

or

failure

due

insufficient

file

permission

error.

| {div}

Info
titleFTPS component default trust store

When using the ftpClient. properties related to SSL with the FTPS component, the trust store accept all certificates. If you only want trust selective certificates, you have to configure the trust store with the ftpClient.trustStore.xxx options or by configuring a custom ftpClient.

When using sslContextParameters, the trust store is managed by the configuration of the provided SSLContextParameters instance.

...

The following message headers can be used to affect the behavior of the component

Div
classconfluenceTableSmall

Header

Description

CamelFileName

Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead.

CamelFileNameProduced

The actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users the name of the file that was written.

CamelFileBatchIndex

Current index out of total number of files being consumed in this batch.

CamelFileBatchSize

Total number of files being consumed in this batch.

CamelFileHost

The remote hostname.

CamelFileLocalWorkPath

Path to the local work file, if local work directory is used.

Wiki Markup
{div:class=confluenceTableSmall} || Header || Description || | {{CamelFileName}} | Specifies the output file name (relative to the endpoint directory) to be used for the output message when sending to the endpoint. If this is not present and no expression either, then a generated message ID is used as the filename instead. | | {{CamelFileNameProduced}} | The actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users the name of the file that was written. | | {{CamelFileBatchIndex}} | Current index out of total number of files being consumed in this batch. | | {{CamelFileBatchSize}} | Total number of files being consumed in this batch. | | {{CamelFileHost}} | The remote hostname. | | {{CamelFileLocalWorkPath}} | Path to the local work file, if local work directory is used. | {div}

In addition the FTP/FTPS consumer and producer will enrich the Camel Message with the following headers

Div
classconfluenceTableSmall

Header

Description

CamelFtpReplyCode

Camel

Wiki Markup
{div:class=confluenceTableSmall} || Header || Description || | {{CamelFtpReplyCode}} | *Camel

2.11.1:

*

The

FTP

client

reply

code

(the

type

is

a

integer)

| | {{CamelFtpReplyString}} | *Camel

CamelFtpReplyString

Camel 2.11.1:

*

The

FTP

client

reply

string

| {div}

About timeouts

The two set of libraries (see top) has different API for setting timeout. You can use the connectTimeout option for both of them to set a timeout in millis to establish a network connection. An individual soTimeout can also be set on the FTP/FTPS, which corresponds to using ftpClient.soTimeout. Notice SFTP will automatically use connectTimeout as its soTimeout. The timeout option only applies for FTP/FTSP as the data timeout, which corresponds to the ftpClient.dataTimeout value. All timeout values are in millis.

...