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 2012/08/16 13:19:41 UTC
svn commit: r829093 [3/3] - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
camel-2110-release.html file2.html ftp2.html
Modified: websites/production/camel/content/file2.html
==============================================================================
--- websites/production/camel/content/file2.html (original)
+++ websites/production/camel/content/file2.html Thu Aug 16 11:19:40 2012
@@ -115,8 +115,8 @@ Also, the starting directory must not co
<h4><a shape="rect" name="File2-Consumer"></a>Consumer</h4>
<div class="confluenceTableSmall"><div class="table-wrap">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"> Name </th><th colspan="1" rowspan="1" class="confluenceTh"> Default Value </th><th colspan="1" rowspan="1" class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>initialDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before polling the file/directory starts. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>500</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Milliseconds before the next poll of the file/directory. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>useFixedDelay</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"> Controls if fixed delay or fix
ed rate is used. See <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html" rel="nofollow">ScheduledExecutorService</a> in JDK for details. In <b>Camel 2.7.x</b> or older the default value is <tt>false</tt>. From <b>Camel 2.8</b> onwards the default value is <tt>true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>runLoggingLevel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>TRACE</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>recursive</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If a directory, will look for files in all the sub-directories as well.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>delete</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>true</tt>, the file will be deleted <b>after</b> it is processed </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>noop</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> If <tt>true</tt>, the file is not moved or deleted in any way. This option is good for readonly data, or for <a shape="rect" href="etl.html" title="ETL">ETL</a> type requirements. If <tt>noop=true</tt>, Camel will set <tt>idempotent=true</tt> as well, to avoid consuming the same files over and over again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>preMove</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceT
d"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <b>before</b> processing. For example to move in-progress files into the <tt>order</tt> directory set this value to <tt>order</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>move</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>.camel</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <b>after</b> processing. To move files into a <tt>.done</tt> subdirectory just enter <tt>.done</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>moveFailed</tt> </td><td colspan="1" rowspan="
1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <a shape="rect" href="expression.html" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set a different target directory when moving files after processing (configured via <tt>move</tt> defined above) failed. For example, to move files into a <tt>.error</tt> subdirectory use: <tt>.error</tt>. Note: When moving the files to the “fail” location Camel will <b>handle</b> the error and will not pick up the file again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>include</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Is used to include files, if filename matches the regex pattern. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>exclude</tt> </td><td colspan="
1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Is used to exclude files, if filename matches the regex pattern. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>antInclude</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Ant style filter inclusion, for example <tt>antInclude=*</tt><tt><b>/</b></tt><tt>.txt</tt>. Multiple inclusions may be specified in comma-delimited format. See <a shape="rect" href="#File2-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>antExclude</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Ant style filter exclusion. If both <tt>antInclude</tt> and <tt>antExclude</tt> are used, <tt
>antExclude</tt> takes precedence over <tt>antInclude</tt>. Multiple exclusions may be specified in comma-delimited format. See <a shape="rect" href="#File2-FilteringusingANTpathmatcher">below</a> for more details about ant path filters. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>idempotent</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Option to use the <a shape="rect" href="idempotent-consumer.html" title="Idempotent Consumer">Idempotent Consumer</a> EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If <tt>noop=true</tt> then idempotent will be enabled as well to avoid consuming the same files over and over again. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>idempotentRepository</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> A pluggable repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a> which by default use <tt>MemoryMessageIdRepository</tt> if none is specified and <tt>idempotent</tt> is <tt>true</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>inProgressRepository</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>memory</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable in-progress repository <a shape="rect" class="external-link" href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/spi/IdempotentRepository.html">org.apache.camel.spi.IdempotentRepository</a>. The in-progress repository is used to account the current in progress files being consumed. By default a memory based repository is used. </td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd"> <tt>filter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable filter as a <tt>org.apache.camel.component.file.GenericFileFilter</tt> class. Will skip files if filter returns <tt>false</tt> in its <tt>accept()</tt> method. More details in section below. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sorter</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable sorter as a <a shape="rect" class="external-link" href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/Comparator.html" rel="nofollow">java.util.Comparator<org.apache.camel.component.file.GenericFile></a> class. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sortBy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan
="1" class="confluenceTd"> Built-in sort using the <a shape="rect" href="file-language.html" title="File Language">File Language</a>. Supports nested sorts, so you can have a sort by file name and as a 2nd group sort by modified date. See sorting section below for details. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLock</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>markerFile</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Used by consumer, to only poll the files if it has exclusive read-lock on the file (i.e. the file is not in-progress or being written). Camel will wait until the file lock is granted. <br clear="none" class="atl-forced-newline">
-This option provides the build in strategies: <br clear="none" class="atl-forced-newline"> <tt>markerFile</tt> Camel creates a marker file and then holds a lock on it. This option is <b>not</b> available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. <br clear="none" class="atl-forced-newline"> <tt>changed</tt> is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec. to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. This option is <b>only</b> avail for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component from <b>Camel 2.8</b> onwards. <br clear="none" class="atl-forced-newline"> <tt>fileLock</tt> is for using <tt>java.nio.channels.FileLock</tt>. This option is <b>not</b> avail for the <a shape="rect" href="ft
p2.html" title="FTP2">FTP</a> component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. <br clear="none" class="atl-forced-newline"> <tt>rename</tt> is for using a try to rename the file as a test if we can get exclusive read-lock. <br clear="none" class="atl-forced-newline"> <tt>none</tt> is for no read locks at all. <br clear="none" class="atl-forced-newline">
-Notice from <b>Camel 2.10</b> onwards the read locks <tt>changed</tt>, <tt>fileLock</tt> and <tt>rename</tt> will also use a <tt>markerFile</tt> as well, to ensure not picking up files that may be in process by another Camel consumer running on another node (eg cluster). This is only supported by the file component (not the ftp component). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>10000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. In <b>Camel 2.0</b> the default value is 0. Starting with <b>Camel 2.1</b> the default value is 10000. Currently <tt
>fileLock</tt>, <tt>changed</tt> and <tt>rename</tt> support the timeout. <b>Notice:</b> For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockTimeout</tt> value is <tt>20000</tt> instead of <tt>10000</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockCheckInterval</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the <tt>changed</tt> read lock, you can set a higher interval period to cater for <em>slow writes</em>. The default of 1 sec. may be <em>too fast</em> if the producer is very slow writing the file. For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockCheckInterval</tt> is <tt>5000</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>readLockMinLength</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.1:</b> This option applied only for <tt>readLock=changed</tt>. This options allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>directoryMustExist</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> Similar to <tt>startingDirectoryMustExist</tt> but this applies during polling recursive sub directories. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>doneFileName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1
" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> If provided, Camel will only consume files if a <em>done</em> file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The <em>done</em> file is <b>always</b> expected in the same folder as the original file. See <em>using done file</em> and <em>writing done file</em> sections for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>exclusiveReadLockStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable read-lock as a <tt>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy</tt> implementation. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> An integer t
o define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. See more details at <a shape="rect" href="batch-consumer.html" title="Batch Consumer">Batch Consumer</a>. <b>Notice:</b> If this option is in use then the <a shape="rect" href="file2.html" title="File2">File</a> and <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> components will limit <b>before</b> any sorting. For example if you have 100000 files and use <tt>maxMessagesPerPoll=500</tt>, then only the first 500 files will be picked up, and then sorted. You can use the <tt>eagerMaxMessagesPerPoll</tt> option and set this to <tt>false</tt> to allow to scan all files first and then sort afterwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>eagerMaxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluen
ceTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9.3:</b> Allows for controlling whether the limit from <tt>maxMessagesPerPoll</tt> is eager or not. If eager then the limit is during the scanning of files. Where as <tt>false</tt> would scan all files, and then perform sorting. Setting this option to <tt>false</tt> allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>minDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8</b>: The minimum depth to start processing when recursively processing a directory. Using <tt>minDepth=1</tt> means the base directory. Using <tt>minDepth=2</tt> means the first sub directory. This option is supported by <a shape="rect" href="ftp2.html" title="FT
P2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>Integer.MAX_VALUE</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> The maximum depth to traverse when recursively processing a directory. This option is supported by <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>processStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable <tt>org.apache.camel.component.file.GenericFileProcessStrategy</tt> allowing you to implement your own <tt>readLock</tt> option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special <em>ready</em> file exists
. If this option is set then the <tt>readLock</tt> option does not apply. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>startingDirectoryMustExist</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 the starting directory must exist. Mind that the <tt>autoCreate</tt> option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable <tt>autoCreate</tt> and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>pollStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.0:</b> A pluggable <tt>org.apache.camel.PollingConsumerPollStrategy</tt> allowing you to provide your custom imp
lementation to control error handling usually occurred during the <tt>poll</tt> operation <b>before</b> an <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at <tt>WARN</tt> level and ignore it. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sendEmptyMessageWhenIdle</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9:</b> If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.bridgeErrorHandler</tt> </td><td colspan="1" rowspan="1" class="confl
uenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for bridging the consumer to the Camel routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>, which mean any exceptions occurred while trying to pickup files, or the likes, will now be processed as a message and handled by the routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>. By default the consumer will use the <tt>org.apache.camel.spi.ExceptionHandler</tt> to deal with exceptions, that by default will be logged at WARN/ERROR level and ignored. See further below on this page fore more details, at section <em>How to use the Camel error handler to deal with exceptions triggered outside the routing engine</em>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>scheduledExecutorService</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" r
owspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple file consumers. </td></tr></tbody></table>
+This option provides the build in strategies: <br clear="none" class="atl-forced-newline"> <tt>markerFile</tt> Camel creates a marker file and then holds a lock on it. This option is <b>not</b> available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. <br clear="none" class="atl-forced-newline"> <tt>changed</tt> is using file length/modification timestamp to detect whether the file is currently being copied or not. Will at least use 1 sec. to determine this, so this option cannot consume files as fast as the others, but can be more reliable as the JDK IO API cannot always determine whether a file is currently being used by another process. The option <tt>readLockCheckInterval</tt> can be used to set the check frequency. This option is <b>only</b> avail for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component from <b>Camel 2.8</b> onwards. Notice that from <b>Camel 2.10.1</b> onwards the <a shape="rect" href="ftp2.html" title="FTP2">F
TP</a> option <tt>fastExistsCheck</tt> can be enabled to speedup this readLock strategy, if the FTP server support the LIST operation with a full file name (some servers may not). <br clear="none" class="atl-forced-newline"> <tt>fileLock</tt> is for using <tt>java.nio.channels.FileLock</tt>. This option is <b>not</b> avail for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. This approach should be avoided when accessing a remote file system via a mount/share unless that file system supports distributed file locks. <br clear="none" class="atl-forced-newline"> <tt>rename</tt> is for using a try to rename the file as a test if we can get exclusive read-lock. <br clear="none" class="atl-forced-newline"> <tt>none</tt> is for no read locks at all. <br clear="none" class="atl-forced-newline">
+Notice from <b>Camel 2.10</b> onwards the read locks <tt>changed</tt>, <tt>fileLock</tt> and <tt>rename</tt> will also use a <tt>markerFile</tt> as well, to ensure not picking up files that may be in process by another Camel consumer running on another node (eg cluster). This is only supported by the file component (not the ftp component). </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockTimeout</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>10000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Optional timeout in millis for the read-lock, if supported by the read-lock. If the read-lock could not be granted and the timeout triggered, then Camel will skip the file. At next poll Camel, will try the file again, and this time maybe the read-lock could be granted. Use a value of 0 or lower to indicate forever. In <b>Camel 2.0</b> the default value is 0. Starting with <b>Camel 2.1</b> the default value is 10000. Currently <tt
>fileLock</tt>, <tt>changed</tt> and <tt>rename</tt> support the timeout. <b>Notice:</b> For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockTimeout</tt> value is <tt>20000</tt> instead of <tt>10000</tt>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>readLockCheckInterval</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1000</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> Interval in millis for the read-lock, if supported by the read lock. This interval is used for sleeping between attempts to acquire the read lock. For example when using the <tt>changed</tt> read lock, you can set a higher interval period to cater for <em>slow writes</em>. The default of 1 sec. may be <em>too fast</em> if the producer is very slow writing the file. For <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> the default <tt>readLockCheckInterval</tt> is <tt>5000</tt>. </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>readLockMinLength</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>1</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10.1:</b> This option applied only for <tt>readLock=changed</tt>. This option allows you to configure a minimum file length. By default Camel expects the file to contain data, and thus the default value is 1. You can set this option to zero, to allow consuming zero-length files. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>directoryMustExist</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> Similar to <tt>startingDirectoryMustExist</tt> but this applies during polling recursive sub directories. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>doneFileName</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <b>Camel 2.6:</b> If provided, Camel will only consume files if a <em>done</em> file exists. This option configures what file name to use. Either you can specify a fixed name. Or you can use dynamic placeholders. The <em>done</em> file is <b>always</b> expected in the same folder as the original file. See <em>using done file</em> and <em>writing done file</em> sections for examples. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>exclusiveReadLockStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Pluggable read-lock as a <tt>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy</tt> implementation. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>0</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> An integer to
define a maximum messages to gather per poll. By default no maximum is set. Can be used to set a limit of e.g. 1000 to avoid when starting up the server that there are thousands of files. Set a value of 0 or negative to disabled it. See more details at <a shape="rect" href="batch-consumer.html" title="Batch Consumer">Batch Consumer</a>. <b>Notice:</b> If this option is in use then the <a shape="rect" href="file2.html" title="File2">File</a> and <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> components will limit <b>before</b> any sorting. For example if you have 100000 files and use <tt>maxMessagesPerPoll=500</tt>, then only the first 500 files will be picked up, and then sorted. You can use the <tt>eagerMaxMessagesPerPoll</tt> option and set this to <tt>false</tt> to allow to scan all files first and then sort afterwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>eagerMaxMessagesPerPoll</tt> </td><td colspan="1" rowspan="1" class="confluenc
eTd"> <tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9.3:</b> Allows for controlling whether the limit from <tt>maxMessagesPerPoll</tt> is eager or not. If eager then the limit is during the scanning of files. Where as <tt>false</tt> would scan all files, and then perform sorting. Setting this option to <tt>false</tt> allows for sorting all files first, and then limit the poll. Mind that this requires a higher memory usage as all file details are in memory to perform the sorting. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>minDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> 0 </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8</b>: The minimum depth to start processing when recursively processing a directory. Using <tt>minDepth=1</tt> means the base directory. Using <tt>minDepth=2</tt> means the first sub directory. This option is supported by <a shape="rect" href="ftp2.html" title="FTP
2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>maxDepth</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>Integer.MAX_VALUE</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.8:</b> The maximum depth to traverse when recursively processing a directory. This option is supported by <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> consumer from <b>Camel 2.8.2, 2.9</b> onwards. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>processStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable <tt>org.apache.camel.component.file.GenericFileProcessStrategy</tt> allowing you to implement your own <tt>readLock</tt> option or similar. Can also be used when special conditions must be met before a file can be consumed, such as a special <em>ready</em> file exists.
If this option is set then the <tt>readLock</tt> option does not apply. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>startingDirectoryMustExist</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 the starting directory must exist. Mind that the <tt>autoCreate</tt> option is default enabled, which means the starting directory is normally auto created if it doesn't exist. You can disable <tt>autoCreate</tt> and enable this to ensure the starting directory must exist. Will thrown an exception if the directory doesn't exist. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>pollStrategy</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.0:</b> A pluggable <tt>org.apache.camel.PollingConsumerPollStrategy</tt> allowing you to provide your custom impl
ementation to control error handling usually occurred during the <tt>poll</tt> operation <b>before</b> an <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> have been created and being routed in Camel. In other words the error occurred while the polling was gathering information, for instance access to a file network failed so Camel cannot access it to scan for files. The default implementation will log the caused exception at <tt>WARN</tt> level and ignore it. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>sendEmptyMessageWhenIdle</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.9:</b> If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>consumer.bridgeErrorHandler</tt> </td><td colspan="1" rowspan="1" class="conflu
enceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for bridging the consumer to the Camel routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>, which mean any exceptions occurred while trying to pickup files, or the likes, will now be processed as a message and handled by the routing <a shape="rect" href="error-handler.html" title="Error Handler">Error Handler</a>. By default the consumer will use the <tt>org.apache.camel.spi.ExceptionHandler</tt> to deal with exceptions, that by default will be logged at WARN/ERROR level and ignored. See further below on this page fore more details, at section <em>How to use the Camel error handler to deal with exceptions triggered outside the routing engine</em>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>scheduledExecutorService</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td colspan="1" ro
wspan="1" class="confluenceTd"> <b>Camel 2.10:</b> Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. This option allows you to share a thread pool among multiple file consumers. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/ftp2.html
==============================================================================
--- websites/production/camel/content/ftp2.html (original)
+++ websites/production/camel/content/ftp2.html Thu Aug 16 11:19:40 2012
@@ -133,7 +133,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. </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" rowspa
n="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 co
lspan="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 On
ly:</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>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><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.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>ftp
Client.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 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>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. Notice from <b>Camel 2.10.1</b> onwards this options also influence <tt>readLock=changed</tt> to control
whether it performs a fast check to update file information, or not. This can be used to speedup 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 o
r 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 c
olspan="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> Yo
u 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 sto
re 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</t
t> </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 pass
word. </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>
</div>
</div>