camel-scp-kafka-connector sink configuration

When using camel-scp-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-scp-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

The camel-scp sink connector supports 30 options, which are listed below.

Name	Description	Default	Priority
camel.sink.path.host	Hostname of the FTP server	null	HIGH
camel.sink.path.port	Port of the FTP server	null	MEDIUM
camel.sink.path.directoryName	The starting directory	null	MEDIUM
camel.sink.endpoint.chmod	Allows you to set chmod on the stored file. For example chmod=664.	"664"	MEDIUM
camel.sink.endpoint.disconnect	Whether or not to disconnect from remote FTP server right after use. 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.	false	MEDIUM
camel.sink.endpoint.fileName	Use Expression such as File Language to dynamically set the filename. For consumers, it’s used as a filename filter. For producers, it’s used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today’s file using the File Language syntax: mydata-\${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards.	null	MEDIUM
camel.sink.endpoint.flatten	Flatten is used to flatten the file name path to strip any leading paths, so it’s just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths.	false	MEDIUM
camel.sink.endpoint.jailStartingDirectory	Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders.	true	MEDIUM
camel.sink.endpoint.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	MEDIUM
camel.sink.endpoint.strictHostKeyChecking	Sets whether to use strict host key checking. Possible values are: no, yes One of: [no] [yes]	"no"	MEDIUM
camel.sink.endpoint.allowNullBody	Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged.	false	MEDIUM
camel.sink.endpoint.disconnectOnBatchComplete	Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server.	false	MEDIUM
camel.sink.endpoint.moveExistingFileStrategy	Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided	null	MEDIUM
camel.sink.endpoint.basicPropertyBinding	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM
camel.sink.endpoint.connectTimeout	Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH	10000	MEDIUM
camel.sink.endpoint.soTimeout	Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance.	300000	MEDIUM
camel.sink.endpoint.synchronous	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	MEDIUM
camel.sink.endpoint.timeout	Sets the data timeout for waiting for reply Used only by FTPClient	30000	MEDIUM
camel.sink.endpoint.knownHostsFile	Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system.	null	MEDIUM
camel.sink.endpoint.password	Password to use for login	null	MEDIUM
camel.sink.endpoint.preferredAuthentications	Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used.	null	MEDIUM
camel.sink.endpoint.privateKeyBytes	Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn’t set. Otherwise the file will have the priority.	null	MEDIUM
camel.sink.endpoint.privateKeyFile	Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system.	null	MEDIUM
camel.sink.endpoint.privateKeyFilePassphrase	Set the private key file passphrase to that the endpoint can do private key verification.	null	MEDIUM
camel.sink.endpoint.username	Username to use for login	null	MEDIUM
camel.sink.endpoint.useUserKnownHostsFile	If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts	true	MEDIUM
camel.sink.endpoint.ciphers	Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft 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.	null	MEDIUM
camel.component.scp.lazyStartProducer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	MEDIUM
camel.component.scp.verboseLogging	JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.	false	MEDIUM
camel.component.scp.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	MEDIUM

Name

Description

Default

Priority

camel.sink.path.host

Hostname of the FTP server

null

HIGH

camel.sink.path.port

Port of the FTP server

null

MEDIUM

camel.sink.path.directoryName

The starting directory

null

MEDIUM

camel.sink.endpoint.chmod

Allows you to set chmod on the stored file. For example chmod=664.

"664"

MEDIUM

camel.sink.endpoint.disconnect

Whether or not to disconnect from remote FTP server right after use. 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.

false

MEDIUM

camel.sink.endpoint.fileName

Use Expression such as File Language to dynamically set the filename. For consumers, it’s used as a filename filter. For producers, it’s used to evaluate the filename to write. If an expression is set, it take precedence over the CamelFileName header. (Note: The header itself can also be an Expression). The expression options support both String and Expression types. If the expression is a String type, it is always evaluated using the File Language. If the expression is an Expression type, the specified Expression type is used - this allows you, for instance, to use OGNL expressions. For the consumer, you can use it to filter filenames, so you can for instance consume today’s file using the File Language syntax: mydata-\${date:now:yyyyMMdd}.txt. The producers support the CamelOverruleFileName header which takes precedence over any existing CamelFileName header; the CamelOverruleFileName is a header that is used only once, and makes it easier as this avoids to temporary store CamelFileName and have to restore it afterwards.

null

MEDIUM

camel.sink.endpoint.flatten

Flatten is used to flatten the file name path to strip any leading paths, so it’s just the file name. This allows you to consume recursively into sub-directories, but when you eg write the files to another directory they will be written in a single directory. Setting this to true on the producer enforces that any file name in CamelFileName header will be stripped for any leading paths.

false

MEDIUM

camel.sink.endpoint.jailStartingDirectory

Used for jailing (restricting) writing files to the starting directory (and sub) only. This is enabled by default to not allow Camel to write files to outside directories (to be more secured out of the box). You can turn this off to allow writing files to directories outside the starting directory, such as parent or root folders.

true

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.strictHostKeyChecking

Sets whether to use strict host key checking. Possible values are: no, yes One of: [no] [yes]

"no"

MEDIUM

camel.sink.endpoint.allowNullBody

Used to specify if a null body is allowed during file writing. If set to true then an empty file will be created, when set to false, and attempting to send a null body to the file component, a GenericFileWriteException of 'Cannot write null body to file.' will be thrown. If the fileExist option is set to 'Override', then the file will be truncated, and if set to append the file will remain unchanged.

false

MEDIUM

camel.sink.endpoint.disconnectOnBatchComplete

Whether or not to disconnect from remote FTP server right after a Batch upload is complete. disconnectOnBatchComplete will only disconnect the current connection to the FTP server.

false

MEDIUM

camel.sink.endpoint.moveExistingFileStrategy

Strategy (Custom Strategy) used to move file with special naming token to use when fileExist=Move is configured. By default, there is an implementation used if no custom strategy is provided

null

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.connectTimeout

Sets the connect timeout for waiting for a connection to be established Used by both FTPClient and JSCH

10000

MEDIUM

camel.sink.endpoint.soTimeout

Sets the so timeout FTP and FTPS Only for Camel 2.4. SFTP for Camel 2.14.3/2.15.3/2.16 onwards. Is the SocketOptions.SO_TIMEOUT value in millis. Recommended option is to set this to 300000 so as not have a hanged connection. On SFTP this option is set as timeout on the JSCH Session instance.

300000

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.timeout

Sets the data timeout for waiting for reply Used only by FTPClient

30000

MEDIUM

camel.sink.endpoint.knownHostsFile

Sets the known_hosts file, so that the jsch endpoint can do host key verification. You can prefix with classpath: to load the file from classpath instead of file system.

null

MEDIUM

camel.sink.endpoint.password

Password to use for login

null

MEDIUM

camel.sink.endpoint.preferredAuthentications

Set a comma separated list of authentications that will be used in order of preference. Possible authentication methods are defined by JCraft JSCH. Some examples include: gssapi-with-mic,publickey,keyboard-interactive,password If not specified the JSCH and/or system defaults will be used.

null

MEDIUM

camel.sink.endpoint.privateKeyBytes

Set the private key bytes to that the endpoint can do private key verification. This must be used only if privateKeyFile wasn’t set. Otherwise the file will have the priority.

null

MEDIUM

camel.sink.endpoint.privateKeyFile

Set the private key file to that the endpoint can do private key verification. You can prefix with classpath: to load the file from classpath instead of file system.

null

MEDIUM

camel.sink.endpoint.privateKeyFilePassphrase

Set the private key file passphrase to that the endpoint can do private key verification.

null

MEDIUM

camel.sink.endpoint.username

Username to use for login

null

MEDIUM

camel.sink.endpoint.useUserKnownHostsFile

If knownHostFile has not been explicit configured, then use the host file from System.getProperty(user.home) /.ssh/known_hosts

true

MEDIUM

camel.sink.endpoint.ciphers

Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by JCraft 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.

null

MEDIUM

camel.component.scp.lazyStartProducer

false

MEDIUM

camel.component.scp.verboseLogging

JSCH is verbose logging out of the box. Therefore we turn the logging down to DEBUG logging by default. But setting this option to true turns on the verbose logging again.

false

MEDIUM

camel.component.scp.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM