Modified: websites/production/camel/content/file2.html
==============================================================================
--- websites/production/camel/content/file2.html (original)
+++ websites/production/camel/content/file2.html Tue Aug 13 12:21:20 2013
@@ -128,7 +128,7 @@ Also, the starting directory must not co
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[idempotentKey=${file:name}-${file:size}]]></script>
</div></div>. </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.Ide
mpotentRepository</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>
cla
ss. </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. 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">FTP</a> o
ption <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>fileLoc
k</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" clas
s="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>readLockLoggingLevel</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>WARN</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12:</b> Logging level used when a read lock
could not be acquired. By default a WARN is logged. You can change this level,
for example to OFF to not have any logging. This option is only applicable for
readLock of types: changed, fileLock, rename. </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"
row
span="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="confluenceTd"> <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="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>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>proce
ssStrategy</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"> A
pluggable <tt>org.apache.camel.PollingConsumerPollStrategy</tt> allowing you to
provide your custom implementation 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" r
owspan="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="confluenceTd"> <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/ERR
OR 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" rowspan="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>
+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>fileLoc
k</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" clas
s="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>readLockLoggingLevel</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>WARN</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.12:</b> Logging level used when a read lock
could not be acquired. By default a WARN is logged. You can change this level,
for example to OFF to not have any logging. This option is only applicable for
readLock of types: changed, fileLock, rename. </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"
row
span="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="confluenceTd"> <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="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>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>proce
ssStrategy</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"> A
pluggable <tt>org.apache.camel.PollingConsumerPollStrategy</tt> allowing you to
provide your custom implementation 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" r
owspan="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="confluenceTd"> <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/ERR
OR 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" rowspan="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><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>scheduler</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12:</b> To use a
custom scheduler to trigger the consumer to run. See more details at <a
shape="rect" href="polling-consumer.html"
title="Polling Consumer">Polling Consumer</a>, for example there is a <a
shape="rect" href="quartz2.html" title="Quartz2">Quartz2</a> based scheduler
that supports CRON expressions. </td></tr></tbody></table>
</div>
</div>
Modified: websites/production/camel/content/polling-consumer.html
==============================================================================
--- websites/production/camel/content/polling-consumer.html (original)
+++ websites/production/camel/content/polling-consumer.html Tue Aug 13 12:21:20
2013
@@ -272,13 +272,20 @@ public static class MyCoolBean {
<div class="confluenceTableSmall"><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"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>pollStrategy</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"><ul class="alternate" type="square"><li></li></ul>
-</td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable
<tt>org.apache.camel.PollingConsumerPollingStrategy</tt> allowing you to
provide your custom implementation 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>startScheduler</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Whether
the scheduler should be auto started. </td></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 the first poll 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. </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 fixed rate
is used. See <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
rel="nofollow">ScheduledExecutorService</a> in JDK for details. 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>timeUnit</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>TimeUnit.MILLISECONDS</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> time unit for
<tt>initialDelay</tt> and <tt>delay</tt> options. </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></t
r><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" rowspan="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 consumers. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>greedy</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.10.6/2.11.1:</b> If greedy is enabled, then
the ScheduledPollConsumer will run immediately again, if the previous run
polled 1 or more messages. </td></tr></tbody></table>
+</td><td colspan="1" rowspan="1" class="confluenceTd"> A pluggable
<tt>org.apache.camel.PollingConsumerPollingStrategy</tt> allowing you to
provide your custom implementation 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>startScheduler</tt> </td><td colspan="1" rowspan="1" class="confluenceTd">
<tt>true</tt> </td><td colspan="1" rowspan="1" class="confluenceTd"> Whether
the scheduler should be auto started. </td></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 the first poll 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. </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 fixed rate
is used. See <a shape="rect" class="external-link"
href="http://java.sun.com/j2se/1.5.0/docs/api/java/util/concurrent/ScheduledExecutorService.html";
rel="nofollow">ScheduledExecutorService</a> in JDK for details. 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>timeUnit</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> <tt>TimeUnit.MILLISECONDS</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> time unit for
<tt>initialDelay</tt> and <tt>delay</tt> options. </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></t
r><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" rowspan="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 consumers. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>greedy</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>false</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <b>Camel 2.10.6/2.11.1:</b> If greedy is enabled, then
the ScheduledPollConsumer will run immediately again, if the previous run
polled 1 or more messages. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>scheduler</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1" clas
s="confluenceTd"> <b>Camel 2.12:</b> Allow to plugin a custom
<tt>org.apache.camel.spi.ScheduledPollConsumerScheduler</tt> to use as the
scheduler for firing when the polling consumer runs. The default implementation
uses the <tt>ScheduledExecutorService</tt> and there is a <a shape="rect"
href="quartz2.html" title="Quartz2">Quartz2</a> based which supports CRON
expressions. <b>Notice:</b> If using a custom scheduler then the options for
<tt>initialDelay</tt>, <tt>useFixedDelay</tt>, <tt>timeUnit</tt>, and
<tt>scheduledExecutorService</tt> may not be in use. </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>scheduler.xxx</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <b>Camel 2.12:</b> To configure
additional properties when using a custom <tt>scheduler</tt> or the <a
shape="rect" href="quartz2.html" title="Quartz2">Quartz2</a> based scheduler.
</td></tr></tbody></table>
</div>
</div>
<h3><a shape="rect"
name="PollingConsumer-Abouterrorhandlingandscheduledpollingconsumers"></a>About
error handling and scheduled polling consumers</h3>
<p><a shape="rect" class="external-link"
href="http://camel.apache.org/maven/current/camel-core/apidocs/org/apache/camel/impl/ScheduledPollConsumer.html";>ScheduledPollConsumer</a>
is scheduled based and its <tt>run</tt> method is invoked periodically based
on schedule settings. But errors can also occur when a poll is being executed.
For instance if Camel should poll a file network, and this network resource is
not available then a <tt>java.io.IOException</tt> could occur. As this error
happens <b>before</b> any <a shape="rect" href="exchange.html"
title="Exchange">Exchange</a> has been created and prepared for routing, then
the regular <a shape="rect" href="error-handling-in-camel.html" title="Error
handling in Camel">Error handling in Camel</a> does not apply. So what does the
consumer do then? Well the exception is propagated back to the <tt>run</tt>
method where its handled. Camel will by default log the exception at
<tt>WARN</tt> level and then ignore it. At next schedule the e
rror could have been resolved and thus being able to poll the endpoint
successfully.</p>
+<h3><a shape="rect" name="PollingConsumer-Usingacustomscheduler"></a>Using a
custom scheduler</h3>
+<p><b>Available as of Camel 2.12:</b></p>
+
+<p>The SPI interface
<tt>org.apache.camel.spi.ScheduledPollConsumerScheduler</tt> allows to
implement a custom scheduler to control when the <a shape="rect"
href="polling-consumer.html" title="Polling Consumer">Polling Consumer</a>
runs. The default implementation is based on the JDKs
<tt>ScheduledExecutorService</tt> with a single thread in the thread pool.
There is a CRON based implementation in the <a shape="rect" href="quartz2.html"
title="Quartz2">Quartz2</a> component.</p>
+
+<p>For an example of developing and using a custom scheduler, see the unit
test <tt>org.apache.camel.component.file.FileConsumerCustomSchedulerTest</tt>
from the source code in <tt>camel-core</tt>.</p>
+
<h4><a shape="rect"
name="PollingConsumer-ControllingtheerrorhandlingusingPollingConsumerPollStrategy"></a>Controlling
the error handling using PollingConsumerPollStrategy</h4>
<p><tt>org.apache.camel.PollingConsumerPollStrategy</tt> is a pluggable
strategy that you can configure on the <tt>ScheduledPollConsumer</tt>. The
default implementation
<tt>org.apache.camel.impl.DefaultPollingConsumerPollStrategy</tt> will log the
caused exception at <tt>WARN</tt> level and then ignore this issue.</p>
Modified: websites/production/camel/content/quartz2.html
==============================================================================
--- websites/production/camel/content/quartz2.html (original)
+++ websites/production/camel/content/quartz2.html Tue Aug 13 12:21:20 2013
@@ -74,7 +74,7 @@
<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="quartz.html">Quartz</a> > <a href="quartz2.html">Quartz2</a>
+<a href="index.html">Apache Camel</a> > <a
href="documentation.html">Documentation</a> > <a
href="components.html">Components</a> > <a
href="quartz2.html">Quartz2</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>
@@ -229,6 +229,29 @@ quartz2://groupName/timerName?cron=0+0/5
<p>The timeZone value is the values accepted by
<tt>java.util.TimeZone</tt>.</p>
+
+<h2><a shape="rect"
name="Quartz2-UsingQuartzScheduledPollConsumerScheduler"></a>Using
QuartzScheduledPollConsumerScheduler</h2>
+
+<p>The <a shape="rect" href="quartz2.html" title="Quartz2">Quartz2</a>
component provides a <a shape="rect" href="polling-consumer.html"
title="Polling Consumer">Polling Consumer</a> scheduler which allows to use
cron based scheduling for <span class="error">[Polling Consumers]</span> such
as the <a shape="rect" href="file2.html" title="File2">File</a> and <a
shape="rect" href="ftp2.html" title="FTP2">FTP</a> consumers.</p>
+
+<p>For example to use a cron based expression to poll for files every 2nd
second, then a Camel route can be define simply as:</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("file:inbox?scheduler=quartz2&scheduler.cron=0/2+*+*+*+*+?")
+ .to("bean:process");
+]]></script>
+</div></div>
+
+<p>Notice we define the <tt>scheduler=quartz2</tt> to instruct Camel to use
the <a shape="rect" href="quartz2.html" title="Quartz2">Quartz2</a> based
scheduler. Then we use <tt>scheduler.xxx</tt> options to configure the
scheduler. The <span class="error">[Quart2]</span> scheduler requires the cron
option to be set. </p>
+
+<p>The following options is supported:</p>
+
+<div class="confluenceTableSmall"><div class="table-wrap">
+<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> Parameter </th><th colspan="1" rowspan="1"
class="confluenceTh"> Default </th><th colspan="1" rowspan="1"
class="confluenceTh"> Type </th><th colspan="1" rowspan="1"
class="confluenceTh"> Description </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>quartzScheduler</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>org.quartz.Scheduler</tt> </td><td colspan="1"
rowspan="1" class="confluenceTd"> To use a custom Quartz scheduler. If none
configure then the shared scheduler from the <a shape="rect"
href="quartz2.html" title="Quartz2">Quartz2</a> component is used.
</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"> <tt>cron</tt>
</td><td colspan="1" rowspan="1" class="confluenceTd"> <tt>null</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1
" rowspan="1" class="confluenceTd"> <b>Mandatory</b>: To define the cron
expression for triggering the polls. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>triggerId</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>null</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>String</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> To specify the trigger id. If none provided then an UUID
is generated and used. </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>triggerGroup</tt> </td><td colspan="1" rowspan="1"
class="confluenceTd"> <tt>QuartzScheduledPollConsumerScheduler</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> <tt>String</tt> </td><td
colspan="1" rowspan="1" class="confluenceTd"> To specify the trigger group.
</td></tr></tbody></table>
+</div>
+</div>
+
+
<h3><a shape="rect" name="Quartz2-SeeAlso"></a>See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html" title="Configuring
Camel">Configuring Camel</a></li><li><a shape="rect" href="component.html"
title="Component">Component</a></li><li><a shape="rect" href="endpoint.html"
title="Endpoint">Endpoint</a></li><li><a shape="rect"
href="getting-started.html" title="Getting Started">Getting
Started</a></li></ul>
