Update docs

Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/a97655dd
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/a97655dd
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/a97655dd

Branch: refs/heads/master
Commit: a97655ddde949ebbbf78e9263f19a115d183a126
Parents: ee8eca8
Author: Claus Ibsen <davscl...@apache.org>
Authored: Wed Aug 3 10:02:12 2016 +0200
Committer: Claus Ibsen <davscl...@apache.org>
Committed: Wed Aug 3 11:43:09 2016 +0200

----------------------------------------------------------------------
 components/camel-ftp/src/main/docs/ftp.adoc | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/camel/blob/a97655dd/components/camel-ftp/src/main/docs/ftp.adoc
----------------------------------------------------------------------
diff --git a/components/camel-ftp/src/main/docs/ftp.adoc 
b/components/camel-ftp/src/main/docs/ftp.adoc
index c34451a..28be641 100644
--- a/components/camel-ftp/src/main/docs/ftp.adoc
+++ b/components/camel-ftp/src/main/docs/ftp.adoc
@@ -116,6 +116,7 @@ The FTP component has no options.
 
 
 
+
 // endpoint options: START
 The FTP component supports 103 endpoint options which are listed below:
 
@@ -130,7 +131,7 @@ The FTP component supports 103 endpoint options which are 
listed below:
 | charset | common |  | String | This option is used to specify the encoding 
of the file. You can use this on the consumer to specify the encodings of the 
files which allow Camel to know the charset it should load the file content in 
case the file content is being accessed. Likewise when writing a file you can 
use this option to specify which charset to write the file as well.
 | disconnect | common | false | boolean | Whether or not to disconnect from 
remote FTP server right after use. Disconnect will only disconnect the current 
connection to the FTP server. If you have a consumer which you want to stop 
then you need to stop the consumer/route instead.
 | disconnectOnBatchComplete | common | false | boolean | Whether or not to 
disconnect from remote FTP server right after a Batch is complete. 
disconnectOnBatchComplete will only disconnect the current connection to the 
FTP server. If you have a consumer which you want to stop then you need to stop 
the consumer/route instead.
-| doneFileName | common |  | String | If provided then Camel will write a 2nd 
done file when the original file has been written. The done file will be empty. 
This option configures what file name to use. Either you can specify a fixed 
name. Or you can use dynamic placeholders. The done file will always be written 
in the same folder as the original file. Only $file.name and $file.name.noext 
is supported as dynamic placeholders.
+| doneFileName | common |  | String | Producer: If provided then Camel will 
write a 2nd done file when the original file has been written. The done file 
will be empty. This option configures what file name to use. Either you can 
specify a fixed name. Or you can use dynamic placeholders. The done file will 
always be written in the same folder as the original file. Consumer: If 
provided Camel will only consume files if a done file exists. This option 
configures what file name to use. Either you can specify a fixed name. Or you 
can use dynamic placeholders.The done file is always expected in the same 
folder as the original file. Only $file.name and $file.name.noext is supported 
as dynamic placeholders.
 | download | common | false | boolean | Whether the FTP consumer should 
download the file. If this option is set to false then the message body will be 
null but the consumer will still trigger a Camel Exchange that has details 
about the file such as file name file size etc. It's just that the file will 
not be downloaded.
 | fastExistsCheck | common | false | boolean | If set this option to be true 
camel-ftp will use the list file directly to check if the file exists. Since 
some FTP server may not support to list the file directly if the option is 
false camel-ftp will use the old way to list the directory and check if the 
file exists. This option also influences readLock=changed to control whether it 
performs a fast check to update file information or not. This can be used to 
speed up the process if the FTP server has a lot of files.
 | fileName | common |  | String | Use Expression such as File Language to 
dynamically set the filename. For consumers it's used as a filename filter. For 
producers it's used to evaluate the filename to write. If an expression is set 
it take precedence over the CamelFileName header. (Note: The header itself can 
also be an Expression). The expression options support both String and 
Expression types. If the expression is a String type it is always evaluated 
using the File Language. If the expression is an Expression type the specified 
Expression type is used - this allows you for instance to use OGNL expressions. 
For the consumer you can use it to filter filenames so you can for instance 
consume today's file using the File Language syntax: 
mydata-$date:now:yyyyMMdd.txt. The producers support the CamelOverruleFileName 
header which takes precedence over any existing CamelFileName header; the 
CamelOverruleFileName is a header that is used only once and makes it easier as 
this avoids to te
 mporary store CamelFileName and have to restore it afterwards.
@@ -237,6 +238,7 @@ The FTP component supports 103 endpoint options which are 
listed below:
 
 
 
+
 [Info]
 ====
 FTPS component default trust store

Reply via email to