svn commit: r945926 [4/22] - in /websites/production/camel/content: ./ 2007/08/17/ 2007/08/20/ 2007/10/01/ 2007/10/28/ 2008/04/08/ 2008/04/22/ 2008/04/28/ 2008/07/22/ 2008/10/31/ 2009/01/19/ 2009/02/03/ 2009/02/17/ 2009/03/17/ 2009/05/19/ 2009/06/15/ 2...

[bu...@apache.org]

Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Wed Apr  1 09:26:15 2015
@@ -1325,11 +1325,11 @@ template.send("direct:alias-verify&
                     </div>
     </div>
 <p>The <strong>cxf:</strong> component provides integration with <a shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1426753053381 {padding: 0px;}
-div.rbtoc1426753053381 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1426753053381 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1427880041568 {padding: 0px;}
+div.rbtoc1427880041568 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1427880041568 li {margin-left: 0px;padding-left: 0px;}
 
-/*]]>*/</style></p><div class="toc-macro rbtoc1426753053381">
+/*]]>*/</style></p><div class="toc-macro rbtoc1427880041568">
 <ul class="toc-indentation"><li><a shape="rect" href="#CXF-CXFComponent">CXF Component</a>
 <ul class="toc-indentation"><li><a shape="rect" href="#CXF-URIformat">URI format</a></li><li><a shape="rect" href="#CXF-Options">Options</a>
 <ul class="toc-indentation"><li><a shape="rect" href="#CXF-Thedescriptionsofthedataformats">The descriptions of the dataformats</a>
@@ -3420,7 +3420,7 @@ ftps://[username@]hostname[:port]/direct
                             <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 to 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>binary</code></p></td><td c
 olspan="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 conserve 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="at
 l-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>disableSecureDataChannelDefaults</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 absolute 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">Exchange</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>&#160;Whether the consumer should download the entire file up front, the default behavior, or if it should pass an InputStream&#160;read from the remote resource rather than an in-memory array as the in body of the&#160;Camel&#160;<a shape="rect" href="exchange.html">Exchange</a>. &#160;This option is ignored if download&#160;is false&#160;or is localWorkDirectory is provided. &#160;This option is use
 ful 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 on
 ly</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>known_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 priv
 ate 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" row
 span="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 default 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 colspa
 n="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:</strong> 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</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. Note SFTP will automatic use the <code>connectTimeout</code> as the <code>soTimeout</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="c
 onfluenceTd"><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>Auto</code></p></td><td colspan="1" rowspan="1" class="confluenceTd">
 <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></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><td 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"><code>receiveBufferSize</code></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">&#160;</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&amp;<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" class="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:</st
 rong> 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>.&#160; This reference overrides any configured SSL related options on ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.&#160; See <a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configuration Utility</a>.</p></td></t
 r><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>.&#160; 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:</strong> 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 c
 onfigured, 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></tbody></table></div></div>    <div class="aui-message hint shadowed information-macro">
+<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 to 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"><code>account</code></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 conserve 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>disableSecureDataChannelDefaults</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 absolute full control what th
 e 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">Exchange</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>&#160;Whether the consumer should download the entire file up front, the 
 default behavior, or if it should pass an InputStream&#160;read from the remote resource rather than an in-memory array as the in body of the&#160;Camel&#160;<a shape="rect" href="exchange.html">Exchange</a>. &#160;This option is ignored if download&#160;is false&#160;or is localWorkDirectory is provided. &#160;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></t
 d><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>known_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 end
 point 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="nofollo
 w">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 default 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:</strong> 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</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. Note SFTP will automatic use the <code>connectTimeout</code> as the <code>soTimeout</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><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 no
 t 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>Auto</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><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></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><td 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"><code>receiveBufferSize</code></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">&#160;</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&amp;<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" class="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" rowspa
 n="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" hre
 f="http://camel.apache.org/registry.html">Registry</a>.&#160; This reference overrides any configured SSL related options on ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.&#160; 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>.&#160; 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><co
 de>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>FTP/FTPS Only:</strong> <strong>Camel 2.12.1:</strong> 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 permi
 ssion error. <strong>Camel 2.14.2:</strong> This option now applies to directories as well.</p></td></tr></tbody></table></div></div>    <div class="aui-message hint shadowed information-macro">
                     <p class="title">FTPS component default trust store</p>
                             <span class="aui-icon icon-hint">Icon</span>
                 <div class="message-content">
@@ -3851,7 +3851,7 @@ http://java.sun.com/xml/ns/javaee/web-ap
                             <p>Topic support is available as of Camel 2.15.&#160;</p>
                     </div>
     </div>
-<p>&#160;</p><h3 id="BookComponentAppendix-Options.18">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>Name</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Required</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Description</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">hazelcastInstance</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.14:</strong> The hazelcast instance reference name which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">operation</td><td colspan="1" rowspan="1" class="confluenceTd">-1</td><td colspan="1" rowspan="1" class="confluenceTd"><span>To specify a default operation to use, if no operation h
 eader has been provided. <strong>deprecated</strong> use defaultOperation instead.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">defaultOperation</td><td colspan="1" rowspan="1" class="confluenceTd">-1</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong> To specify a default operation to use, if no operation header has been provided.</td></tr></tbody></table></div><p>&#160;</p><p>&#160;</p>    <div class="aui-message problem shadowed information-macro">
+<p>&#160;</p><h3 id="BookComponentAppendix-Options.18">Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Name</th><th colspan="1" rowspan="1" class="confluenceTh">Required</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">hazelcastInstance</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.14:</strong><span> The hazelcast instance <strong>reference</strong> which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">hazelcastInstanceName</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> The hazelca
 st instance <strong>reference name</strong> which can be used for hazelcast endpoint. If you don't specify the instance reference, camel use the default hazelcast instance from the camel-hazelcast instance.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">operation</td><td colspan="1" rowspan="1" class="confluenceTd">-1</td><td colspan="1" rowspan="1" class="confluenceTd"><span>To specify a default operation to use, if no operation header has been provided. </span><strong>deprecated</strong><span> use defaultOperation instead.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span>defaultOperation</span></td><td colspan="1" rowspan="1" class="confluenceTd">-1</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong><span> To specify a default operation to use, if no operation header has been provided.</span></td></tr></tbody></table></div>    <div class="aui-message problem shadowed information-macro">
                             <span class="aui-icon icon-problem">Icon</span>
                 <div class="message-content">
                             <p>You have to use the second prefix to define which type of data store you want to use.</p>
@@ -4419,7 +4419,95 @@ template.sendBodyAndHeader(&quot;direct:
                             <p>Header variables have changed in Camel 2.8</p>
                     </div>
     </div>
-<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>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerTime</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>time of the event in millis <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the map consumer sets here "instancelistener" <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr>
 <tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerActionn</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>type of event - here <strong>added</strong> or <strong>removed</strong>. <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastInstanceHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>host name of the instance <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastInstancePort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>port n
 umber of the instance <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr></tbody></table></div> <h2 id="BookComponentAppendix-HDFSComponent">HDFS Component</h2><p><strong>Available as of Camel 2.8</strong></p><p>The <strong>hdfs</strong> component enables you to read and write messages from/to an HDFS file system. HDFS is the distributed file system at the heart of <a shape="rect" class="external-link" href="http://hadoop.apache.org">Hadoop</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<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>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerTime</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>time of the event in millis <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>the map consumer sets here "instancelistener" <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr>
 <tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastListenerActionn</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>type of event - here <strong>added</strong> or <strong>removed</strong>. <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastInstanceHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>host name of the instance <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHazelcastInstancePort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Integer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>port n
 umber of the instance <strong><a shape="rect" class="unresolved" href="#">Version 2.8</a></strong></p></td></tr></tbody></table></div><h3 id="BookComponentAppendix-Usinghazelcastreference">Using hazelcast reference</h3><h4 id="BookComponentAppendix-Byitsname">By its name</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;bean id=&quot;hazelcastLifecycle&quot; class=&quot;com.hazelcast.core.LifecycleService&quot;
+      factory-bean=&quot;hazelcastInstance&quot; factory-method=&quot;getLifecycleService&quot;
+      destroy-method=&quot;shutdown&quot; /&gt;
+
+&lt;bean id=&quot;config&quot; class=&quot;com.hazelcast.config.Config&quot;&gt;
+    &lt;constructor-arg type=&quot;java.lang.String&quot; value=&quot;HZ.INSTANCE&quot; /&gt;
+&lt;/bean&gt;
+
+&lt;bean id=&quot;hazelcastInstance&quot; class=&quot;com.hazelcast.core.Hazelcast&quot; factory-method=&quot;newHazelcastInstance&quot;&gt;
+    &lt;constructor-arg type=&quot;com.hazelcast.config.Config&quot; ref=&quot;config&quot;/&gt;
+&lt;/bean&gt;
+&lt;camelContext xmlns=&quot;http://camel.apache.org/schema/spring&quot;&gt;
+    &lt;route id=&quot;testHazelcastInstanceBeanRefPut&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefPut&quot;/&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;put&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstanceName=HZ.INSTANCE&quot;/&gt;
+    &lt;/route&gt;
+
+    &lt;route id=&quot;testHazelcastInstanceBeanRefGet&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefGet&quot; /&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;get&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstanceName=HZ.INSTANCE&quot;/&gt;
+        &lt;to uri=&quot;seda:out&quot; /&gt;
+    &lt;/route&gt;
+&lt;/camelContext&gt;]]></script>
+</div></div><h4 id="BookComponentAppendix-Byinstance">By instance</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;bean id=&quot;hazelcastInstance&quot; class=&quot;com.hazelcast.core.Hazelcast&quot;
+      factory-method=&quot;newHazelcastInstance&quot; /&gt;
+&lt;bean id=&quot;hazelcastLifecycle&quot; class=&quot;com.hazelcast.core.LifecycleService&quot;
+      factory-bean=&quot;hazelcastInstance&quot; factory-method=&quot;getLifecycleService&quot;
+      destroy-method=&quot;shutdown&quot; /&gt;
+
+&lt;camelContext xmlns=&quot;http://camel.apache.org/schema/spring&quot;&gt;
+    &lt;route id=&quot;testHazelcastInstanceBeanRefPut&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefPut&quot;/&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;put&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstance=#hazelcastInstance&quot;/&gt;
+    &lt;/route&gt;
+
+    &lt;route id=&quot;testHazelcastInstanceBeanRefGet&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefGet&quot; /&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;get&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstance=#hazelcastInstance&quot;/&gt;
+        &lt;to uri=&quot;seda:out&quot; /&gt;
+    &lt;/route&gt;
+&lt;/camelContext&gt;]]></script>
+</div></div><h3 id="BookComponentAppendix-PublishinghazelcastinstanceasanOSGIservice">Publishing hazelcast instance as an OSGI service</h3><p>If operating in an OSGI container and you would want to use one instance of hazelcast across all bundles in the same container. You can publish the instance as an OSGI service and bundles using the cache al need is to reference the service in the hazelcast endpoint.</p><h4 id="BookComponentAppendix-BundleAcreateaninstanceandpublishesitasanOSGIservice">Bundle A create an instance and publishes it as an OSGI service</h4><p>&#160;</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;bean id=&quot;config&quot; class=&quot;com.hazelcast.config.FileSystemXmlConfig&quot;&gt;
+    &lt;argument type=&quot;java.lang.String&quot; value=&quot;${hazelcast.config}&quot;/&gt;
+&lt;/bean&gt;
+
+&lt;bean id=&quot;hazelcastInstance&quot; class=&quot;com.hazelcast.core.Hazelcast&quot; factory-method=&quot;newHazelcastInstance&quot;&gt;
+    &lt;argument type=&quot;com.hazelcast.config.Config&quot; ref=&quot;config&quot;/&gt;
+&lt;/bean&gt;
+
+&lt;!-- publishing the hazelcastInstance as a service --&gt;
+&lt;service ref=&quot;hazelcastInstance&quot; interface=&quot;com.hazelcast.core.HazelcastInstance&quot; /&gt;]]></script>
+</div></div><h4 id="BookComponentAppendix-BundleBusestheinstance">Bundle B uses the instance</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;!-- referencing the hazelcastInstance as a service --&gt;
+&lt;reference ref=&quot;hazelcastInstance&quot; interface=&quot;com.hazelcast.core.HazelcastInstance&quot; /&gt;
+
+&lt;camelContext xmlns=&quot;http://camel.apache.org/schema/blueprint&quot;&gt;
+    &lt;route id=&quot;testHazelcastInstanceBeanRefPut&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefPut&quot;/&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;put&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstance=#hazelcastInstance&quot;/&gt;
+    &lt;/route&gt;
+
+    &lt;route id=&quot;testHazelcastInstanceBeanRefGet&quot;&gt;
+        &lt;from uri=&quot;direct:testHazelcastInstanceBeanRefGet&quot; /&gt;
+        &lt;setHeader headerName=&quot;CamelHazelcastOperationType&quot;&gt;
+            &lt;constant&gt;get&lt;/constant&gt;
+        &lt;/setHeader&gt;
+        &lt;to uri=&quot;hazelcast:map:testmap?hazelcastInstance=#hazelcastInstance&quot;/&gt;
+        &lt;to uri=&quot;seda:out&quot; /&gt;
+    &lt;/route&gt;
+&lt;/camelContext&gt;]]></script>
+</div></div> <h2 id="BookComponentAppendix-HDFSComponent">HDFS Component</h2><p><strong>Available as of Camel 2.8</strong></p><p>The <strong>hdfs</strong> component enables you to read and write messages from/to an HDFS file system. HDFS is the distributed file system at the heart of <a shape="rect" class="external-link" href="http://hadoop.apache.org">Hadoop</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
 <script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;dependency&gt;
     &lt;groupId&gt;org.apache.camel&lt;/groupId&gt;
     &lt;artifactId&gt;camel-hdfs&lt;/artifactId&gt;
@@ -7192,7 +7280,7 @@ imaps://[username@]host[:port][?options]
 </div></div><p>For example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
 <script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[smtp://mycompany.mailserver:30?password=tiger&amp;username=scott
 ]]></script>
-</div></div><h4 id="BookComponentAppendix-DefaultPortsDefaultports"><span class="confluence-anchor-link" id="BookComponentAppendix-DefaultPorts"></span>Default ports</h4><p>Default port numbers are supported. If the port number is omitted, Camel determines the port number to use based on the protocol.</p><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Protocol</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Port Number</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SMTP</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>25</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SMTPS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>465</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>POP3</code></p></td><td colspan="1" rowspan="1"
  class="confluenceTd"><p><code>110</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>POP3S</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>995</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>IMAP</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>143</code></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>IMAPS</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>993</code></p></td></tr></tbody></table></div></div><h3 id="BookComponentAppendix-Options.32">Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"
 ><p><code>host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The host name or IP address to connect to.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>port</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>See <a shape="rect" href="#BookComponentAppendix-DefaultPorts">#DefaultPorts</a></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The TCP port number to connect on.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The user name on the email server.</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>
 The password on the email server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreUriScheme</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If <code>false</code>, Camel uses the scheme to determine the transport protocol (POP, IMAP, SMTP etc.)</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>contentType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>text/plain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The mail message content type. Use <code>text/html</code> for HTML mails.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>folderName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>INBOX</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The folder to poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflu
 enceTd"><p><code>destination</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username@host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>@deprecated</strong> Use the <code>to</code> option instead. The <code>TO</code> recipients (receivers of the email).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>to</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username@host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The TO recipients (the receivers of the mail). Separate multiple email addresses with a comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>replyTo</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>alias@host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>As of <strong>Camel 2.8.4, 2.9.1+</strong>, the Reply-To recipients (the receivers of the response mail). Separate multiple ema
 il addresses with a comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CC</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The CC recipients (the receivers of the mail). Separate multiple email addresses with a comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>BCC</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The BCC recipients (the receivers of the mail). Separate multiple email addresses with a comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>from</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>camel@localhost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The FROM email address.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><co
 de>subject</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>&#160;</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>As of <strong>Camel 2.3</strong>, the Subject of the message being sent. Note: Setting the subject in the header takes precedence over this option.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>peek</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.3/2.12.2:</strong> Consumer only. Will mark the <code>javax.mail.Message</code> as peeked before processing the mail message. This applies to <code>IMAPMessage</code> messages types only. By using peek the mail will not be eager marked as <code>SEEN</code> on the mail server, which allows us to rollback the mail message if there is an error processing in Camel.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delete</code></p></td
 ><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Deletes the messages after they have been processed. This is done by setting the <code>DELETED</code> flag on the mail message. If <code>false</code>, the <code>SEEN</code> flag is set instead. As of <strong>Camel 2.10</strong> you can override this configuration option by setting a header with the key <code>delete</code> to determine if the mail should be deleted or not.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>unseen</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>It is possible to configure a consumer endpoint so that it processes only unseen messages (that is, new messages) or all messages. Note that Camel always skips deleted messages. The default option of <code>true</code> will filter to only unseen messages. POP3 doe
 s not support the <code>SEEN</code> flag, so this option is not supported in POP3; use IMAP instead. <strong>Important:</strong> This option is <strong>not</strong> in use if you also use <code>searchTerm</code> options. Instead if you want to disable unseen when using <code>searchTerm</code>'s then add <code>searchTerm.unseen=false</code> as a term.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>copyTo</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.10:</strong> Consumer only. After processing a mail message, it can be copied to a mail folder with the given name. You can override this configuration value, with a header with the key <code>copyTo</code>, allowing you to copy messages to folder names configured at runtime.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>fetchSize</code></p></td><td colspan="1" rowspan="
 1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the maximum number of messages to consume during a poll. This can be used to avoid overloading a mail server, if a mailbox folder contains a lot of messages. Default value of <code>-1</code> means no fetch size and all messages will be consumed. Setting the value to 0 is a special corner case, where Camel will not consume any messages at all.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>alternativeBodyHeader</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelMailAlternativeBody</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the key to an IN message header that contains an alternative email body. For example, if you send emails in <code>text/html</code> format and want to provide an alternative mail body for non-HTML email clients, set the alternative mail body with this key as a header.</p><
 /td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>debugMode</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Enable debug mode on the underlying mail framework. The SUN Mail framework logs the debug messages to <code>System.out</code> by default.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>30000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The connection timeout in milliseconds. Default is 30 seconds.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Milliseconds before the polling starts.</p></td></tr><tr><td colspan="1" rowspan="1" cla
 ss="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>60000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Camel will poll the mailbox only once a minute by default to avoid overloading the mail server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Set to <code>true</code> to use a fixed delay between polls, otherwise fixed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details.</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.8.3/2.9:</strong> Whether the consumer should disconnect after polling. If enabled this forces Camel to connect on each poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>closeFolder</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.10.4:</strong> Whether the consumer should close the folder after polling. Setting this option to <code>false</code> and having <code>disconnect=false</code> as well, then the consumer keep the folder open between polls.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>mail.XXX</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Set any <a shape="rect" class="external-link" href="http://java.sun.com/products/javamail/javadocs/
 index.html" rel="nofollow">additional java mail properties</a>. For instance if you want to set a special property when using POP3 you can now provide the option directly in the URI such as: <code>mail.pop3.forgettopheaders=true</code>. You can set multiple such options, for example: <code>mail.pop3.forgettopheaders=true&amp;mail.mime.encodefilename=true</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>mapMailMessage</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.8:</strong> Specifies whether Camel should map the received mail message to Camel body/headers. If set to true, the body of the mail message is mapped to the body of the Camel IN message and the mail headers are mapped to IN headers. If this option is set to false then the IN message contains a raw <code>javax.mail.Message</code>. You can retrieve this raw message by calling <co
 de>exchange.getIn().getBody(javax.mail.Message.class)</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies the maximum number of messages to gather per poll. By default, no maximum is set. Can be used to set a limit of e.g. 1000 to avoid downloading thousands of files when the server starts up. Set a value of 0 or negative to disable this option.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>javaMailSender</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 a pluggable <span style="color: rgb(34,34,34);">org.apache.camel.component.</span><span style="color: rgb(34,34,34);">mail.JavaMailSender</span> instance in order to use a custom email implementation.</
 p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>ignoreUnsupportedCharset</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Option to let Camel ignore unsupported charset in the local JVM when sending mails. If the charset is unsupported then <code>charset=XXX</code> (where <code>XXX</code> represents the unsupported charset) is removed from the <code>content-type</code> and it relies on the platform default instead.</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>Camel 2.10:</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>.&#160;
  This reference overrides any configured SSLContextParameters at the component level.&#160; See <a shape="rect" class="external-link" href="http://camel.apache.org/http4.html#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>searchTerm</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.11:</strong> Refers to a <code>javax.mail.search.SearchTerm</code> which allows to filter mails based on search criteria such as subject, body, from, sent after a certain date etc. See further below for examples.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>searchTerm.xxx</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.11:</strong> To configure sea
 rch terms directly from the endpoint uri, which supports a limited number of terms defined by the <code>org.apache.camel.component.mail.SimpleSearchTerm</code> class. See further below for examples.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1"><code>sortTerm</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: </strong>To configure the sortTerms that <span>IMAP</span> supports to sort the searched mails<strong><strong>. </strong></strong>You may need to define an array of<p class="p1"><code>com.sun.mail.imap.sortTerm</code> i<span>n the registry first and #name to reference it in this URI option.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p class="p1"><code>postProcessAction</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Ca
 mel 2.15:</strong> Refers to a<code style="line-height: 1.4285715;">org.apache.camel.component.mail.</code><span style="line-height: 1.4285715;"><code>MailBoxPostProcessAction</code> for doing post processing tasks on the mailbox once the normal processing ended.</span></td></tr></tbody></table></div></div><h3 id="BookComponentAppendix-SSLsupport">SSL support</h3><p>The underlying mail framework is responsible for providing SSL support. &#160;You may either configure SSL/TLS support by completely specifying the necessary Java Mail API configuration options, or you may provide a configured SSLContextParameters through the component or endpoint configuration.</p><h4 id="BookComponentAppendix-UsingtheJSSEConfigurationUtility.4">Using the JSSE Configuration Utility</h4><p>As of <strong>Camel 2.10</strong>, the mail component supports SSL/TLS configuration through the <a shape="rect" href="camel-configuration-utilities.html">Camel JSSE Configuration Utility</a>.&#160; This utility greatl
 y decreases the amount of component specific code you need to write and is configurable at the endpoint and component levels.&#160; The following examples demonstrate how to use the utility with the mail component.</p><h5 id="BookComponentAppendix-Programmaticconfigurationoftheendpoint.1">Programmatic configuration of the endpoint</h5><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">

[... 23 lines stripped ...]
Modified: websites/production/camel/content/book-cookbook.html
==============================================================================
--- websites/production/camel/content/book-cookbook.html (original)
+++ websites/production/camel/content/book-cookbook.html Wed Apr  1 09:26:15 2015
@@ -3046,7 +3046,7 @@ BusFactory.setDefaultBus(bus);
 </div>
 </div>
 <div class="design_attribution">
-&copy; 2004-2014 The Apache Software Foundation.
+&copy; 2004-2015 The Apache Software Foundation.
 <br>          
 Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation.  All other marks mentioned may be trademarks or registered trademarks of their respective owners.
 <br>