You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2013/06/24 10:19:24 UTC
svn commit: r867169 [5/5] - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
ftp.html ftp2.html
Modified: websites/production/camel/content/ftp2.html
==============================================================================
--- websites/production/camel/content/ftp2.html (original)
+++ websites/production/camel/content/ftp2.html Mon Jun 24 08:19:24 2013
@@ -35,6 +35,8 @@
</style>
<![endif]-->
+
+
<title>
Apache Camel: FTP2
</title>
@@ -52,8 +54,8 @@
<div class="content_r">
<div>
<!-- Banner -->
-<div id="banner-content">
- <div id="asf_logo">
+<div id="banner-content"><p>
+ </p><div id="asf_logo">
<div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png) no-repeat scroll left top;">
<a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px; margin-top:20px; margin-left:18px;" href="http://camel.apache.org/">Camel</a>
<a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px; margin-top:45px; margin-right:10px;" href="http://www.apache.org">Apache</a>
@@ -80,16 +82,13 @@
<p>This component provides access to remote file systems over the FTP and SFTP protocols.</p>
<p>Maven users will need to add the following dependency to their <tt>pom.xml</tt> for this component:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
-<span class="code-tag"><dependency></span>
- <span class="code-tag"><groupId></span>org.apache.camel<span class="code-tag"></groupId></span>
- <span class="code-tag"><artifactId></span>camel-ftp<span class="code-tag"></artifactId></span>
- <span class="code-tag"><version></span>x.x.x<span class="code-tag"></version></span>
- <span class="code-tag"><span class="code-comment"><!-- use the same version as your Camel core version --></span></span>
-<span class="code-tag"></dependency></span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p><dependency><br clear="none">
+ <groupId>org.apache.camel</groupId><br clear="none">
+ <artifactId>camel-ftp</artifactId><br clear="none">
+ <version>x.x.x</version><br clear="none">
+ <!-- use the same version as your Camel core version --><br clear="none">
+</dependency></p></div>
<div class="panelMacro"><table class="infoMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/information.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>More options</b><br clear="none">See <a shape="rect" href="file2.html" title="File2">File</a> for more options as all the options from <a shape="rect" href="file2.html" title="File2">File</a> is inherited.</td></tr></table></div>
@@ -97,13 +96,10 @@
<h3><a shape="rect" name="FTP2-URIformat"></a>URI format</h3>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-ftp:<span class="code-comment">//[username@]hostname[:port]/directoryname[?options]
-</span>sftp:<span class="code-comment">//[username@]hostname[:port]/directoryname[?options]
-</span>ftps:<span class="code-comment">//[username@]hostname[:port]/directoryname[?options]</span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p><a shape="rect" href="ftp://<span class=" error="error">[username@]hostname<span class="error">[:port]</span>/directoryname<span class="error">[?options]</span>" class="external-link" rel="nofollow">ftp://<span class="error">[username@]</span>hostname<span class="error">[:port]</span>/directoryname<span class="error">[?options]</span></a><br clear="none">
+sftp://<span class="error">[username@]</span>hostname<span class="error">[:port]</span>/directoryname<span class="error">[?options]</span>
+<a shape="rect" href="ftps://<span class=" error="error">[username@]hostname<span class="error">[:port]</span>/directoryname<span class="error">[?options]</span>" class="external-link" rel="nofollow">ftps://<span class="error">[username@]</span>hostname<span class="error">[:port]</span>/directoryname<span class="error">[?options]</span></a></p></div>
<p>Where <b>directoryname</b> represents the underlying directory. Can contain nested folders.</p>
@@ -130,7 +126,7 @@ FTPS (also known as FTP Secure) is an ex
<tt>C</tt>: Clear <br clear="none" class="atl-forced-newline">
<tt>S</tt>: Safe (SSL protocol only) <br clear="none" class="atl-forced-newline">
<tt>E</tt>: Confidential (SSL protocol only) <br clear="none" class="atl-forced-newline">
-<tt>P</tt>: Private </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>execPbsz</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.4: FTPS only</b>: This option specifies the buffer size of the secure data channel. If option <tt>useSecureDataChannel</tt> has been enabled and this option has not been explicit set, then value <tt>0</tt> is used. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>isImplicit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS only:</b> Sets the security mode(implicit/explicit). Default is explicit (<tt>false</tt>). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>knownHostsFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b>
Sets the <tt>known_hosts</tt> file, so that the SFTP endpoint can do host key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> Set the private key file to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyFilePassphrase</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> Set the private key file passphrase to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ciphers</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.2, 2.9: SFTP only</b> Set a c
omma 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fastExistsCheck</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.2, 2.9:</b> 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 <b>Camel 2.10.1</b> onwards this option also influences <tt>readLock=changed</tt> to control w
hether 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strictHostKeyChecking</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>no</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Camel 2.2:</b> Sets whether to use strict host key checking. Possible values are: <tt>no</tt>, <tt>yes</tt> and <tt>ask</tt>. <tt>ask</tt> does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. <b>Note:</b> The default in Camel 2.1 and below was <tt>ask</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maximumReconnectAttempts</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>3</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum reconnect attempts Camel performs when it tries to
connect to the remote FTP server. Use 0 to disable this behavior. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>reconnectDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Delay in millis Camel will wait before performing a reconnect attempt. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>10000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.4:</b> Is the connect timeout in millis. This corresponds to using <tt>ftpClient.connectTimeout</tt> for the FTP/FTPS. For SFTP this option is also used when attempting to connect. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>soTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b
>Camel 2.4:</b> Is the <tt>SocketOptions.SO_TIMEOUT</tt> value in millis. Note SFTP will automatic use the <tt>connectTimeout</tt> as the <tt>soTimeout</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.4:</b> Is the data timeout in millis. This corresponds to using <tt>ftpClient.dataTimeout</tt> for the FTP/FTPS. For SFTP there is no data timeout. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>throwExceptionOnConnectFailed</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom <tt>pollStrategy</tt> to deal with the exception, for example to stop the
consumer or the likes. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>siteCommand</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.5:</b> To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use <tt>help site</tt> to see which site commands your FTP server supports. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stepwise</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>separator</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>Auto</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> Dictates what path separator char to use when uploading files. <tt>Auto</tt> = Use the path provided without altering it. <tt>UNIX</tt> = Use unix style path separators. <tt>Windows</tt> = Use Windows style path separators. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>chmod</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Producer Only:</b> <b>Camel 2.9:</b> Allows you to set chmod on the stored file. For example <tt>chmod=640</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>compression</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Only:</b> <b>Camel 2.8.3/2.9:</b> To use compression. Specify a level from 1 to 10. <b>Importa
nt:</b> You must manually add the needed JSCH zlib JAR to the classpath for compression support. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.1:</b> Allows you to use a custom <tt>org.apache.commons.net.ftp.FTPClient</tt> instance. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClientConfig</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.1:</b> Allows you to use a custom <tt>org.apache.commons.net.ftp.FTPClientConfig</tt> instance. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serverAliveInterval</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"
> <b>SFTP Only:</b> <b>Camel 2.8</b> Allows you to set the serverAliveInterval of the sftp session </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serverAliveCountMax</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Only:</b> <b>Camel 2.8</b> Allows you to set the serverAliveCountMax of the sftp session </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.file</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store file, so that the FTPS client can look up for trusted certificates. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.type</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>JKS</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the
trust store type. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.algorithm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>SunX509</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store algorithm. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.file</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store file, so that the FTPS client can look up for the private certificate. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keySto
re.type</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>JKS</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store type. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.algorithm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>SunX509</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store algorithm. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.keyPassword</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the privat
e key password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> <b>Camel 2.9:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> 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 ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See <a shape="rect" href="camel-configuration-utilities.html" title="Camel Configuration Utilities">Using the JSSE Configuration Utility</a>. </td></tr></tbody></table>
+<tt>P</tt>: Private </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>execPbsz</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.4: FTPS only</b>: This option specifies the buffer size of the secure data channel. If option <tt>useSecureDataChannel</tt> has been enabled and this option has not been explicit set, then value <tt>0</tt> is used. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>isImplicit</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS only:</b> Sets the security mode(implicit/explicit). Default is explicit (<tt>false</tt>). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>knownHostsFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b>
Sets the <tt>known_hosts</tt> file, so that the SFTP endpoint can do host key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>knownHostsUri</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Camel 2.11.1:</b> Sets the <tt>known_hosts</tt> file (loaded from classpath by default), so that the SFTP endpoint can do host key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> Set the private key file to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyUri</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenc
eTd"> <b>SFTP only:</b> <b>Camel 2.11.1:</b> Set the private key file (loaded from classpath by default) to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKey</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Camel 2.11.1:</b> Set the private key as byte[] to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyFilePassphrase</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Deprecated:</b> use <tt>privateKeyPassphrase</tt> instead. Set the private key file passphrase to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>privateKeyPassphrase</tt
> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Camel 2.11.1:</b> Set the private key file passphrase to that the SFTP endpoint can do private key verification. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ciphers</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.2, 2.9: SFTP only</b> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>fastExistsCheck</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8.2, 2.9:</b> 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 <b>Camel 2.10.1</b> onwards this option also influences <tt>readLock=changed</tt> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>strictHostKeyChecking</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>no</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP only:</b> <b>Camel 2.2:</b> Sets whether to use strict host key checking. Possible values are: <tt>no</tt>, <tt
>yes</tt> and <tt>ask</tt>. <tt>ask</tt> does not make sense to use as Camel cannot answer the question for you as its meant for human intervention. <b>Note:</b> The default in Camel 2.1 and below was <tt>ask</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maximumReconnectAttempts</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>3</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Specifies the maximum reconnect attempts Camel performs when it tries to connect to the remote FTP server. Use 0 to disable this behavior. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>reconnectDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Delay in millis Camel will wait before performing a reconnect attempt. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>connectTimeout</tt> </td><td colspan="1" rowspan="1" class="confl
uenceTd"> <tt>10000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.4:</b> Is the connect timeout in millis. This corresponds to using <tt>ftpClient.connectTimeout</tt> for the FTP/FTPS. For SFTP this option is also used when attempting to connect. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>soTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.4:</b> Is the <tt>SocketOptions.SO_TIMEOUT</tt> value in millis. Note SFTP will automatic use the <tt>connectTimeout</tt> as the <tt>soTimeout</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>timeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>30000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.4:</b> Is the data timeout in millis. This corresponds to using <tt>ftpClient.dat
aTimeout</tt> for the FTP/FTPS. For SFTP there is no data timeout. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>throwExceptionOnConnectFailed</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.5:</b> Whether or not to thrown an exception if a successful connection and login could not be establish. This allows a custom <tt>pollStrategy</tt> to deal with the exception, for example to stop the consumer or the likes. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>siteCommand</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.5:</b> To execute site commands after successful login. Multiple site commands can be separated using a new line character (\n). Use <tt>help site</tt> to see which site commands your FTP server supports. </td></t
r><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>stepwise</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> 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. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>separator</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>Auto</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> Dictates what path separator char to use when uploading files. <tt>Auto</tt> = Use the path provided without altering it. <tt>UNIX</tt> = Use unix style path separators. <tt>Windows</tt> = Use Windows style path separators. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>chmod</tt> </td><td colspan="1" rowspan="1" clas
s="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Producer Only:</b> <b>Camel 2.9:</b> Allows you to set chmod on the stored file. For example <tt>chmod=640</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>compression</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Only:</b> <b>Camel 2.8.3/2.9:</b> To use compression. Specify a level from 1 to 10. <b>Important:</b> You must manually add the needed JSCH zlib JAR to the classpath for compression support. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.1:</b> Allows you to use a custom <tt>org.apache.commons.net.ftp.FTPClient</tt> instance. </td></tr><tr><td colspan="1" rowspan="1" class="co
nfluenceTd"> <tt>ftpClientConfig</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP and FTPS Only:</b> <b>Camel 2.1:</b> Allows you to use a custom <tt>org.apache.commons.net.ftp.FTPClientConfig</tt> instance. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serverAliveInterval</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Only:</b> <b>Camel 2.8</b> Allows you to set the serverAliveInterval of the sftp session </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>serverAliveCountMax</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>SFTP Only:</b> <b>Camel 2.8</b> Allows you to set the serverAliveCountMax of the sftp session </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftp
Client.trustStore.file</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store file, so that the FTPS client can look up for trusted certificates. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.type</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>JKS</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store type. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.algorithm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>SunX509</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store algorithm. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.trustStore.password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td c
olspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the trust store password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.file</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store file, so that the FTPS client can look up for the private certificate. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.type</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>JKS</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store type. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.algorithm</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>SunX509</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store algorithm. </td></tr><tr><td colspan=
"1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.password</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the key store password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ftpClient.keyStore.keyPassword</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> Sets the private key password. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sslContextParameters</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTPS Only:</b> <b>Camel 2.9:</b> Reference to a <tt>org.apache.camel.util.jsse.SSLContextParameters</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This reference overrides any c
onfigured SSL related options on ftpClient as well as the securityProtocol (SSL, TLS, etc.) set on FtpsConfiguration.  See <a shape="rect" href="camel-configuration-utilities.html" title="Camel Configuration Utilities">Using the JSSE Configuration Utility</a>. </td></tr></tbody></table>
</div>
</div>
@@ -141,18 +137,12 @@ FTPS (also known as FTP Secure) is an ex
<p>You can configure additional options on the <tt>ftpClient</tt> and <tt>ftpClientConfig</tt> from the URI directly by using the <tt>ftpClient.</tt> or <tt>ftpClientConfig.</tt> prefix.</p>
<p>For example to set the <tt>setDataTimeout</tt> on the <tt>FTPClient</tt> to 30 seconds you can do:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from(<span class="code-quote">"ftp:<span class="code-comment">//foo@myserver?password=secret&ftpClient.dataTimeout=30000"</span>).to(<span class="code-quote">"bean:foo"</span>);</span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftp://foo@myserver?password=secret&ftpClient.dataTimeout=30000").to("bean:foo");</p></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" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from(<span class="code-quote">"ftp:<span class="code-comment">//foo@myserver?password=secret&ftpClient.dataTimeout=30000&ftpClientConfig.serverLanguageCode=fr"</span>).to(<span class="code-quote">"bean:foo"</span>);</span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftp://foo@myserver?password=secret&ftpClient.dataTimeout=30000&ftpClientConfig.serverLanguageCode=fr").to("bean:foo");</p></div>
<p>You can have as many of these options as you like.</p>
@@ -162,21 +152,15 @@ And as well for <a shape="rect" class="e
<p>If you do not like having many and long configuration in the url you can refer to the <tt>ftpClient</tt> or <tt>ftpClientConfig</tt> to use by letting Camel lookup in the <a shape="rect" href="registry.html" title="Registry">Registry</a> for it.</p>
<p>For example:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
- <bean id=<span class="code-quote">"myConfig"</span> class=<span class="code-quote">"org.apache.commons.net.ftp.FTPClientConfig"</span>>
- <property name=<span class="code-quote">"lenientFutureDates"</span> value=<span class="code-quote">"<span class="code-keyword">true</span>"</span>/>
- <property name=<span class="code-quote">"serverLanguageCode"</span> value=<span class="code-quote">"fr"</span>/>
- </bean>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p> <bean id="myConfig" class="org.apache.commons.net.ftp.FTPClientConfig"><br clear="none">
+ <property name="lenientFutureDates" value="true"/><br clear="none">
+ <property name="serverLanguageCode" value="fr"/><br clear="none">
+ </bean></p></div>
<p>And then let Camel lookup this bean when you use the # notation in the url.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from(<span class="code-quote">"ftp:<span class="code-comment">//foo@myserver?password=secret&ftpClientConfig=#myConfig"</span>).to(<span class="code-quote">"bean:foo"</span>);</span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftp://foo@myserver?password=secret&ftpClientConfig=#myConfig").to("bean:foo");</p></div>
<h3><a shape="rect" name="FTP2-MoreURIoptions"></a>More URI options</h3>
@@ -236,11 +220,8 @@ There are other solutions to avoid consu
<p>Camel will store to a local file with the same name as the remote file, though with <tt>.inprogress</tt> as extension while the file is being downloaded. Afterwards, the file is renamed to remove the <tt>.inprogress</tt> suffix. And finally, when the <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> is complete the local file is deleted.</p>
<p>So if you want to download files from a remote FTP server and store it as files then you need to route to a file endpoint such as:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from(<span class="code-quote">"ftp:<span class="code-comment">//someone@someserver.com?password=secret&localWorkDirectory=/tmp"</span>).to(<span class="code-quote">"file://inbox"</span>);</span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftp://someone@someserver.com?password=secret&localWorkDirectory=/tmp").to("file://inbox");</p></div>
<div class="panelMacro"><table class="tipMacro"><colgroup span="1"><col span="1" width="24"><col span="1"></colgroup><tr><td colspan="1" rowspan="1" valign="top"><img align="middle" src="https://cwiki.apache.org/confluence/images/icons/emoticons/check.gif" width="16" height="16" alt="" border="0"></td><td colspan="1" rowspan="1"><b>Optimization by renaming work file</b><br clear="none">The route above is ultra efficient as it avoids reading the entire file content into memory. It will download the remote file directly to a local file stream. The <tt>java.io.File</tt> handle is then used as the <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> body. The file producer leverages this fact and can work directly on the work file <tt>java.io.File</tt> handle and perform a <tt>java.io.File.rename</tt> to the target filename. As Camel knows it's a local work file, it can optimize and use a rename instead of a file copy, as the work file is meant to be deleted anyway
.</td></tr></table></div>
@@ -261,234 +242,197 @@ from(<span class="code-quote">"ftp:<span
<p>Note that stepwise changing of directory will in most cases only work when the user is confined to it's home directory and when the home directory is reported as <tt>"/"</tt>.</p>
<p>The difference between the two of them is best illustrated with an example. Suppose we have the following directory structure on the remote FTP server we need to traverse and download files:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-/
-/one
-/one/two
-/one/two/sub-a
-/one/two/sub-b
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>/<br clear="none">
+/one<br clear="none">
+/one/two<br clear="none">
+/one/two/sub-a<br clear="none">
+/one/two/sub-b</p></div>
<p>And that we have a file in each of sub-a (a.txt) and sub-b (b.txt) folder.</p>
<h4><a shape="rect" name="FTP2-Usingstepwise%3Dtrue%28defaultmode%29"></a>Using stepwise=true (default mode)</h4>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-TYPE A
-200 Type set to A
-PWD
-257 <span class="code-quote">"/"</span> is current directory.
-CWD one
-250 CWD successful. <span class="code-quote">"/one"</span> is current directory.
-CWD two
-250 CWD successful. <span class="code-quote">"/one/two"</span> is current directory.
-SYST
-215 UNIX emulated by FileZilla
-PORT 127,0,0,1,17,94
-200 Port command successful
-LIST
-150 Opening data channel <span class="code-keyword">for</span> directory list.
-226 Transfer OK
-CWD sub-a
-250 CWD successful. <span class="code-quote">"/one/two/sub-a"</span> is current directory.
-PORT 127,0,0,1,17,95
-200 Port command successful
-LIST
-150 Opening data channel <span class="code-keyword">for</span> directory list.
-226 Transfer OK
-CDUP
-200 CDUP successful. <span class="code-quote">"/one/two"</span> is current directory.
-CWD sub-b
-250 CWD successful. <span class="code-quote">"/one/two/sub-b"</span> is current directory.
-PORT 127,0,0,1,17,96
-200 Port command successful
-LIST
-150 Opening data channel <span class="code-keyword">for</span> directory list.
-226 Transfer OK
-CDUP
-200 CDUP successful. <span class="code-quote">"/one/two"</span> is current directory.
-CWD /
-250 CWD successful. <span class="code-quote">"/"</span> is current directory.
-PWD
-257 <span class="code-quote">"/"</span> is current directory.
-CWD one
-250 CWD successful. <span class="code-quote">"/one"</span> is current directory.
-CWD two
-250 CWD successful. <span class="code-quote">"/one/two"</span> is current directory.
-PORT 127,0,0,1,17,97
-200 Port command successful
-RETR foo.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-CWD /
-250 CWD successful. <span class="code-quote">"/"</span> is current directory.
-PWD
-257 <span class="code-quote">"/"</span> is current directory.
-CWD one
-250 CWD successful. <span class="code-quote">"/one"</span> is current directory.
-CWD two
-250 CWD successful. <span class="code-quote">"/one/two"</span> is current directory.
-CWD sub-a
-250 CWD successful. <span class="code-quote">"/one/two/sub-a"</span> is current directory.
-PORT 127,0,0,1,17,98
-200 Port command successful
-RETR a.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-CWD /
-250 CWD successful. <span class="code-quote">"/"</span> is current directory.
-PWD
-257 <span class="code-quote">"/"</span> is current directory.
-CWD one
-250 CWD successful. <span class="code-quote">"/one"</span> is current directory.
-CWD two
-250 CWD successful. <span class="code-quote">"/one/two"</span> is current directory.
-CWD sub-b
-250 CWD successful. <span class="code-quote">"/one/two/sub-b"</span> is current directory.
-PORT 127,0,0,1,17,99
-200 Port command successful
-RETR b.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-CWD /
-250 CWD successful. <span class="code-quote">"/"</span> is current directory.
-QUIT
-221 Goodbye
-disconnected.
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>TYPE A<br clear="none">
+200 Type set to A<br clear="none">
+PWD<br clear="none">
+257 "/" is current directory.<br clear="none">
+CWD one<br clear="none">
+250 CWD successful. "/one" is current directory.<br clear="none">
+CWD two<br clear="none">
+250 CWD successful. "/one/two" is current directory.<br clear="none">
+SYST<br clear="none">
+215 UNIX emulated by FileZilla<br clear="none">
+PORT 127,0,0,1,17,94<br clear="none">
+200 Port command successful<br clear="none">
+LIST<br clear="none">
+150 Opening data channel for directory list.<br clear="none">
+226 Transfer OK<br clear="none">
+CWD sub-a<br clear="none">
+250 CWD successful. "/one/two/sub-a" is current directory.<br clear="none">
+PORT 127,0,0,1,17,95<br clear="none">
+200 Port command successful<br clear="none">
+LIST<br clear="none">
+150 Opening data channel for directory list.<br clear="none">
+226 Transfer OK<br clear="none">
+CDUP<br clear="none">
+200 CDUP successful. "/one/two" is current directory.<br clear="none">
+CWD sub-b<br clear="none">
+250 CWD successful. "/one/two/sub-b" is current directory.<br clear="none">
+PORT 127,0,0,1,17,96<br clear="none">
+200 Port command successful<br clear="none">
+LIST<br clear="none">
+150 Opening data channel for directory list.<br clear="none">
+226 Transfer OK<br clear="none">
+CDUP<br clear="none">
+200 CDUP successful. "/one/two" is current directory.<br clear="none">
+CWD /<br clear="none">
+250 CWD successful. "/" is current directory.<br clear="none">
+PWD<br clear="none">
+257 "/" is current directory.<br clear="none">
+CWD one<br clear="none">
+250 CWD successful. "/one" is current directory.<br clear="none">
+CWD two<br clear="none">
+250 CWD successful. "/one/two" is current directory.<br clear="none">
+PORT 127,0,0,1,17,97<br clear="none">
+200 Port command successful<br clear="none">
+RETR foo.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+CWD /<br clear="none">
+250 CWD successful. "/" is current directory.<br clear="none">
+PWD<br clear="none">
+257 "/" is current directory.<br clear="none">
+CWD one<br clear="none">
+250 CWD successful. "/one" is current directory.<br clear="none">
+CWD two<br clear="none">
+250 CWD successful. "/one/two" is current directory.<br clear="none">
+CWD sub-a<br clear="none">
+250 CWD successful. "/one/two/sub-a" is current directory.<br clear="none">
+PORT 127,0,0,1,17,98<br clear="none">
+200 Port command successful<br clear="none">
+RETR a.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+CWD /<br clear="none">
+250 CWD successful. "/" is current directory.<br clear="none">
+PWD<br clear="none">
+257 "/" is current directory.<br clear="none">
+CWD one<br clear="none">
+250 CWD successful. "/one" is current directory.<br clear="none">
+CWD two<br clear="none">
+250 CWD successful. "/one/two" is current directory.<br clear="none">
+CWD sub-b<br clear="none">
+250 CWD successful. "/one/two/sub-b" is current directory.<br clear="none">
+PORT 127,0,0,1,17,99<br clear="none">
+200 Port command successful<br clear="none">
+RETR b.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+CWD /<br clear="none">
+250 CWD successful. "/" is current directory.<br clear="none">
+QUIT<br clear="none">
+221 Goodbye<br clear="none">
+disconnected.</p></div>
<p>As you can see when stepwise is enabled, it will traverse the directory structure using CD xxx.</p>
<h4><a shape="rect" name="FTP2-Usingstepwise%3Dfalse"></a>Using stepwise=false</h4>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-230 Logged on
-TYPE A
-200 Type set to A
-SYST
-215 UNIX emulated by FileZilla
-PORT 127,0,0,1,4,122
-200 Port command successful
-LIST one/two
-150 Opening data channel <span class="code-keyword">for</span> directory list
-226 Transfer OK
-PORT 127,0,0,1,4,123
-200 Port command successful
-LIST one/two/sub-a
-150 Opening data channel <span class="code-keyword">for</span> directory list
-226 Transfer OK
-PORT 127,0,0,1,4,124
-200 Port command successful
-LIST one/two/sub-b
-150 Opening data channel <span class="code-keyword">for</span> directory list
-226 Transfer OK
-PORT 127,0,0,1,4,125
-200 Port command successful
-RETR one/two/foo.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-PORT 127,0,0,1,4,126
-200 Port command successful
-RETR one/two/sub-a/a.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-PORT 127,0,0,1,4,127
-200 Port command successful
-RETR one/two/sub-b/b.txt
-150 Opening data channel <span class="code-keyword">for</span> file transfer.
-226 Transfer OK
-QUIT
-221 Goodbye
-disconnected.
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>230 Logged on<br clear="none">
+TYPE A<br clear="none">
+200 Type set to A<br clear="none">
+SYST<br clear="none">
+215 UNIX emulated by FileZilla<br clear="none">
+PORT 127,0,0,1,4,122<br clear="none">
+200 Port command successful<br clear="none">
+LIST one/two<br clear="none">
+150 Opening data channel for directory list<br clear="none">
+226 Transfer OK<br clear="none">
+PORT 127,0,0,1,4,123<br clear="none">
+200 Port command successful<br clear="none">
+LIST one/two/sub-a<br clear="none">
+150 Opening data channel for directory list<br clear="none">
+226 Transfer OK<br clear="none">
+PORT 127,0,0,1,4,124<br clear="none">
+200 Port command successful<br clear="none">
+LIST one/two/sub-b<br clear="none">
+150 Opening data channel for directory list<br clear="none">
+226 Transfer OK<br clear="none">
+PORT 127,0,0,1,4,125<br clear="none">
+200 Port command successful<br clear="none">
+RETR one/two/foo.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+PORT 127,0,0,1,4,126<br clear="none">
+200 Port command successful<br clear="none">
+RETR one/two/sub-a/a.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+PORT 127,0,0,1,4,127<br clear="none">
+200 Port command successful<br clear="none">
+RETR one/two/sub-b/b.txt<br clear="none">
+150 Opening data channel for file transfer.<br clear="none">
+226 Transfer OK<br clear="none">
+QUIT<br clear="none">
+221 Goodbye<br clear="none">
+disconnected.</p></div>
<p>As you can see when not using stepwise, there are no CD operation invoked at all.</p>
<h3><a shape="rect" name="FTP2-Samples"></a>Samples</h3>
<p>In the sample below we set up Camel to download all the reports from the FTP server once every hour (60 min) as BINARY content and store it as files on the local file system.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java"><span class="code-keyword">protected</span> RouteBuilder createRouteBuilder() <span class="code-keyword">throws</span> Exception {
- <span class="code-keyword">return</span> <span class="code-keyword">new</span> RouteBuilder() {
- <span class="code-keyword">public</span> void configure() <span class="code-keyword">throws</span> Exception {
- <span class="code-comment">// we use a delay of 60 minutes (eg. once pr. hour we poll the FTP server
-</span> <span class="code-object">long</span> delay = 60 * 60 * 1000L;
-
- <span class="code-comment">// from the given FTP server we poll (= download) all the files
-</span> <span class="code-comment">// from the <span class="code-keyword">public</span>/reports folder as BINARY types and store <span class="code-keyword">this</span> as files
-</span> <span class="code-comment">// in a local directory. Camel will use the filenames from the FTPServer
-</span>
- <span class="code-comment">// notice that the FTPConsumer properties must be prefixed with <span class="code-quote">"consumer."</span> in the URL
-</span> <span class="code-comment">// the delay parameter is from the FileConsumer component so we should use consumer.delay as
-</span> <span class="code-comment">// the URI parameter name. The FTP Component is an extension of the File Component.
-</span> from(<span class="code-quote">"ftp:<span class="code-comment">//tiger:scott@localhost/<span class="code-keyword">public</span>/reports?binary=<span class="code-keyword">true</span>&consumer.delay="</span> + delay).
-</span> to(<span class="code-quote">"file:<span class="code-comment">//target/test-reports"</span>);
-</span> }
- };
-}
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>protected RouteBuilder createRouteBuilder() throws Exception {<br clear="none">
+ return new RouteBuilder() {<br clear="none">
+ public void configure() throws Exception </p>
+<div class="error"><span class="error">Unknown macro: { // we use a delay of 60 minutes (eg. once pr. hour we poll the FTP server long delay = 60 * 60 * 1000L;
+ // from the given FTP server we poll (= download) all the files // from the public/reports folder as BINARY types and store this as files // in a local directory. Camel will use the filenames from the FTPServer
+ // notice that the FTPConsumer properties must be prefixed with "consumer." in the URL // the delay parameter is from the FileConsumer component so we should use consumer.delay as // the URI parameter name. The FTP Component is an extension of the File Component. from("ftp}</span> </div>
+<p> };<br clear="none">
+}</p></div>
<p>And the route using Spring DSL:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><route></span>
- <span class="code-tag"><from uri=<span class="code-quote">"ftp://scott@localhost/public/reports?password=tiger&amp;binary=true&amp;delay=60000"</span>/></span>
- <span class="code-tag"><to uri=<span class="code-quote">"file://target/test-reports"</span>/></span>
- <span class="code-tag"></route></span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p> <route><br clear="none">
+ <from uri="ftp://scott@localhost/public/reports?password=tiger&binary=true&delay=60000"/><br clear="none">
+ <to uri="file://target/test-reports"/><br clear="none">
+ </route></p></div>
<h4><a shape="rect" name="FTP2-ConsumingaremoteFTPSserver%28implicitSSL%29andclientauthentication"></a>Consuming a remote FTPS server (implicit SSL) and client authentication</h4>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from("ftps:<span class="code-comment">//admin@localhost:2222/<span class="code-keyword">public</span>/camel?password=admin&securityProtocol=SSL&isImplicit=<span class="code-keyword">true</span>
-</span> &ftpClient.keyStore.file=./src/test/resources/server.jks
- &ftpClient.keyStore.password=password&ftpClient.keyStore.keyPassword=password")
- .to(<span class="code-quote">"bean:foo"</span>);
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftps://admin@localhost:2222/public/camel?password=admin&securityProtocol=SSL&isImplicit=true<br clear="none">
+ &ftpClient.keyStore.file=./src/test/resources/server.jks<br clear="none">
+ &ftpClient.keyStore.password=password&ftpClient.keyStore.keyPassword=password")<br clear="none">
+ .to("bean:foo");</p></div>
<h4><a shape="rect" name="FTP2-ConsumingaremoteFTPSserver%28explicitTLS%29andacustomtruststoreconfiguration"></a>Consuming a remote FTPS server (explicit TLS) and a custom trust store configuration</h4>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java">
-from(<span class="code-quote">"ftps:<span class="code-comment">//admin@localhost:2222/<span class="code-keyword">public</span>/camel?password=admin&ftpClient.trustStore.file=./src/test/resources/server.jks&ftpClient.trustStore.password=password"</span>)
-</span> .to(<span class="code-quote">"bean:foo"</span>);
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>from("ftps://admin@localhost:2222/public/camel?password=admin&ftpClient.trustStore.file=./src/test/resources/server.jks&ftpClient.trustStore.password=password")<br clear="none">
+ .to("bean:foo");</p></div>
<h3><a shape="rect" name="FTP2-Filterusing%7B%7Borg.apache.camel.component.file.GenericFileFilter%7D%7D"></a>Filter using <tt>org.apache.camel.component.file.GenericFileFilter</tt></h3>
<p>Camel supports pluggable filtering strategies. This strategy it to use the build in <tt>org.apache.camel.component.file.GenericFileFilter</tt> in Java. You can then configure the endpoint with such a filter to skip certain filters before being processed.</p>
<p>In the sample we have built our own filter that only accepts files starting with report in the filename.</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-java"><span class="code-keyword">public</span> class MyFileFilter<T> <span class="code-keyword">implements</span> GenericFileFilter<T> {
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p>public class MyFileFilter<T> implements GenericFileFilter<T> {</p>
- <span class="code-keyword">public</span> <span class="code-object">boolean</span> accept(GenericFile<T> file) {
- <span class="code-comment">// we only want report files
-</span> <span class="code-keyword">return</span> file.getFileName().startsWith(<span class="code-quote">"report"</span>);
- }
-}
-</pre>
-</div></div>
+<p> public boolean accept(GenericFile<T> file) </p>
+<div class="error"><span class="error">Unknown macro: { // we only want report files return file.getFileName().startsWith("report"); }</span> </div>
+<p>}</p></div>
<p>And then we can configure our route using the <b>filter</b> attribute to reference our filter (using <tt>#</tt> notation) that we have defined in the spring XML file:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml">
- <span class="code-tag"><span class="code-comment"><!-- define our sorter as a plain spring bean --></span></span>
- <span class="code-tag"><bean id=<span class="code-quote">"myFilter"</span> class=<span class="code-quote">"com.mycompany.MyFileFilter"</span>/></span>
-
- <span class="code-tag"><route></span>
- <span class="code-tag"><from uri=<span class="code-quote">"ftp://someuser@someftpserver.com?password=secret&amp;filter=#myFilter"</span>/></span>
- <span class="code-tag"><to uri=<span class="code-quote">"bean:processInbox"</span>/></span>
- <span class="code-tag"></route></span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p> <!-- define our sorter as a plain spring bean --><br clear="none">
+ <bean id="myFilter" class="com.mycompany.MyFileFilter"/></p>
+
+<p> <route><br clear="none">
+ <from uri="ftp://someuser@someftpserver.com?password=secret&filter=#myFilter"/><br clear="none">
+ <to uri="bean:processInbox"/><br clear="none">
+ </route></p></div>
<h3><a shape="rect" name="FTP2-FilteringusingANTpathmatcher"></a>Filtering using ANT path matcher</h3>
@@ -501,29 +445,29 @@ The reason is that we leverage Spring's
<p>The sample below demonstrates how to use it:</p>
-<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
-<pre class="code-xml"><span class="code-tag"><bean class=<span class="code-quote">"org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"</span>/></span>
-<span class="code-tag"><camelContext xmlns=<span class="code-quote">"http://camel.apache.org/schema/spring"</span>></span>
- <span class="code-tag"><template id=<span class="code-quote">"camelTemplate"</span>/></span>
-
- <span class="code-tag"><span class="code-comment"><!-- use myFilter as filter to allow setting ANT paths for which files to scan for --></span></span>
- <span class="code-tag"><endpoint id=<span class="code-quote">"myFTPEndpoint"</span> uri=<span class="code-quote">"ftp://admin@localhost:${SpringFileAntPathMatcherRemoteFileFilterTest.ftpPort}/antpath?password=admin&amp;recursive=true&amp;delay=10000&amp;initialDelay=2000&amp;filter=#myAntFilter"</span>/></span>
-
- <span class="code-tag"><route></span>
- <span class="code-tag"><from ref=<span class="code-quote">"myFTPEndpoint"</span>/></span>
- <span class="code-tag"><to uri=<span class="code-quote">"mock:result"</span>/></span>
- <span class="code-tag"></route></span>
-<span class="code-tag"></camelContext></span>
-
-<span class="code-tag"><span class="code-comment"><!-- we use the AntPathMatcherRemoteFileFilter to use ant paths for includes and exclude --></span></span>
-<span class="code-tag"><bean id=<span class="code-quote">"myAntFilter"</span> class=<span class="code-quote">"org.apache.camel.component.file.AntPathMatcherGenericFileFilter"</span>></span>
- <span class="code-tag"><span class="code-comment"><!-- include any files in the sub folder that has day in the name --></span></span>
- <span class="code-tag"><property name=<span class="code-quote">"includes"</span> value=<span class="code-quote">"**/subfolder/**/*day*"</span>/></span>
- <span class="code-tag"><span class="code-comment"><!-- exclude all files with bad in name or .xml files. Use comma to separate multiple excludes --></span></span>
- <span class="code-tag"><property name=<span class="code-quote">"excludes"</span> value=<span class="code-quote">"**/*bad*,**/*.xml"</span>/></span>
-<span class="code-tag"></bean></span>
-</pre>
-</div></div>
+<div class="error"><span class="error">Unknown macro: {code}</span>
+<p><bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"/><br clear="none">
+<camelContext xmlns="http://camel.apache.org/schema/spring"><br clear="none">
+ <template id="camelTemplate"/></p>
+
+<p> <!-- use myFilter as filter to allow setting ANT paths for which files to scan for --><br clear="none">
+ <endpoint id="myFTPEndpoint" uri="ftp://admin@localhost:$</p>
+<div class="error"><span class="error">Unknown macro: {SpringFileAntPathMatcherRemoteFileFilterTest.ftpPort}</span> </div>
+<p>/antpath?password=admin&recursive=true&delay=10000&initialDelay=2000&filter=#myAntFilter"/></p>
+
+<p> <route><br clear="none">
+ <from ref="myFTPEndpoint"/><br clear="none">
+ <to uri="mock:result"/><br clear="none">
+ </route><br clear="none">
+</camelContext></p>
+
+<p><!-- we use the AntPathMatcherRemoteFileFilter to use ant paths for includes and exclude --><br clear="none">
+<bean id="myAntFilter" class="org.apache.camel.component.file.AntPathMatcherGenericFileFilter"><br clear="none">
+ <!-- include any files in the sub folder that has day in the name --><br clear="none">
+ <property name="includes" value="*<b>/subfolder/</b>*/<b>day</b>"/><br clear="none">
+ <!-- exclude all files with bad in name or .xml files. Use comma to separate multiple excludes --><br clear="none">
+ <property name="excludes" value="**/<b>bad</b>,*<b>/</b>.xml"/><br clear="none">
+</bean></p></div>
<h3><a shape="rect" name="FTP2-Debuglogging"></a>Debug logging</h3>
@@ -551,8 +495,8 @@ The reason is that we leverage Spring's
<h3><a shape="rect" name="Navigation-Search"></a>Search</h3>
-
-<form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+<p>
+</p><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">