// kafka-connector options: START
[[camel-sftp-kafka-connector-sink]]
= camel-sftp-kafka-connector sink configuration

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

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-sftp-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>
----

To use this Sink connector in Kafka connect you'll need to set the following connector.class

[source,java]
----
connector.class=org.apache.camel.kafkaconnector.sftp.CamelSftpSinkConnector
----


The camel-sftp sink connector supports 58 options, which are listed below.



[width="100%",cols="2,5,^1,1,1",options="header"]
|===
| Name | Description | Default | Required | Priority
| *camel.sink.path.host* | Hostname of the FTP server | null | true | HIGH
| *camel.sink.path.port* | Port of the FTP server | null | false | MEDIUM
| *camel.sink.path.directoryName* | The starting directory | null | false | MEDIUM
| *camel.sink.endpoint.binary* | Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false). | false | false | MEDIUM
| *camel.sink.endpoint.charset* | This option is used to specify the encoding of the file. You can use this on the consumer, to specify the encodings of the files, which allow Camel to know the charset it should load the file content in case the file content is being accessed. Likewise when writing a file, you can use this option to specify which charset to write the file as well. Do mind that when writing the file Camel may have to read the message content into memory to be able to convert the data into the configured charset, so do not use this if you have big messages. | null | false | 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 | false | MEDIUM
| *camel.sink.endpoint.doneFileName* | Producer: If provided, then Camel will write a 2nd done file when the original file has been written. The done file will be empty. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The done file will always be written in the same folder as the original file. Consumer: If provided, Camel will only consume files if a done file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders.The done file is always expected in the same folder as the original file. Only ${file.name} and ${file.name.next} is supported as dynamic placeholders. | null | 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 | false | MEDIUM
| *camel.sink.endpoint.jschLoggingLevel* | The logging level to use for JSCH activity logging. As JSCH is verbose at by default at INFO level the threshold is WARN by default. One of: [TRACE] [DEBUG] [INFO] [WARN] [ERROR] [OFF] | "WARN" | false | MEDIUM
| *camel.sink.endpoint.passiveMode* | Sets passive mode connections. Default is active mode connections. | false | false | MEDIUM
| *camel.sink.endpoint.separator* | Sets the path separator to be used. UNIX = Uses unix style path separator Windows = Uses windows style path separator Auto = (is default) Use existing path separator in file name One of: [UNIX] [Windows] [Auto] | "UNIX" | false | MEDIUM
| *camel.sink.endpoint.fastExistsCheck* | 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. 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. | false | false | MEDIUM
| *camel.sink.endpoint.fileExist* | What to do if a file already exists with the same name. Override, which is the default, replaces the existing file. - Append - adds content to the existing file. - Fail - throws a GenericFileOperationException, indicating that there is already an existing file. - Ignore - silently ignores the problem and does not override the existing file, but assumes everything is okay. - Move - option requires to use the moveExisting option to be configured as well. The option eagerDeleteTargetFile can be used to control what to do if an moving the file, and there exists already an existing file, otherwise causing the move operation to fail. The Move option will move any existing files, before writing the target file. - TryRename is only applicable if tempFileName option is in use. This allows to try renaming the file from the temporary name to the actual name, without doing any exists check. This check may be faster on some file systems and especially FTP servers. One of: [Override] [Append] [Fail] [Ignore] [Move] [TryRename] | "Override" | false | 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 | 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 | false | 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 | false | MEDIUM
| *camel.sink.endpoint.moveExisting* | Expression (such as File Language) used to compute file name to use when fileExist=Move is configured. To move files into a backup subdirectory just enter backup. This option only supports the following File Language tokens: file:name, file:name.ext, file:name.noext, file:onlyname, file:onlyname.noext, file:ext, and file:parent. Notice the file:parent is not supported by the FTP component, as the FTP component can only move any existing files to a relative directory based on current dir as base. | null | false | MEDIUM
| *camel.sink.endpoint.tempFileName* | The same as tempPrefix option but offering a more fine grained control on the naming of the temporary filename as it uses the File Language. The location for tempFilename is relative to the final file location in the option 'fileName', not the target directory in the base uri. For example if option fileName includes a directory prefix: dir/finalFilename then tempFileName is relative to that subdirectory dir. | null | false | MEDIUM
| *camel.sink.endpoint.tempPrefix* | This option is used to write the file using a temporary name and then, after the write is complete, rename it to the real name. Can be used to identify files being written and also avoid consumers (not using exclusive read locks) reading in progress files. Is often used by FTP when uploading big files. | null | false | 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 | false | MEDIUM
| *camel.sink.endpoint.chmod* | Allows you to set chmod on the stored file. For example chmod=640. | null | 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 | false | MEDIUM
| *camel.sink.endpoint.eagerDeleteTargetFile* | Whether or not to eagerly delete any existing target file. This option only applies when you use fileExists=Override and the tempFileName option as well. You can use this to disable (set it to false) deleting the target file before the temp file is written. For example you may write big files and want the target file to exists during the temp file is being written. This ensure the target file is only deleted until the very last moment, just before the temp file is being renamed to the target filename. This option is also used to control whether to delete any existing files when fileExist=Move is enabled, and an existing file exists. If this option copyAndDeleteOnRenameFails false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted before the move operation. | true | false | MEDIUM
| *camel.sink.endpoint.keepLastModified* | Will keep the last modified timestamp from the source file (if any). Will use the Exchange.FILE_LAST_MODIFIED header to located the timestamp. This header can contain either a java.util.Date or long with the timestamp. If the timestamp exists and the option is enabled it will set this timestamp on the written file. Note: This option only applies to the file producer. You cannot use this option with any of the ftp producers. | false | 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 | false | MEDIUM
| *camel.sink.endpoint.sendNoop* | Whether to send a noop command as a pre-write check before uploading files to the FTP server. This is enabled by default as a validation of the connection is still valid, which allows to silently re-connect to be able to upload the file. However if this causes problems, you can turn this option off. | true | false | MEDIUM
| *camel.sink.endpoint.autoCreate* | Automatically create missing directories in the file's pathname. For the file consumer, that means creating the starting directory. For the file producer, it means the directory the files should be written to. | true | false | MEDIUM
| *camel.sink.endpoint.bindAddress* | Specifies the address of the local interface against which the connection should bind. | null | false | MEDIUM
| *camel.sink.endpoint.bulkRequests* | Specifies how many requests may be outstanding at any one time. Increasing this value may slightly improve file transfer speed but will increase memory usage. | null | false | MEDIUM
| *camel.sink.endpoint.compression* | 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. | null | 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 | false | MEDIUM
| *camel.sink.endpoint.existDirCheckUsingLs* | Whether to check for existing directory using LS command or CD. By default LS is used which is safer as otherwise Camel needs to change the directory back after checking. However LS has been reported to cause a problem on windows system in some situations and therefore you can disable this option to use CD. | true | false | MEDIUM
| *camel.sink.endpoint.maximumReconnectAttempts* | Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. | null | false | MEDIUM
| *camel.sink.endpoint.proxy* | To use a custom configured com.jcraft.jsch.Proxy. This proxy is used to consume/send messages from the target SFTP host. | null | false | MEDIUM
| *camel.sink.endpoint.reconnectDelay* | Delay in millis Camel will wait before performing a reconnect attempt. | null | false | MEDIUM
| *camel.sink.endpoint.serverAliveCountMax* | Sets the number of keep-alive messages which may be sent without receiving any messages back from the server. If this threshold is reached while keep-alive messages are being sent, the connection will be disconnected. The default value is one. | 1 | false | MEDIUM
| *camel.sink.endpoint.serverAliveInterval* | Sets the interval (millis) to send a keep-alive message. If zero is specified, any keep-alive message must not be sent. The default interval is zero. | null | false | 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 | false | MEDIUM
| *camel.sink.endpoint.stepwise* | Sets whether we should stepwise change directories while traversing file structures when downloading files, or as well when uploading a file to a directory. You can disable this if you for example are in a situation where you cannot change directory on the FTP server due security reasons. Stepwise cannot be used together with streamDownload. | true | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | false | MEDIUM
| *camel.sink.endpoint.throwExceptionOnConnectFailed* | Should an exception be thrown if connection failed (exhausted) By default exception is not thrown and a WARN is logged. You can use this to enable exception being thrown and handle the thrown exception from the org.apache.camel.spi.PollingConsumerPollStrategy rollback method. | false | false | MEDIUM
| *camel.sink.endpoint.timeout* | Sets the data timeout for waiting for reply Used only by FTPClient | 30000 | false | 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 | false | MEDIUM
| *camel.sink.endpoint.keyPair* | Sets a key pair of the public and private key so to that the SFTP endpoint can do public/private key verification. | null | false | MEDIUM
| *camel.sink.endpoint.knownHosts* | Sets the known_hosts from the byte array, so that the SFTP endpoint can do host key verification. | null | false | MEDIUM
| *camel.sink.endpoint.knownHostsFile* | Sets the known_hosts file, so that the SFTP endpoint can do host key verification. | null | false | MEDIUM
| *camel.sink.endpoint.knownHostsUri* | Sets the known_hosts file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. | null | false | MEDIUM
| *camel.sink.endpoint.password* | Password to use for login | null | false | MEDIUM
| *camel.sink.endpoint.preferredAuthentications* | 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. | null | false | MEDIUM
| *camel.sink.endpoint.privateKey* | Set the private key as byte so that the SFTP endpoint can do private key verification. | null | false | MEDIUM
| *camel.sink.endpoint.privateKeyFile* | Set the private key file so that the SFTP endpoint can do private key verification. | null | false | MEDIUM
| *camel.sink.endpoint.privateKeyPassphrase* | Set the private key file passphrase so that the SFTP endpoint can do private key verification. | null | false | MEDIUM
| *camel.sink.endpoint.privateKeyUri* | Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification. | null | false | MEDIUM
| *camel.sink.endpoint.strictHostKeyChecking* | Sets whether to use strict host key checking. One of: [no] [yes] | "no" | false | MEDIUM
| *camel.sink.endpoint.username* | Username to use for login | null | false | 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 | false | MEDIUM
| *camel.component.sftp.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 | false | MEDIUM
| *camel.component.sftp.autowiredEnabled* | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | false | MEDIUM
|===



The camel-sftp sink connector has no converters out of the box.





The camel-sftp sink connector supports 0 transforms out of the box, which are listed below.



[source,java]
----

org.apache.camel.kafkaconnector.sftp.transformers.SftpRemoteFileTransforms

----



The camel-sftp sink connector has no aggregation strategies out of the box.
// kafka-connector options: END
