Modified: websites/production/camel/content/ftp2.html ============================================================================== --- websites/production/camel/content/ftp2.html (original) +++ websites/production/camel/content/ftp2.html Wed Aug 5 11:20:07 2015 @@ -99,7 +99,7 @@ sftp://[username@]hostname[:port]/directoryname[?options] ftps://[username@]hostname[:port]/directoryname[?options] ]]></script> -</div></div><p>Where <strong>directoryname</strong> represents the underlying directory. The directory name is a relative path. Absolute path's is <strong>not</strong> supported. The relative path can contain nested folders, such as /inbox/us.</p><p>For Camel versions before <strong>Camel 2.16</strong>, the directoryName <strong>must</strong> exist already as this component does not support the <code>autoCreate</code> option (which the file component does). The reason is that its the FTP administrator (FTP server) task to properly setup user accounts, and home directories with the right file permissions etc.</p><p>For <strong>Camel 2.16</strong>, <code>autoCreate</code> option is supported. When consumer starts, before polling is scheduled, there's additional FTP operation performed to create the directory configured for endpoint. The default value for <code>autoCreate</code> is <code>true</code>.</p><p>If no <strong>username</strong> is provided, then <code>anon ymous</code> login is attempted using no password.<br clear="none"> If no <strong>port</strong> number is provided, Camel will provide default values according to the protocol (ftp = 21, sftp = 22, ftps = 2222).</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><p>This component uses two different libraries for the actual FTP work. FTP and FTPS uses <a shape="rect" class="external-link" href="http://commons.apache.org/net/";>Apache Commons Net</a> while SFTP uses <a shape="rect" class="external-link" href="http://www.jcraft.com/jsch/"; rel="nofollow">JCraft JSCH</a>.</p><p>The FTPS component is only available in Camel 2.2 or newer.<br clear="none"> FTPS (also known as FTP Secure) is an extension to FTP that adds support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols.</p><h3 id="FTP2-URIOptions">URI Options</h3><p>The options below are exclusive for the FTP com ponent.</p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">More options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>See <a shape="rect" href="file2.html">File</a> for more options as all the options from <a shape="rect" href="file2.html">File</a> is inherited.</p></div></div><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the username to use t o log in to the remote file systen.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the password to use to log in to the remote file system.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>account</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15.2:</strong> Specified the account to use to login to the remote FTP server (only for FTP and FTP Secure)</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>binary</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (<code>false</code>).</p></td>< /tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disconnect</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>localWorkDirectory</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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 c onserve memory. See below for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>passiveMode</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS only</strong>: Specifies whether to use passive mode connections. Default is active mode (<code>false</code>).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityProtocol</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>TLS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS only:</strong> Sets the underlying security protocol. The following values are defined: <br clear="none" class="atl-forced-newline"> <code>TLS</code>: Transport Layer Security <br clear="none" class="atl-forced-newline"> <code>SSL</code>: Secure Sockets Layer</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disa bleSecureDataChannelDefaults</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: Whether or not to disable using default values for <code>execPbsz</code> and <code>execProt</code> when using secure data transfer. You can set this option to <code>true</code> if you want to be in full control what the options <code>execPbsz</code> and <code>execProt</code> should be used.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>download</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether the FTP consumer should download the file. If this option is set to <code>false</code>, then the message body will be <code>null</code>, but the consumer will still trigger a Camel <a shape="rect" href="exchange.html">Exchang e</a> that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streamDownload</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> 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 <a shape="rect" href="exchange.html">Exchange</a>.  This option is ignored if download is false or is localWorkDirectory is provided.  This option is useful for working with large remote files.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>execProt</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: Will by default use option <code>P</code> if secure data channel defaults hasn't been disabled. Possible values are: <br clear="none" class="atl-forced-newline"> <code>C</code>: Clear <br clear="none" class="atl-forced-newline"> <code>S</code>: Safe (SSL protocol only) <br clear="none" class="atl-forced-newline"> <code>E</code>: Confidential (SSL protocol only) <br clear="none" class="atl-forced-newline"> <code>P</code>: Private</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>execPbsz</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: This option specifies the buffer size of the secure data channel. If option <code>useSecureDataChannel</code> has been enabled and this option has not been explicit set, then value <code>0</code> is used.</p></td></tr><tr ><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>isImplicit</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS only:</strong> >Sets the security mode(implicit/explicit). Default is explicit >(<code>false</code>).</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>knownHostsFile</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> Sets the ><code>known_hosts</code> file, so that the SFTP endpoint can do host key >verification.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>knownHostsUri</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel >2.11.1:</strong> Sets the <code>k nown_hosts</code> file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>keyPair</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.12.0:</strong> Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyFile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> Set the private key file to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyUri</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code> null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key file (loaded from classpath by default) to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKey</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key as byte[] to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyFilePassphrase</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Deprecated:</strong> use <code>privateKeyPassphrase</code> instead. Set the private key file passphrase to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyPassphrase</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key file passphrase to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>preferredAuthentications</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.10.7, 2.11.2,2.12.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1 " class="confluenceTd"><p><code>ciphers</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8.2, 2.9: SFTP only</strong> Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by <a shape="rect" class="external-link" href="http://www.jcraft.com/jsch/"; rel="nofollow">JCraft JSCH</a>. 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>fastExistsCheck</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8.2, 2.9:</strong> 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 <strong>Camel 2.10.1</strong> onwards this option also influences <code>readLock=changed</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>strictHostKeyChecking</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>no</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.2:</strong> Sets whether to use strict host key checking. Possible values are: <code>no</code>, <code>yes</code> and <code>ask</code>. <code>ask</code> does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. <strong>Note:</strong> The defa ult in Camel 2.1 and below was <code>ask</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maximumReconnectAttempts</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>3</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>reconnectDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Delay in millis Camel will wait before performing a reconnect attempt.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>10000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</stron g> Is the connect timeout in millis. This corresponds to using <code>ftpClient.connectTimeout</code> for the FTP/FTPS. For SFTP this option is also used when attempting to connect.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>soTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null / 30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.4:</strong> Is the <code>SocketOptions.SO_TIMEOUT</code> value in millis. A good idea is to configure this to a value such as 300000 (5 minutes) to not hang a connection. On SFTP this option is set as timeout on the JSCH Session instance.</p><p>Also SFTP from <strong>Camel 2.14.3/2.15.3/2.16</strong> onwards.</p><p>From <strong>Camel 2.16</strong> onwards the default is 30000 (30 sec).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="conf luenceTd"><p><code>30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.4:</strong> Is the data timeout in millis. This corresponds to using <code>ftpClient.dataTimeout</code> for the FTP/FTPS. For SFTP there is no data timeout.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnConnectFailed</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom <code>pollStrategy</code> to deal with the exception, for example to stop the consumer or the likes.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>siteCommand</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.5:</strong> To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use <code>help site</code> to see which site commands your FTP server supports.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>stepwise</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code><span>UNIX</span></code></p></td><td colspan="1" rowspan="1" class="conf luenceTd"><p><strong>Camel 2.6:</strong> Dictates what path separator char to use when uploading files. <code>Auto</code> = Use the path provided without altering it. <code>UNIX</code> = Use unix style path separators. <code>Windows</code> = Use Windows style path separators.</p><p>Since <strong>Camel 2.15.2</strong>: The default value is changed to <span>UNIX</span> style path, before <strong>Camel 2.15.2</strong>: The default value is <code>Auto.</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>chmod</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Producer Only:</strong> <strong>Camel 2.9:</strong> Allows you to set chmod on the stored file. For example <code>chmod=640</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>compression</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><t d colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8.3/2.9:</strong> To use compression. Specify a level from 1 to 10. <strong>Important:</strong> You must manually add the needed JSCH zlib JAR to the classpath for compression support.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>receiveBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>32768</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong><span>FTP/FTPS Only: </span>Camel 2.15.1:</strong> The buffer size for downloading files. The default size is 32kb.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.1:</strong> Allows you to use a custom <code>org.apache.commons.net.ftp.FTPClient</code > instance.</p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><p><code>ftpClientConfig</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS > Only:</strong> <strong>Camel 2.1:</strong> Allows you to use a custom > <code>org.apache.commons.net.ftp.FTPClientConfig</code> > instance.</p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><code>ftpClientConfig.XXX</code></td><td colspan="1" > rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" > class="confluenceTd"><strong>FTP and FTPS Only:</strong> To configure > various options on the FTPClient instance from the uri. For example: > <code>ftpClientConfig.receiveDataSocketBufferSize=8192&<span>ftpClientConfig.sendDataSocketBufferSize=8192</span></code></td></tr><tr><td > colspan="1" rowspan="1" > class="confluenceTd"><p><code>serverAliveInterval</code></p></td><td > colspan="1" rowspan="1" cla ss="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8</strong> Allows you to set the serverAliveInterval of the sftp session</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>serverAliveCountMax</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8</strong> Allows you to set the serverAliveCountMax of the sftp session</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.file</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store file, so that the FTPS client can look up for trusted certificates.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">< p><code>ftpClient.trustStore.type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>JKS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.algorithm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SunX509</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store algorithm.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.file</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store file, so that the FTPS client can look up for the private certificate.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>JKS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.algorithm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SunX509</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store algorithm.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.keyPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the private key password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> <strong>Camel 2.9:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html";>Registry</a>.  This reference overrides any configured SSL related options on ftpCli ent as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See <a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.10.7, 2.11.1:</strong> Reference to a <code>com.jcraft.jsch.Proxy</code> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html";>Registry</a>.  This proxy is used to consume/send messages from the target SFTP host.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>useList</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP/FTPS Only:</strong> <strong>Camel 2.12.1:</s trong> Whether the consumer should use FTP LIST command to retrieve directory listing to see which files exists. If this option is set to <code>false</code>, then <code>stepwise=false</code> must be configured, and also <code>fileName</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreFileNotFoundOrPermissionError</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong> 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. <strong>Camel 2.14.2:</strong> This option now applies to directories as well.</p></td></tr><tr><td colspan="1" rowspa n="1" class="confluenceTd"><code>sendNoop</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> Producer only. 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.</td></tr></tbody></table></div></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">FTPS component default trust store</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When using the <code>ftpClient.</code> properties related to SSL with the FTPS component, the trust store accept all certificates. If you only want trust sel ective certificates, you have to configure the trust store with the <code>ftpClient.trustStore.xxx</code> options or by configuring a custom <code>ftpClient</code>.</p><p>When using <code>sslContextParameters</code>, the trust store is managed by the configuration of the provided SSLContextParameters instance.</p></div></div><p>You can configure additional options on the <code>ftpClient</code> and <code>ftpClientConfig</code> from the URI directly by using the <code>ftpClient.</code> or <code>ftpClientConfig.</code> prefix.</p><p>For example to set the <code>setDataTimeout</code> on the <code>FTPClient</code> to 30 seconds you can do:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div><p>Where <strong>directoryname</strong> represents the underlying directory. The directory name is a relative path. Absolute path's is <strong>not</strong> supported. The relative path can contain nested folders, such as /inbox/us.</p><p>For Camel versions before <strong>Camel 2.16</strong>, the directoryName <strong>must</strong> exist already as this component does not support the <code>autoCreate</code> option (which the file component does). The reason is that its the FTP administrator (FTP server) task to properly setup user accounts, and home directories with the right file permissions etc.</p><p>For <strong>Camel 2.16</strong>, <code>autoCreate</code> option is supported. When consumer starts, before polling is scheduled, there's additional FTP operation performed to create the directory configured for endpoint. The default value for <code>autoCreate</code> is <code>true</code>.</p><p>If no <strong>username</strong> is provided, then <code>anon ymous</code> login is attempted using no password.<br clear="none"> If no <strong>port</strong> number is provided, Camel will provide default values according to the protocol (ftp = 21, sftp = 22, ftps = 2222).</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><p>This component uses two different libraries for the actual FTP work. FTP and FTPS uses <a shape="rect" class="external-link" href="http://commons.apache.org/net/";>Apache Commons Net</a> while SFTP uses <a shape="rect" class="external-link" href="http://www.jcraft.com/jsch/"; rel="nofollow">JCraft JSCH</a>.</p><p>The FTPS component is only available in Camel 2.2 or newer.<br clear="none"> FTPS (also known as FTP Secure) is an extension to FTP that adds support for the Transport Layer Security (TLS) and the Secure Sockets Layer (SSL) cryptographic protocols.</p><h3 id="FTP2-URIOptions">URI Options</h3><p>The options below are exclusive for the FTP com ponent.</p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">More options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>See <a shape="rect" href="file2.html">File</a> for more options as all the options from <a shape="rect" href="file2.html">File</a> is inherited.</p></div></div><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the username to use t o log in to the remote file systen.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the password to use to log in to the remote file system.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>account</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15.2:</strong> Specified the account to use to login to the remote FTP server (only for FTP and FTP Secure)</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>binary</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (<code>false</code>).</p></td>< /tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disconnect</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>localWorkDirectory</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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 c onserve memory. See below for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>passiveMode</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS only</strong>: Specifies whether to use passive mode connections. Default is active mode (<code>false</code>).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityProtocol</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>TLS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS only:</strong> Sets the underlying security protocol. The following values are defined: <br clear="none" class="atl-forced-newline"> <code>TLS</code>: Transport Layer Security <br clear="none" class="atl-forced-newline"> <code>SSL</code>: Secure Sockets Layer</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disa bleSecureDataChannelDefaults</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: Whether or not to disable using default values for <code>execPbsz</code> and <code>execProt</code> when using secure data transfer. You can set this option to <code>true</code> if you want to be in full control what the options <code>execPbsz</code> and <code>execProt</code> should be used.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>download</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether the FTP consumer should download the file. If this option is set to <code>false</code>, then the message body will be <code>null</code>, but the consumer will still trigger a Camel <a shape="rect" href="exchange.html">Exchang e</a> that has details about the file such as file name, file size, etc. It's just that the file will not be downloaded.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>streamDownload</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> 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 <a shape="rect" href="exchange.html">Exchange</a>.  This option is ignored if download is false or is localWorkDirectory is provided.  This option is useful for working with large remote files.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>execProt</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: Will by default use option <code>P</code> if secure data channel defaults hasn't been disabled. Possible values are: <br clear="none" class="atl-forced-newline"> <code>C</code>: Clear <br clear="none" class="atl-forced-newline"> <code>S</code>: Safe (SSL protocol only) <br clear="none" class="atl-forced-newline"> <code>E</code>: Confidential (SSL protocol only) <br clear="none" class="atl-forced-newline"> <code>P</code>: Private</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>execPbsz</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4: FTPS only</strong>: This option specifies the buffer size of the secure data channel. If option <code>useSecureDataChannel</code> has been enabled and this option has not been explicit set, then value <code>0</code> is used.</p></td></tr><tr ><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>isImplicit</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS only:</strong> >Sets the security mode(implicit/explicit). Default is explicit >(<code>false</code>).</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>knownHostsFile</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> Sets the ><code>known_hosts</code> file, so that the SFTP endpoint can do host key >verification.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>knownHostsUri</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" >rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel >2.11.1:</strong> Sets the <code>k nown_hosts</code> file (loaded from classpath by default), so that the SFTP endpoint can do host key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>keyPair</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.12.0:</strong> Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyFile</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> Set the private key file to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyUri</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code> null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key file (loaded from classpath by default) to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKey</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key as byte[] to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyFilePassphrase</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Deprecated:</strong> use <code>privateKeyPassphrase</code> instead. Set the private key file passphrase to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>privateKeyPassphrase</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.11.1:</strong> Set the private key file passphrase to that the SFTP endpoint can do private key verification.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>preferredAuthentications</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.10.7, 2.11.2,2.12.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1 " class="confluenceTd"><p><code>ciphers</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8.2, 2.9: SFTP only</strong> Set a comma separated list of ciphers that will be used in order of preference. Possible cipher names are defined by <a shape="rect" class="external-link" href="http://www.jcraft.com/jsch/"; rel="nofollow">JCraft JSCH</a>. 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>fastExistsCheck</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8.2, 2.9:</strong> 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 <strong>Camel 2.10.1</strong> onwards this option also influences <code>readLock=changed</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>strictHostKeyChecking</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>no</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP only:</strong> <strong>Camel 2.2:</strong> Sets whether to use strict host key checking. Possible values are: <code>no</code>, <code>yes</code> and <code>ask</code>. <code>ask</code> does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. <strong>Note:</strong> The defa ult in Camel 2.1 and below was <code>ask</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maximumReconnectAttempts</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>3</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>reconnectDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Delay in millis Camel will wait before performing a reconnect attempt.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>10000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</stron g> Is the connect timeout in millis. This corresponds to using <code>ftpClient.connectTimeout</code> for the FTP/FTPS. For SFTP this option is also used when attempting to connect.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>soTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null / 30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.4:</strong> Is the <code>SocketOptions.SO_TIMEOUT</code> value in millis. A good idea is to configure this to a value such as 300000 (5 minutes) to not hang a connection. On SFTP this option is set as timeout on the JSCH Session instance.</p><p>Also SFTP from <strong>Camel 2.14.3/2.15.3/2.16</strong> onwards.</p><p>From <strong>Camel 2.16</strong> onwards the default is 30000 (30 sec).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="conf luenceTd"><p><code>30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.4:</strong> Is the data timeout in millis. This corresponds to using <code>ftpClient.dataTimeout</code> for the FTP/FTPS. For SFTP there is no data timeout.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnConnectFailed</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom <code>pollStrategy</code> to deal with the exception, for example to stop the consumer or the likes.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>siteCommand</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.5:</strong> To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use <code>help site</code> to see which site commands your FTP server supports.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>stepwise</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>separator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code><span>UNIX</span></code></p></td><td colspan="1" rowspan="1" class="conf luenceTd"><p><strong>Camel 2.6:</strong> Dictates what path separator char to use when uploading files. <code>Auto</code> = Use the path provided without altering it. <code>UNIX</code> = Use unix style path separators. <code>Windows</code> = Use Windows style path separators.</p><p>Since <strong>Camel 2.15.2</strong>: The default value is changed to <span>UNIX</span> style path, before <strong>Camel 2.15.2</strong>: The default value is <code>Auto.</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>chmod</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Producer Only:</strong> <strong>Camel 2.9:</strong> Allows you to set chmod on the stored file. For example <code>chmod=640</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>compression</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><t d colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8.3/2.9:</strong> To use compression. Specify a level from 1 to 10. <strong>Important:</strong> You must manually add the needed JSCH zlib JAR to the classpath for compression support.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>receiveBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>32768</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong><span>FTP/FTPS Only: </span>Camel 2.15.1:</strong> The buffer size for downloading files. The default size is 32kb.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS Only:</strong> <strong>Camel 2.1:</strong> Allows you to use a custom <code>org.apache.commons.net.ftp.FTPClient</code > instance.</p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><p><code>ftpClientConfig</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP and FTPS > Only:</strong> <strong>Camel 2.1:</strong> Allows you to use a custom > <code>org.apache.commons.net.ftp.FTPClientConfig</code> > instance.</p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><code>ftpClientConfig.XXX</code></td><td colspan="1" > rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" > class="confluenceTd"><strong>FTP and FTPS Only:</strong> To configure > various options on the FTPClient instance from the uri. For example: > <code>ftpClientConfig.receiveDataSocketBufferSize=8192&<span>ftpClientConfig.sendDataSocketBufferSize=8192</span></code></td></tr><tr><td > colspan="1" rowspan="1" > class="confluenceTd"><p><code>serverAliveInterval</code></p></td><td > colspan="1" rowspan="1" cla ss="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8</strong> Allows you to set the serverAliveInterval of the sftp session</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>serverAliveCountMax</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.8</strong> Allows you to set the serverAliveCountMax of the sftp session</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.file</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store file, so that the FTPS client can look up for trusted certificates.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">< p><code>ftpClient.trustStore.type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>JKS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.algorithm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SunX509</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store algorithm.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.trustStore.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the trust store password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.file</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store file, so that the FTPS client can look up for the private certificate.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>JKS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store type.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.algorithm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SunX509</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store algorithm.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the key store password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ftpClient.keyStore.keyPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> Sets the private key password.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTPS Only:</strong> <strong>Camel 2.9:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html";>Registry</a>.  This reference overrides any configured SSL related options on ftpCli ent as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See <a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>SFTP Only:</strong> <strong>Camel 2.10.7, 2.11.1:</strong> Reference to a <code>com.jcraft.jsch.Proxy</code> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html";>Registry</a>.  This proxy is used to consume/send messages from the target SFTP host.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>useList</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP/FTPS Only:</strong> <strong>Camel 2.12.1:</s trong> Whether the consumer should use FTP LIST command to retrieve directory listing to see which files exists. If this option is set to <code>false</code>, then <code>stepwise=false</code> must be configured, and also <code>fileName</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreFileNotFoundOrPermissionError</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.1:</strong> 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. <strong>Camel 2.14.2:</strong> This option now applies to directories as well.</p></td></tr><tr><td colspan="1" rowspa n="1" class="confluenceTd"><code>sendNoop</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> Producer only. 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.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>jschLoggingLevel</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>WARN</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>SFTP Only: Camel 2.16:</strong> 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.</td></tr></tbody></table></div></div><div class="confluence-information-macro confluence-i nformation-macro-information"><p class="title">FTPS component default trust store</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When using the <code>ftpClient.</code> 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 <code>ftpClient.trustStore.xxx</code> options or by configuring a custom <code>ftpClient</code>.</p><p>When using <code>sslContextParameters</code>, the trust store is managed by the configuration of the provided SSLContextParameters instance.</p></div></div><p>You can configure additional options on the <code>ftpClient</code> and <code>ftpClientConfig</code> from the URI directly by using the <code>ftpClient.</code> or <code>ftpClientConfig.</code> prefix.</p><p>For example to set the <code>setDataTimeout</code> on the <code>FTPClien t</code> to 30 seconds you can do:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("ftp://foo@myserver?password=secret&ftpClient.dataTimeout=30000").to("bean:foo"); ]]></script> </div></div><p>You can mix and match and have use both prefixes, for example to configure date format or timezones.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
