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/09/13 16:24:17 UTC
svn commit: r878288 [2/3] - in /websites/production/camel/content: ./ cache/
Added: websites/production/camel/content/facebook.html
==============================================================================
--- websites/production/camel/content/facebook.html (added)
+++ websites/production/camel/content/facebook.html Fri Sep 13 14:24:17 2013
@@ -0,0 +1,317 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<html>
+<head>
+ <link href="http://camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+ <link href="http://camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+ <script src="http://camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+ <script src="http://camel.apache.org/styles/rico.js" type="text/javascript"></script>
+ <script src="http://camel.apache.org/styles/site.js" type="text/javascript"></script>
+
+ <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
+
+ <style type="text/css">
+ .maincontent { overflow:hidden; }
+ </style>
+ <!--[if IE]>
+ <style type="text/css">
+ .maincontent { width:100%; }
+ </style>
+ <![endif]-->
+
+
+ <link href='http://camel.apache.org/styles/highlighter/styles/shCoreCamel.css' rel='stylesheet' type='text/css' />
+ <link href='http://camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet' type='text/css' />
+ <script src='http://camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
+ <script src='http://camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+
+ <script type="text/javascript">
+ SyntaxHighlighter.defaults['toolbar'] = false;
+ SyntaxHighlighter.all();
+ </script>
+
+ <title>
+ Apache Camel: Facebook
+ </title>
+</head>
+<body>
+<div class="white_box">
+<div class="header">
+ <div class="header_l">
+ <div class="header_r">
+ </div>
+ </div>
+</div>
+<div class="content">
+ <div class="content_l">
+ <div class="content_r">
+ <div>
+ <!-- Banner -->
+<div id="banner-content"><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>
+ </div>
+ </div></div>
+ <!-- Banner -->
+ <div class="top_red_bar">
+ <div id="site-breadcrumbs">
+ <!-- Breadcrumbs -->
+<a href="index.html">Apache Camel</a> > <a href="documentation.html">Documentation</a> > <a href="components.html">Components</a> > <a href="facebook.html">Facebook</a>
+ </div>
+ <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html" title="Download">Download</a> | <a shape="rect" href="javadoc.html" title="JavaDoc">JavaDoc</a> | <a shape="rect" href="source.html" title="Source">Source</a> | <a shape="rect" href="discussion-forums.html" title="Discussion Forums">Forums</a> | <a shape="rect" href="support.html" title="Support">Support</a></p></div>
+ <!-- Quicklinks -->
+ </div>
+
+ <table border="0">
+ <tbody>
+ <tr>
+ <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2><a shape="rect" name="Facebook-FacebookComponent"></a>Facebook Component</h2>
+
+<p><b>Available as of Camel 2.12</b></p>
+
+<p>The Facebook component provides access to all of the Facebook APIs accessible using <a shape="rect" class="external-link" href="http://facebook4j.org/en/index.html" rel="nofollow">Facebook4J</a>. It allows producing messages to retrieve, add, and delete posts, likes, comments, photos, albums, videos, photos, checkins, locations, links, etc. It also supports APIs that allow polling for posts, users, checkins, groups, locations, etc. </p>
+
+<p>Facebook requires the use of OAuth for all client application authentication. In order to use camel-facebook with your account, you'll need to create a new application within Facebook at <a shape="rect" class="external-link" href="https://developers.facebook.com/apps" rel="nofollow">https://developers.facebook.com/apps</a> and grant the application access to your account. The Facebook application's id and secret will allow access to Facebook APIs which do not require a current user. A user access token is required for APIs that require a logged in user. More information on obtaining a user access token can be found at <a shape="rect" class="external-link" href="https://developers.facebook.com/docs/facebook-login/access-tokens/" rel="nofollow">https://developers.facebook.com/docs/facebook-login/access-tokens/</a>.</p>
+
+<p>Maven users will need to add the following dependency to their pom.xml for this component:</p>
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-facebook</artifactId>
+ <version>${camel-version}</version>
+ </dependency>
+]]></script>
+</div></div>
+
+<h3><a shape="rect" name="Facebook-URIformat"></a>URI format </h3>
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ facebook://[endpoint]?[options]
+]]></script>
+</div></div>
+
+<h3><a shape="rect" name="Facebook-FacebookComponent"></a>FacebookComponent</h3>
+
+<p>The facebook component can be configured with the Facebook account settings below, which are mandatory. The values can be provided to the component using the bean property <b>configuration</b> of type <b>org.apache.camel.component.facebook.config.FacebookConfiguration</b>. The <b>oAuthAccessToken</b> option may be ommited but that will only allow access to application APIs. </p>
+
+<p>You can also configure these options directly in an endpoint URI. </p>
+
+<div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Option </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthAppId </td><td colspan="1" rowspan="1" class="confluenceTd"> The application Id </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthAppSecret </td><td colspan="1" rowspan="1" class="confluenceTd"> The application Secret </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthAccessToken </td><td colspan="1" rowspan="1" class="confluenceTd"> The user access token </td></tr></tbody></table>
+</div>
+
+
+<p>In addition to the above settings, non-mandatory options below can be used to configure the underlying Facebook4J runtime through either the component's <b>configuration</b> property or in an endpoint URI. </p>
+
+<div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Option </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthAuthorizationURL </td><td colspan="1" rowspan="1" class="confluenceTd"> OAuth authorization URL </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" class="external-link" href="https://www.facebook.com/dialog/oauth" rel="nofollow">https://www.facebook.com/dialog/oauth</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthPermissions </td><td colspan="1" rowspan="1" class="confluenceTd"> Default OAuth permissions. Comma separeted permission names. See
+<a shape="rect" class="external-link" href="https://developers.facebook.com/docs/reference/login/#permissions" rel="nofollow">https://developers.facebook.com/docs/reference/login/#permissions</a>
+<p> for the detail </p></td><td colspan="1" rowspan="1" class="confluenceTd"> null </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> oAuthAccessTokenURL </td><td colspan="1" rowspan="1" class="confluenceTd"> OAuth access token URL </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" class="external-link" href="https://graph.facebook.com/oauth/access_token" rel="nofollow">https://graph.facebook.com/oauth/access_token</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> debugEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> Enables deubg output. Effective only with the embedded logger </td><td colspan="1" rowspan="1" class="confluenceTd"> false
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> gzipEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> Use Facebook GZIP encoding </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpConnectionTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> Http connection timeout in milliseconds </td><td colspan="1" rowspan="1" class="confluenceTd"> 20000 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpDefaultMaxPerRoute </td><td colspan="1" rowspan="1" class="confluenceTd"> HT
TP maximum connections per route </td><td colspan="1" rowspan="1" class="confluenceTd"> 2 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpMaxTotalConnections </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP maximum total connections </td><td colspan="1" rowspan="1" class="confluenceTd"> 20 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpProxyHost </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP proxy server host name </td><td colspan="1" rowspan="1" class="confluenceT
d"> null </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpProxyPassword </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP proxy server password </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpProxyPort </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP proxy server port </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpProxyUser </td><td colspan="1" rowspan="1" class="conflu
enceTd"> HTTP proxy server user name </td><td colspan="1" rowspan="1" class="confluenceTd"> null </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpReadTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> Http read timeout in milliseconds </td><td colspan="1" rowspan="1" class="confluenceTd"> 120000 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpRetryCount </td><td colspan="1" rowspan="1" class="confluenceTd"> Number of HTTP retries </td><td colspan="1" rowspan="1" class="
confluenceTd"> 0 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpRetryIntervalSeconds </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP retry interval in seconds </td><td colspan="1" rowspan="1" class="confluenceTd"> 5 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> httpStreamingReadTimeout </td><td colspan="1" rowspan="1" class="confluenceTd"> HTTP streaming read timeout in milliseconds </td><td colspan="1" rowspan="1" class="confluenceTd"> 40000 </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> jsonStoreEnabled </td><td colspan="1" rowspan="1" cl
ass="confluenceTd"> If set to true, raw JSON forms will be stored in DataObjectFactory </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> mbeanEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> If set to true, Facebook4J mbean will be registerd </td><td colspan="1" rowspan="1" class="confluenceTd"> false </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> prettyDebugEnabled </td><td colspan="1" rowspan="1" class="confluenceTd"> prettify JSON debug output if set to true </td><td colspan="1" rowspan=
"1" class="confluenceTd"> false </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> restBaseURL </td><td colspan="1" rowspan="1" class="confluenceTd"> API base URL </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" class="external-link" href="https://graph.facebook.com/" rel="nofollow">https://graph.facebook.com/</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> useSSL </td><td colspan="1" rowspan="1" class="confluenceTd"> Use SSL </td><td colspan="1" rowspan="1" class="confluenceTd"> true </td></tr><tr><td col
span="1" rowspan="1" class="confluenceTd"> videoBaseURL </td><td colspan="1" rowspan="1" class="confluenceTd"> Video API base URL </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" class="external-link" href="https://graph-video.facebook.com/" rel="nofollow">https://graph-video.facebook.com/</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> clientURL </td><td colspan="1" rowspan="1" class="confluenceTd"> Facebook4J API client URL </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" class="external-link" href="http://facebook4j.org/en/facebook4j-<version>.xml" rel="nofollow">http://facebook4j.org/en/facebook4j-&lt;version&gt
;.xml</a> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> clientVersion </td><td colspan="1" rowspan="1" class="confluenceTd"> Facebook4J client API version </td><td colspan="1" rowspan="1" class="confluenceTd"> 1.1.12 </td></tr></tbody></table>
+</div>
+
+
+<h3><a shape="rect" name="Facebook-ProducerEndpoints%3A"></a>Producer Endpoints: </h3>
+
+<p>Producer endpoints can use endpoint names and options from the table below. Endpoints can also use the short name without the <b>get</b> or <b>search</b> prefix, except <b>checkin</b> due to ambiguity between <b>getCheckin</b> and <b>searchCheckin</b>. Endpoint options that are not mandatory are denoted by []. </p>
+
+<p>Producer endpoints can also use a special option *<b>inBody</b>* that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message. For example, the facebook endpoint in the following route retrieves activities for the user id value in the incoming message body.</p>
+
+<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
+ from("direct:test").to("facebook://activities?inBody=userId")...
+]]></script>
+</div></div>
+
+<p>Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format <b>CamelFacebook.<span class="error">[option]</span></b>. For example, the <b>userId</b> option value in the previous route could alternately be provided in the message header <b>CamelFacebook.userId</b>. Note that the inBody option overrides message header, e.g. the endpoint option <b>inBody=user</b> would override a <b>CamelFacebook.userId</b> header. </p>
+
+<p>Endpoints that return a String return an Id for the created or modified entity, e.g. <b>addAlbumPhoto</b> returns the new album Id. Endpoints that return a boolean, return true for success and false otherwise. In case of Facebook API errors the endpoint will throw a RuntimeCamelException with a facebook4j.FacebookException cause. </p>
+
+<div class="table-wrap">
[... 169 lines stripped ...]
Modified: websites/production/camel/content/ftp.html
==============================================================================
--- websites/production/camel/content/ftp.html (original)
+++ websites/production/camel/content/ftp.html Fri Sep 13 14:24:17 2013
@@ -141,7 +141,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 th
e <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>keyPair</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.12.0:</b> Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys. </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="confluen
ceTd"> <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="confluenceTd"> <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>preferredAuthentications</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.10.7, 2.11.2,2.12.0:</b> 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. </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 no
t 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="con
fluenceTd"> <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. </t
d></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="con
fluenceTd"> <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. Stepw
ise 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>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="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><t
r><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="conflue
nceTd"> <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.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.keyStor
e.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 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><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>proxy
</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.10.7, 2.11.1:</b> Reference to a <tt>com.jcraft.jsch.Proxy</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This proxy is used to consume/send messages from the target SFTP host. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>useList</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP/FTPS Only:</b> <b>Camel 2.12.1:</b> Whether the consumer should use FTP LIST command to retrieve directory listing to see which files exists. If this option is set to <tt>false</tt>, then <tt>stepwise=false</tt> must be configured, and also <tt>fileName</tt> must be configured to a fixed name, so the consumer knows the name of the file to retrieve. When doing this only that sing
le file can be retrieved. See further below for more details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreFileNotFound</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP/FTPS Only:</b> <b>Camel 2.12.1:</b> Whether the consumer should ignore when a file was attempted to be retrieved but did not exist (for some reason). </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 th
e <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>keyPair</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.12.0:</b> Sets the Java KeyPair for SSH public key authentication, it supports DSA or RSA keys. </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="confluen
ceTd"> <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="confluenceTd"> <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>preferredAuthentications</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.10.7, 2.11.2,2.12.0:</b> 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. </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 no
t 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="con
fluenceTd"> <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. </t
d></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="con
fluenceTd"> <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. Stepw
ise 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>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="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><t
r><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="conflue
nceTd"> <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.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.keyStor
e.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 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><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>proxy
</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.10.7, 2.11.1:</b> Reference to a <tt>com.jcraft.jsch.Proxy</tt> in the <a shape="rect" class="external-link" href="http://camel.apache.org/registry.html">Registry</a>.  This proxy is used to consume/send messages from the target SFTP host. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>useList</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>FTP/FTPS Only:</b> <b>Camel 2.12.1:</b> Whether the consumer should use FTP LIST command to retrieve directory listing to see which files exists. If this option is set to <tt>false</tt>, then <tt>stepwise=false</tt> must be configured, and also <tt>fileName</tt> must be configured to a fixed name, so the consumer knows the name of the file to retrieve. When doing this only that sing
le file can be retrieved. See further below for more details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>ignoreFileNotFoundOrPermissionError</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12.1:</b> 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. </td></tr></tbody></table>
</div>
</div>
@@ -562,12 +562,12 @@ The reason is that we leverage Spring's
<h3><a shape="rect" name="FTP-Consumingasinglefileusingafixedname"></a>Consuming a single file using a fixed name</h3>
-<p>When you want to download a single file and knows the file name, you can use <tt>fileName=myFileName.txt</tt> to tell Camel the name of the file to download. By default the consumer will still do a FTP LIST command to do a directory listing and then filter these files based on the <tt>fileName</tt> option. Though in this use-case it may be desirable to turn off the directory listing by setting <tt>useList=false</tt>. For example the user account used to login to the FTP server may not have permission to do a FTP LIST command. So you can turn off this with <tt>useList=false</tt>, and then provide the fixed name of the file to download with <tt>fileName=myFileName.txt</tt>, then the FTP consumer can still download the file. If the file for some reason does not exist, then Camel will by default throw an exception, you can turn this off and ignore this by setting <tt>ignoreFileNotFound=true</tt>.</p>
+<p>When you want to download a single file and knows the file name, you can use <tt>fileName=myFileName.txt</tt> to tell Camel the name of the file to download. By default the consumer will still do a FTP LIST command to do a directory listing and then filter these files based on the <tt>fileName</tt> option. Though in this use-case it may be desirable to turn off the directory listing by setting <tt>useList=false</tt>. For example the user account used to login to the FTP server may not have permission to do a FTP LIST command. So you can turn off this with <tt>useList=false</tt>, and then provide the fixed name of the file to download with <tt>fileName=myFileName.txt</tt>, then the FTP consumer can still download the file. If the file for some reason does not exist, then Camel will by default throw an exception, you can turn this off and ignore this by setting <tt>ignoreFileNotFoundOrPermissionError=true</tt>.</p>
<p>For example to have a Camel route that pickup a single file, and delete it after use you can do</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-from("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFound=true&fileName=report.txt&delete=true")
+from("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true")
.to("activemq:queue:report");
]]></script>
</div></div>
@@ -578,7 +578,7 @@ from("ftp://admin@localhost:21/nolist/?p
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-String data = template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFound=true&fileName=report.txt&delete=true", String.class);
+String data = template.retrieveBodyNoWait("ftp://admin@localhost:21/nolist/?password=admin&stepwise=false&useList=false&ignoreFileNotFoundOrPermissionError=true&fileName=report.txt&delete=true", String.class);
]]></script>
</div></div>