Modified: websites/production/camel/content/file2.html
==============================================================================
--- websites/production/camel/content/file2.html (original)
+++ websites/production/camel/content/file2.html Mon May 11 11:20:00 2015
@@ -108,7 +108,7 @@
</div>
<h3 id="File2-URIOptions">URI Options</h3><h4
id="File2-Common">Common</h4><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>autoCreate</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Automatically create missing
directories in the file's pathname. For the file consumer, that means creating
the starting directory. For the file producer, it means the directory the files
should be written to.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>bufferSize</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>128kb</p></td><td colspan
="1" rowspan="1" class="confluenceTd"><p>Write buffer sized in
bytes.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>fileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Use <a shape="rect"
href="expression.html">Expression</a> such as <a shape="rect"
href="file-language.html">File Language</a> to dynamically set the filename.
For consumers, it's used as a filename filter. For producers, it's used to
evaluate the filename to write. If an expression is set, it take precedence
over the <code>CamelFileName</code> header. (<strong>Note:</strong> The header
itself can also be an <a shape="rect" href="expression.html">Expression</a>).
The expression options support both <code>String</code> and
<code>Expression</code> types. If the expression is a <code>String</code> type,
it is <strong>always</strong> evaluated using the <a shape="rect"
href="file-language.html"
>File Language</a>. If the expression is an <code>Expression</code> type, the
>specified <code>Expression</code> type is used - this allows you, for
>instance, to use <a shape="rect" href="ognl.html">OGNL</a> expressions. For
>the consumer, you can use it to filter filenames, so you can for instance
>consume today's file using the <a shape="rect" href="file-language.html">File
>Language</a> syntax: <code>mydata-${date:now:yyyyMMdd}.txt</code>. From
><strong>Camel 2.11</strong> onwards the producers support the
><code>CamelOverruleFileName</code> header which takes precedence over any
>existing <code>CamelFileName</code> header; the
><code>CamelOverruleFileName</code> is a header that is used only once, and
>makes it easier as this avoids to temporary store <code>CamelFileName</code>
>and have to restore it afterwards.</p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>flatten</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><
td colspan="1" rowspan="1" class="confluenceTd"><p>Flatten is used to flatten
the file name path to strip any leading paths, so it's just the file name. This
allows you to consume recursively into sub-directories, but when you eg write
the files to another directory they will be written in a single directory.
Setting this to <code>true</code> on the producer enforces that any file name
recived in <code>CamelFileName</code> header will be stripped for any leading
paths.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>charset</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong> this option
is used to specify the encoding of the file. You can use this on the consumer,
to specify the encodings of the files, which allow Camel to know the charset it
should load the file content in case the file content is being accessed.
Likewise when writing
a file, you can use this option to specify which charset to write the file as
well. See further below for a examples and more important
details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>copyAndDeleteOnRenameFail</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9</strong>:
whether to fallback and do a copy and delete file, in case the file could not
be renamed directly. This option is not available for the <a shape="rect"
href="ftp2.html">FTP</a> component.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>renameUsingCopy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13.1</strong>:
Perform rename operations using a copy and delete strategy. This is primarily
used in environments where the regular rena
me operation is unreliable (e.g. across different file systems or networks).
This option takes precedence over the <code>copyAndDeleteOnRenameFail</code>
parameter that will automatically fall back to the copy and delete strategy,
but only after additional delays.</p></td></tr></tbody></table></div></div><h4
id="File2-Consumer">Consumer</h4><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>initialDelay</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Milliseconds before polling the
file/directory starts.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceT
d"><p><code>delay</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>500</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Milliseconds before the next poll of the
file/directory.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>useFixedDelay</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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
<strong>Camel 2.7.x</strong> or older the default value is <code>false</code>.
From <strong>Camel 2.8</strong> onwards the default value is
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>runLoggingLevel</code></p></td><td colspan="1"
rowspan="1" class="c
onfluenceTd"><p><code>TRACE</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8:</strong> The consumer logs a
start/complete log line when it polls. This option allows you to configure the
logging level for that.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>recursive</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If a directory, will look for files in all
the sub-directories as well.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>delete</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>If <code>true</code>, the file will be deleted
<strong>after</strong> it is processed successfully.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>noop</code></p></td><td
colspan="1" rowspan="
1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>If <code>true</code>, 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">ETL</a> type requirements. If
<code>noop=true</code>, Camel will set <code>idempotent=true</code> as well, to
avoid consuming the same files over and over again.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>preMove</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><a shape="rect"
href="expression.html">Expression</a> (such as <a shape="rect"
href="file-language.html">File Language</a>) used to dynamically set the
filename when moving it <strong>before</strong> processing. For example to move
in-progress files into the <code>order</code> directory set this value to
<code>order</code>.</p></td></tr><tr><td colspan="
1" rowspan="1" class="confluenceTd"><p><code>move</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>.camel</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><a shape="rect"
href="expression.html">Expression</a> (such as <a shape="rect"
href="file-language.html">File Language</a>) used to dynamically set the
filename when moving it <strong>after</strong> processing. To move files into a
<code>.done</code> subdirectory just enter
<code>.done</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>moveFailed</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><a shape="rect"
href="expression.html">Expression</a> (such as <a shape="rect"
href="file-language.html">File Language</a>) used to dynamically set a
different target directory when moving files <em>in case of</em> processing
(configured via <code>move</code> defined above)
failed. For example, to move files into a <code>.error</code> subdirectory
use: <code>.error</code>. Note: When moving the files to the “fail”
location Camel will <strong>handle</strong> the error and will not pick up the
file again.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>include</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Is used to include files, if filename
matches the regex pattern.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>exclude</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Is used to exclude files, if filename
matches the regex pattern.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>antInclude</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null<
/code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.10:</strong> Ant style filter
inclusion, for example
<code>antInclude=*</code><code><strong>/</strong></code><code>.txt</code>.
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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>antExclude</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> Ant style
filter exclusion. If both <code>antInclude</code> and <code>antExclude</code>
are used, <code>antExclude</code> takes precedence over
<code>antInclude</code>. 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.</
p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>antFilterCaseSensitive</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong>
Ant style filter which is case sensitive or not.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>idempotent</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Option to use the <a shape="rect"
href="idempotent-consumer.html">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 <code>noop=true</code> then idempotent will be
enabled as well to avoid consuming the same files over and over
again.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>idempotentKey</code></p></td><td co
lspan="1" rowspan="1"
class="confluenceTd"><p><code>Expression</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> To use a
custom idempotent key. By default the absolute path of the file is used. You
can use the <a shape="rect" href="file-language.html">File Language</a>, for
example to use the file name and file size, you can do:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[idempotentKey=${file:name}-${file:size}]]></script>
-</div></div><p>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>idempotentRepository</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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 <code>MemoryMessageIdRepository</code> if none is
specified and <code>idempotent</code> is
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>inProgressRepository</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>memory</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>filter</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Pluggable filter as a
<code>org.apache.camel.component.file.GenericFileFilter</code> class. Will skip
files if filter returns <code>false</code> in its <code>accept()</code> method.
More details in section below.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>shuffle</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>false</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16:</strong> To shuffle the list of files
(sort in random order)</td></tr><tr><td colspan="1" rowspan="1" c
lass="confluenceTd"><p><code>sorter</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>sortBy</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Built-in sort using the <a shape="rect"
href="file-language.html">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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLock</code></p></td><td colspan="1"
rowspan="1" class=
"confluenceTd"><p><code>none</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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"><span> </span><code>none</code><span> is for no
read locks at all.</span> <br clear="none"><code style="line-height:
1.4285715;"> markerFile</code><span style="line-height: 1.4285715;"> Camel
creates a marker file (fileName.camelLock) and then holds a lock on it. This
option is </span><strong style="line-height: 1.4285715;">not</strong><span
style="line-height: 1.4285715;"> available for the </span><a shape="rect"
href="ftp2.html">FTP</a><span style="line-height: 1.4285715;"> component.
</span></p><p><code>changed</code> is using file length/modification timestamp
to det
ect 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
<code>readLockCheckInterval</code> can be used to set the check frequency. This
option is <strong>only</strong> avail for the <a shape="rect"
href="ftp2.html">FTP</a> component from <strong>Camel 2.8</strong> onwards.
Notice that from <strong>Camel 2.10.1</strong> onwards the <a shape="rect"
href="ftp2.html">FTP</a> option <code>fastExistsCheck</code> 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"> <code>fileLock</code> is for using
<code>java.nio.channels.FileLock</code>. This option is <strong>not</strong>
avail for the <a shape="rect" href="ftp2.html">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"> <code>rename</code> is for
using a try to rename the file as a test if we can get exclusive read-lock. <br
clear="none"><code style="line-height: 1.4285715;">idempotent</code><span
style="line-height: 1.4285715;"> <strong>Camel 2.16</strong> (only file
component) is for using a <code>idempotentRepository</code> as the read-lock.
This allows to use read locks that supports clustering if the idempotent
repository implementation supports that. </span></p><p><strong>Notice</strong>:
The various read locks is not all suited to work in clustered mode, where
concurrent consumers on different nodes is competing for the same files on a
shared file system. The markerFile using a close to atomic operation to create
the empty marker file, but its not guaranteed to work in a cluster. The fileLoc
k may work better but then the file system need to support distributed file
locks, and so on. Using the <code>idempotent</code> read lock can support
clustering if the idempotent repository supports clustering, such as <a
shape="rect" href="hazelcast-component.html">Hazelcast Component</a> or <a
shape="rect" href="infinispan.html">Infinispan</a>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockTimeout</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>10000</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>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 <strong>Camel 2.0</strong>
the default value is 0. Starting with <strong>Camel 2.1</strong>
the default value is 10000. Currently <code>fileLock</code>,
<code>changed</code> and <code>rename</code> support the timeout.
<strong>Notice:</strong> For <a shape="rect" href="ftp2.html">FTP</a> the
default <code>readLockTimeout</code> value is <code>20000</code> instead of
<code>10000</code>. The readLockTimeout value must be higher than
readLockCheckInterval, but a rule of thumb is to have a timeout that is at
least 2 or more times higher than the readLockCheckInterval. This is needed to
ensure that amble time is allowed for the read lock process to try to grab the
lock before the timeout was hit.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockCheckInterval</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong>
Interval in millis for the read-lock, if supported by the read lock. This
interval is used for sleeping between attem
pts to acquire the read lock. For example when using the <code>changed</code>
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">FTP</a> the
default <code>readLockCheckInterval</code> is <code>5000</code>. <span>The
readLockTimeout value must be higher than readLockCheckInterval, but a rule of
thumb is to have a timeout that is at least 2 or more times higher than the
readLockCheckInterval. This is needed to ensure that amble time is allowed for
the read lock process to try to grab the lock before the timeout was
hit.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockMinLength</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> This option
applied only for <code>re
adLock=changed</code>. 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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>readLockMinAge</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>0</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.15</strong>: This option applied only for
readLock=change. This options allows to specify a minimum age the file must be
before attempting to acquire the read lock. For example use readLockMinAge=300s
to require the file is at last 5 minutes old. This can speedup the changed read
lock as it will only attempt to acquire files which are at least that given
age. Notice for FTP users then file timestamps reported from FTP servers often
are only in minutes precision, so the min age check would often requires to be
reported in mi
nutes, eg 60000 for 1 minute. Notice Camel support specifying this as 60s, or
1m, etc.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockLoggingLevel</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>WARN</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockMarkerFile</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong> Whether to use
marker file with the <code>changed</code>, <code>rename</code>, or
<code>exclusive</code> read lock types. By default a m
arker file is used as well to guard against other processes picking up the
same files. This behavior can be turned off by setting this option to
<code>false</code>. For example if you do not want to write marker files to the
file systems by the Camel application.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>readLockRemoveOnRollback</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>true</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> This
option applied only for readLock=idempotent. This option allows to specify
whether to remove the file name entry from the idempotent repository when
processing the file failed and a rollback happens. If this option is false,
then the file name entry is confirmed (as if the file did a
commit).</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><span>readLockRemoveOnCommit</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>false</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
2.16:</strong><span> This option applied only for readLock=idempotent. This
option allows to specify whether to remove the file name entry from the
idempotent repository when processing the file succeeded and a commit happens.
By default the file is not removed which ensures that any race-condition do not
occur so another active node may attempt to grab the file. Instead the
idempotent repository may support eviction strategies that you can configure to
evict the file name entry after X minutes - this ensures no problems with race
conditions.</span></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>directoryMustExist</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Similar to
<code>startingDirectoryMustExist</code> but this applies during polling
recursive sub directories.</p></td
></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>doneFileName</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> 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
><strong>always</strong> expected in the same folder as the original file. See
><em>using done file</em> and <em>writing done file</em> sections for
>examples.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p><code>exclusiveReadLockStrategy</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Pluggable read-lock as a
><code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy</code>
> implementati
on.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>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">Batch Consumer</a>.
<strong>Notice:</strong> If this option is in use then the <a shape="rect"
href="file2.html">File</a> and <a shape="rect" href="ftp2.html">FTP</a>
components will limit <strong>before</strong> any sorting. For example if you
have 100000 files and use <code>maxMessagesPerPoll=500</code>, then only the
first 500 files will be picked up, and then sorted. You can use the
<code>eagerMaxMessagesPerPoll</code> option and set this
to <code>false</code> to allow to scan all files first and then sort
afterwards.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>eagerMaxMessagesPerPoll</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
Allows for controlling whether the limit from <code>maxMessagesPerPoll</code>
is eager or not. If eager then the limit is during the scanning of files. Where
as <code>false</code> would scan all files, and then perform sorting. Setting
this option to <code>false</code> 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.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>minDepth</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1"
rowspan="1" class="confluenceT
d"><p><strong>Camel 2.8</strong>: The minimum depth to start processing when
recursively processing a directory. Using <code>minDepth=1</code> means the
base directory. Using <code>minDepth=2</code> means the first sub directory.
This option is supported by <a shape="rect" href="ftp2.html">FTP</a> consumer
from <strong>Camel 2.8.2, 2.9</strong> onwards.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxDepth</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>Integer.MAX_VALUE</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> The
maximum depth to traverse when recursively processing a directory. This option
is supported by <a shape="rect" href="ftp2.html">FTP</a> consumer from
<strong>Camel 2.8.2, 2.9</strong> onwards.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code
></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>A pluggable
><code>org.apache.camel.component.file.GenericFileProcessStrategy</code>
>allowing you to implement your own <code>readLock</code> 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 <code>readLock</code> option does not apply.</p></td></tr><tr><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>startingDirectoryMustExist</code></p></td><td
>colspan="1" rowspan="1"
>class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Whether the
>starting directory must exist. Mind that the <code>autoCreate</code> option
>is default enabled, which means the starting directory is normally auto
>created if it doesn't exist. You can disable <code>autoCreate</code> and
>enable this to ensure the starting directory must exist. Wil
l thrown an exception if the directory doesn't exist.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>pollStrategy</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A pluggable
<code>org.apache.camel.spi.PollingConsumerPollStrategy</code> allowing you to
provide your custom implementation to control error handling usually occurred
during the <code>poll</code> operation <strong>before</strong> an <a
shape="rect" href="exchange.html">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 <code>WARN</code> level and ignore it.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>sendEmptyMessageWhenIdle</code></p></t
d><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.9:</strong> If the polling consumer did
not poll any files, you can enable this option to send an empty message (no
body) instead.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>consumer.bridgeErrorHandler</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
Allows for bridging the consumer to the Camel routing <a shape="rect"
href="error-handler.html">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">Error
Handler</a>. By default the consumer will use the
<code>org.apache.camel.spi.ExceptionHandler</code> to deal with exceptions,
that by d
efault 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>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>scheduledExecutorService</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong>
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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>scheduler</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> To use a
custom schedul
er to trigger the consumer to run. See more details at <a shape="rect"
href="polling-consumer.html">Polling Consumer</a>, for example there is a <a
shape="rect" href="quartz2.html">Quartz2</a>, and <a shape="rect"
href="spring.html">Spring</a> based scheduler that supports CRON
expressions.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>backoffMultiplier</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> To let the
scheduled polling consumer backoff if there has been a number of subsequent
idles/errors in a row. The multiplier is then the number of polls that will be
skipped before the next actual attempt is happening again. When this option is
in use then <code>backoffIdleThreshold</code> and/or
<code>backoffErrorThreshold</code> must also be configured. See more details at
<a shape="rect" href="polling-consumer.html">Polling Consumer</
a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>backoffIdleThreshold</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
The number of subsequent idle polls that should happen before the
<code>backoffMultipler</code> should kick-in.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>backoffErrorThreshold</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
The number of subsequent error polls (failed due some error) that should happen
before the <code>backoffMultipler</code> should kick-in.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>onCompletionExceptionHandler</code></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="co
nfluenceTd"><strong>Camel 2.16:</strong> To use a custom
<code>org.apache.camel.spi.ExceptionHandler</code> to handle any thrown
exceptions that happens during the file on completion process where the
consumer does either a commit or rollback. The default implementation will log
any exception at WARN level and
ignore.</td></tr></tbody></table></div></div><h4
id="File2-Defaultbehaviorforfileconsumer">Default behavior for file
consumer</h4><ul><li>By default the file is <strong>not</strong> locked for the
duration of the processing.</li><li>After the route has completed, files are
moved into the <code>.camel</code> subdirectory, so that they appear to be
deleted.</li><li>The File Consumer will always skip any file whose name starts
with a dot, such as <code>.</code>, <code>.camel</code>, <code>.m2</code> or
<code>.groovy</code>.</li><li>Only files (not directories) are matched for
valid filename, if options such as: <code>include</code> or
<code>exclude</code> are used.</li></ul><h4 i
d="File2-Producer">Producer</h4><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>fileExist</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>Override</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>What to do if a file already exists with
the same name. The following values can be specified:
<strong>Override</strong>, <strong>Append</strong>, <strong>Fail</strong>,
<strong>Ignore</strong>, <strong>Move</strong>, and <strong>TryRename</strong>
(Camel 2.11.1). <code>Override</code>, which is the default, replaces the
existing file. <code>Append</code> adds content to the existing file.
<code>Fail</code> throws a <code>Ge
nericFileOperationException</code>, indicating that there is already an
existing file. <code>Ignore</code> silently ignores the problem and
<strong>does not</strong> override the existing file, but assumes everything is
okay. The <code>Move</code> option requires <strong>Camel 2.10.1</strong>
onwards, and the corresponding <code>moveExisting</code> option to be
configured as well. The option <code>eagerDeleteTargetFile</code> can be used
to control what to do if an moving the file, and there exists already an
existing file, otherwise causing the move operation to fail. The
<code>Move</code> option will move any existing files, before writing the
target file. <code>TryRename</code> <strong>Camel 2.11.1</strong> is only
applicable if <code>tempFileName</code> option is in use. This allows to try
renaming the file from the temporary name to the actual name, without doing any
exists check. This check may be faster on some file systems and especially FTP
servers.</p></td></tr><tr><td col
span="1" rowspan="1"
class="confluenceTd"><p><code>tempPrefix</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>This option is used to write the file using
a temporary name and then, after the write is complete, rename it to the real
name. Can be used to identify files being written and also avoid consumers (not
using exclusive read locks) reading in progress files. Is often used by <a
shape="rect" href="ftp2.html">FTP</a> when uploading big
files.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>tempFileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.1:</strong> The
<strong>same</strong> as <code>tempPrefix</code> option but offering a more
fine grained control on the naming of the temporary filename as it uses the <a
shape="rect" href="file-langu
age.html">File Language</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>moveExisting</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> <a
shape="rect" href="expression.html">Expression</a> (such as <a shape="rect"
href="file-language.html">File Language</a>) used to compute file name to use
when <code>fileExist=Move</code> is configured. To move files into a
<code>backup</code> subdirectory just enter <code>backup</code>. This option
only supports the following <a shape="rect" href="file-language.html">File
Language</a> tokens: "file:name", "file:name.ext", "file:name.noext",
"file:onlyname", "file:onlyname.noext", "file:ext", and "file:parent". Notice
the "file:parent" is not supported by the <a shape="rect"
href="ftp2.html">FTP</a> component, as the FTP component can only move any
existing files to a relative directory based
on current dir as base.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>keepLastModified</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> Will keep the
last modified timestamp from the source file (if any). Will use the
<code>Exchange.FILE_LAST_MODIFIED</code> header to located the timestamp. This
header can contain either a <code>java.util.Date</code> or <code>long</code>
with the timestamp. If the timestamp exists and the option is enabled it will
set this timestamp on the written file. <strong>Note:</strong> This option only
applies to the <strong>file</strong> producer. You <em>cannot</em> use this
option with any of the ftp producers.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>eagerDeleteTargetFile</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
col
span="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.3:</strong>
Whether or not to eagerly delete any existing target file. This option only
applies when you use <code>fileExists=Override</code> and the
<code>tempFileName</code> option as well. You can use this to disable (set it
to false) deleting the target file before the temp file is written. For example
you may write big files and want the target file to exists during the temp file
is being written. This ensure the target file is only deleted until the very
last moment, just before the temp file is being renamed to the target filename.
From <strong>Camel 2.10.1</strong> onwards this option is also used to control
whether to delete any existing files when <code>fileExist=Move</code> is
enabled, and an existing file exists. If this option
copyAndDeleteOnRenameFailis false, then an exception will be thrown if an
existing file existed, if its true, then the existing file is deleted before
the move operation.</p></td></tr><t
r><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>doneFileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> If provided,
then Camel will write a 2nd <em>done</em> file when the original file has been
written. The <em>done</em> file will be empty. This option configures what file
name to use. Either you can specify a fixed name. Or you can use dynamic
placeholders. The <em>done</em> file will <strong>always</strong> be written in
the same folder as the original file. See <em>writing done file</em> section
for examples.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNullBody</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> Used to
specify if a null body is allowed during file writing. If set
to true then an empty file will be created, when set to false, and attempting
to send a null body to the file component, a GenericFileWriteException of
'Cannot write null body to file.' will be thrown. If the `fileExist` option is
set to 'Override', then the file will be truncated, and if set to `append` the
file will remain unchanged.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>forceWrites</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.5/2.11:</strong> Whether
to force syncing writes to the file system. You can turn this off if you do not
want this level of guarantee, for example if writing to logs / audit logs etc;
this would yield better performance.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>chmod</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan=
"1" rowspan="1" class="confluenceTd"><strong>Camel 2.15.0</strong>: Specify
the file p<span style="line-height: 1.4285715;">ermissions which is sent by the
producer</span>, the <span style="line-height: 1.4285715;">chmod value must be
between 000 and 777; If there is a leading digit like in 0755 we will ignore
it.</span></td></tr></tbody></table></div></div><h4
id="File2-Defaultbehaviorforfileproducer">Default behavior for file
producer</h4><ul><li>By default it will override any existing file, if one
exist with the same name.</li></ul><h3 id="File2-MoveandDeleteoperations">Move
and Delete operations</h3><p>Any move or delete operations is executed after
(post command) the routing has completed; so during processing of the
<code>Exchange</code> the file is still located in the inbox folder.</p><p>Lets
illustrate this with an example:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>idempotentRepository</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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 <code>MemoryMessageIdRepository</code> if none is
specified and <code>idempotent</code> is
<code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>inProgressRepository</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>memory</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>filter</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Pluggable filter as a
<code>org.apache.camel.component.file.GenericFileFilter</code> class. Will skip
files if filter returns <code>false</code> in its <code>accept()</code> method.
More details in section below.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>shuffle</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>false</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.16:</strong> To shuffle the list of files
(sort in random order)</td></tr><tr><td colspan="1" rowspan="1" c
lass="confluenceTd"><p><code>sorter</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>sortBy</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Built-in sort using the <a shape="rect"
href="file-language.html">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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLock</code></p></td><td colspan="1"
rowspan="1" class=
"confluenceTd"><p><code>none</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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"><span> </span><code>none</code><span> is for no
read locks at all.</span> <br clear="none"><code style="line-height:
1.4285715;"> markerFile</code><span style="line-height: 1.4285715;"> Camel
creates a marker file (fileName.camelLock) and then holds a lock on it. This
option is </span><strong style="line-height: 1.4285715;">not</strong><span
style="line-height: 1.4285715;"> available for the </span><a shape="rect"
href="ftp2.html">FTP</a><span style="line-height: 1.4285715;"> component.
</span></p><p><code>changed</code> is using file length/modification timestamp
to det
ect 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
<code>readLockCheckInterval</code> can be used to set the check frequency. This
option is <strong>only</strong> avail for the <a shape="rect"
href="ftp2.html">FTP</a> component from <strong>Camel 2.8</strong> onwards.
Notice that from <strong>Camel 2.10.1</strong> onwards the <a shape="rect"
href="ftp2.html">FTP</a> option <code>fastExistsCheck</code> 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"> <code>fileLock</code> is for using
<code>java.nio.channels.FileLock</code>. This option is <strong>not</strong>
avail for the <a shape="rect" href="ftp2.html">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"> <code>rename</code> is for
using a try to rename the file as a test if we can get exclusive read-lock. <br
clear="none"><code style="line-height: 1.4285715;">idempotent</code><span
style="line-height: 1.4285715;"> <strong>Camel 2.16</strong> (only file
component) is for using a <code>idempotentRepository</code> as the read-lock.
This allows to use read locks that supports clustering if the idempotent
repository implementation supports that.
</span></p><p><strong>Warning</strong>: None of the read lock strategies are
suitable for use in clustered mode. That is, you cannot have multiple consumers
attempting to read the same file in the same directory. In this case, the read
locks will not function reliably.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>rea
dLockTimeout</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>10000</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>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 <strong>Camel 2.0</strong> the default
value is 0. Starting with <strong>Camel 2.1</strong> the default value is
10000. Currently <code>fileLock</code>, <code>changed</code> and
<code>rename</code> support the timeout. <strong>Notice:</strong> For <a
shape="rect" href="ftp2.html">FTP</a> the default <code>readLockTimeout</code>
value is <code>20000</code> instead of <code>10000</code>. The readLockTimeout
value must be higher than readLockCheckInterval, but a rule of thumb is to have
a timeout that is at least 2
or more times higher than the readLockCheckInterval. This is needed to ensure
that amble time is allowed for the read lock process to try to grab the lock
before the timeout was hit.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockCheckInterval</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong>
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 <code>changed</code> 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">FTP</a> the default
<code>readLockCheckInterval</code> is <code>5000</code>. <span>The
readLockTimeout value must be higher than readLo
ckCheckInterval, but a rule of thumb is to have a timeout that is at least 2
or more times higher than the readLockCheckInterval. This is needed to ensure
that amble time is allowed for the read lock process to try to grab the lock
before the timeout was hit.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockMinLength</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>1</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> This option
applied only for <code>readLock=changed</code>. 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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>readLockMinAge</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>0</code></td><td colspan="1" rowspan=
"1" class="confluenceTd"><strong>Camel 2.15</strong>: This option applied only
for readLock=change. This options allows to specify a minimum age the file must
be before attempting to acquire the read lock. For example use
readLockMinAge=300s to require the file is at last 5 minutes old. This can
speedup the changed read lock as it will only attempt to acquire files which
are at least that given age. Notice for FTP users then file timestamps reported
from FTP servers often are only in minutes precision, so the min age check
would often requires to be reported in minutes, eg 60000 for 1 minute. Notice
Camel support specifying this as 60s, or 1m, etc.</td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>readLockLoggingLevel</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>WARN</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
Logging level used when a read lock could not be acquired. By default a WA
RN 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.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>readLockMarkerFile</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong> Whether to use
marker file with the <code>changed</code>, <code>rename</code>, or
<code>exclusive</code> read lock types. By default a marker file is used as
well to guard against other processes picking up the same files. This behavior
can be turned off by setting this option to <code>false</code>. For example if
you do not want to write marker files to the file systems by the Camel
application.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>readLockRemoveOnRollback</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>
true</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
2.16:</strong> This option applied only for readLock=idempotent. This option
allows to specify whether to remove the file name entry from the idempotent
repository when processing the file failed and a rollback happens. If this
option is false, then the file name entry is confirmed (as if the file did a
commit).</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><span>readLockRemoveOnCommit</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> This option
applied only for readLock=idempotent. This option allows to specify whether to
remove the file name entry from the idempotent repository when processing the
file succeeded and a commit happens. By default the file is not removed which
ensures that any race-condition do not occur so another active node may attempt
to grab the file. I
nstead the idempotent repository may support eviction strategies that you can
configure to evict the file name entry after X minutes - this ensures no
problems with race conditions.</span></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>directoryMustExist</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong> Similar to
<code>startingDirectoryMustExist</code> but this applies during polling
recursive sub directories.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>doneFileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> 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 <strong>always</strong>
expected in the same folder as the original file. See <em>using done file</em>
and <em>writing done file</em> sections for examples.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>exclusiveReadLockStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Pluggable read-lock as a
<code>org.apache.camel.component.file.GenericFileExclusiveReadLockStrategy</code>
implementation.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>maxMessagesPerPoll</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>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 thous
ands of files. Set a value of 0 or negative to disabled it. See more details
at <a shape="rect" href="batch-consumer.html">Batch Consumer</a>.
<strong>Notice:</strong> If this option is in use then the <a shape="rect"
href="file2.html">File</a> and <a shape="rect" href="ftp2.html">FTP</a>
components will limit <strong>before</strong> any sorting. For example if you
have 100000 files and use <code>maxMessagesPerPoll=500</code>, then only the
first 500 files will be picked up, and then sorted. You can use the
<code>eagerMaxMessagesPerPoll</code> option and set this to <code>false</code>
to allow to scan all files first and then sort afterwards.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>eagerMaxMessagesPerPoll</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.3:</strong>
Allows for controlling whether the limit from <code>maxMessagesPerPoll</
code> is eager or not. If eager then the limit is during the scanning of
files. Where as <code>false</code> would scan all files, and then perform
sorting. Setting this option to <code>false</code> 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.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>minDepth</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>0</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.8</strong>: The minimum depth to start
processing when recursively processing a directory. Using
<code>minDepth=1</code> means the base directory. Using <code>minDepth=2</code>
means the first sub directory. This option is supported by <a shape="rect"
href="ftp2.html">FTP</a> consumer from <strong>Camel 2.8.2, 2.9</strong>
onwards.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><c
ode>maxDepth</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Integer.MAX_VALUE</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> The maximum
depth to traverse when recursively processing a directory. This option is
supported by <a shape="rect" href="ftp2.html">FTP</a> consumer from
<strong>Camel 2.8.2, 2.9</strong> onwards.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>processStrategy</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>A pluggable
<code>org.apache.camel.component.file.GenericFileProcessStrategy</code>
allowing you to implement your own <code>readLock</code> 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
<code>readLock</code> option does not apply.
</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>startingDirectoryMustExist</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5:</strong>
Whether the starting directory must exist. Mind that the
<code>autoCreate</code> option is default enabled, which means the starting
directory is normally auto created if it doesn't exist. You can disable
<code>autoCreate</code> and enable this to ensure the starting directory must
exist. Will thrown an exception if the directory doesn't
exist.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>pollStrategy</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>A pluggable
<code>org.apache.camel.spi.PollingConsumerPollStrategy</code> allowing you to
provide your custom implementation to control erro
r handling usually occurred during the <code>poll</code> operation
<strong>before</strong> an <a shape="rect" href="exchange.html">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 <code>WARN</code> level and
ignore it.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>sendEmptyMessageWhenIdle</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9:</strong> If
the polling consumer did not poll any files, you can enable this option to send
an empty message (no body) instead.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>consumer.bridgeErrorHandler</code></p></td><td
colspan="1" rowspan="1" c
lass="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.10:</strong> Allows for bridging the
consumer to the Camel routing <a shape="rect" href="error-handler.html">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">Error Handler</a>. By default the
consumer will use the <code>org.apache.camel.spi.ExceptionHandler</code> 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>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>scheduledExecutorService</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td
colspan=
"1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10:</strong> 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.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>scheduler</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> To use a
custom scheduler to trigger the consumer to run. See more details at <a
shape="rect" href="polling-consumer.html">Polling Consumer</a>, for example
there is a <a shape="rect" href="quartz2.html">Quartz2</a>, and <a shape="rect"
href="spring.html">Spring</a> based scheduler that supports CRON
expressions.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>backoffMultiplier</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.12:</strong> To let the scheduled
polling consumer backoff if there has been a number of subsequent idles/errors
in a row. The multiplier is then the number of polls that will be skipped
before the next actual attempt is happening again. When this option is in use
then <code>backoffIdleThreshold</code> and/or
<code>backoffErrorThreshold</code> must also be configured. See more details at
<a shape="rect" href="polling-consumer.html">Polling
Consumer</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>backoffIdleThreshold</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
The number of subsequent idle polls that should happen before the
<code>backoffMultipler</code> should kick-in.</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>backoffErrorThreshold</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong>
The number of subsequent error polls (failed due some error) that should happen
before the <code>backoffMultipler</code> should kick-in.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>onCompletionExceptionHandler</code></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong> To use a custom
<code>org.apache.camel.spi.ExceptionHandler</code> to handle any thrown
exceptions that happens during the file on completion process where the
consumer does either a commit or rollback. The default implementation will log
any exception at WARN level and
ignore.</td></tr></tbody></table></div></div><h4
id="File2-Defaultbehaviorforfileconsumer">Default behavior for fil
e consumer</h4><ul><li>By default the file is <strong>not</strong> locked for
the duration of the processing.</li><li>After the route has completed, files
are moved into the <code>.camel</code> subdirectory, so that they appear to be
deleted.</li><li>The File Consumer will always skip any file whose name starts
with a dot, such as <code>.</code>, <code>.camel</code>, <code>.m2</code> or
<code>.groovy</code>.</li><li>Only files (not directories) are matched for
valid filename, if options such as: <code>include</code> or
<code>exclude</code> are used.</li></ul><h4
id="File2-Producer">Producer</h4><div class="confluenceTableSmall"><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>fileExist</code><
/p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>Override</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>What to do if a file already exists with
the same name. The following values can be specified:
<strong>Override</strong>, <strong>Append</strong>, <strong>Fail</strong>,
<strong>Ignore</strong>, <strong>Move</strong>, and <strong>TryRename</strong>
(Camel 2.11.1). <code>Override</code>, which is the default, replaces the
existing file. <code>Append</code> adds content to the existing file.
<code>Fail</code> throws a <code>GenericFileOperationException</code>,
indicating that there is already an existing file. <code>Ignore</code> silently
ignores the problem and <strong>does not</strong> override the existing file,
but assumes everything is okay. The <code>Move</code> option requires
<strong>Camel 2.10.1</strong> onwards, and the corresponding
<code>moveExisting</code> option to be configured as well. The option
<code>eagerDeleteTargetFile</cod
e> can be used to control what to do if an moving the file, and there exists
already an existing file, otherwise causing the move operation to fail. The
<code>Move</code> option will move any existing files, before writing the
target file. <code>TryRename</code> <strong>Camel 2.11.1</strong> is only
applicable if <code>tempFileName</code> option is in use. This allows to try
renaming the file from the temporary name to the actual name, without doing any
exists check. This check may be faster on some file systems and especially FTP
servers.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>tempPrefix</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>This option is used to write the file using
a temporary name and then, after the write is complete, rename it to the real
name. Can be used to identify files being written and also avoid consumers (not
using exclusive re
ad locks) reading in progress files. Is often used by <a shape="rect"
href="ftp2.html">FTP</a> when uploading big files.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>tempFileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.1:</strong> The
<strong>same</strong> as <code>tempPrefix</code> option but offering a more
fine grained control on the naming of the temporary filename as it uses the <a
shape="rect" href="file-language.html">File Language</a>.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>moveExisting</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> <a
shape="rect" href="expression.html">Expression</a> (such as <a shape="rect"
href="file-language.html">File Language</a>) used to co
mpute file name to use when <code>fileExist=Move</code> is configured. To move
files into a <code>backup</code> subdirectory just enter <code>backup</code>.
This option only supports the following <a shape="rect"
href="file-language.html">File Language</a> tokens: "file:name",
"file:name.ext", "file:name.noext", "file:onlyname", "file:onlyname.noext",
"file:ext", and "file:parent". Notice the "file:parent" is not supported by the
<a shape="rect" href="ftp2.html">FTP</a> component, as the FTP component can
only move any existing files to a relative directory based on current dir as
base.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>keepLastModified</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> Will keep the
last modified timestamp from the source file (if any). Will use the
<code>Exchange.FILE_LAST_MODIFIED</code> header to loca
ted the timestamp. This header can contain either a
<code>java.util.Date</code> or <code>long</code> with the timestamp. If the
timestamp exists and the option is enabled it will set this timestamp on the
written file. <strong>Note:</strong> This option only applies to the
<strong>file</strong> producer. You <em>cannot</em> use this option with any of
the ftp producers.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>eagerDeleteTargetFile</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.3:</strong>
Whether or not to eagerly delete any existing target file. This option only
applies when you use <code>fileExists=Override</code> and the
<code>tempFileName</code> option as well. You can use this to disable (set it
to false) deleting the target file before the temp file is written. For example
you may write big files and want the target file to exists
during the temp file is being written. This ensure the target file is only
deleted until the very last moment, just before the temp file is being renamed
to the target filename. From <strong>Camel 2.10.1</strong> onwards this option
is also used to control whether to delete any existing files when
<code>fileExist=Move</code> is enabled, and an existing file exists. If this
option copyAndDeleteOnRenameFailis false, then an exception will be thrown if
an existing file existed, if its true, then the existing file is deleted before
the move operation.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>doneFileName</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> If provided,
then Camel will write a 2nd <em>done</em> file when the original file has been
written. The <em>done</em> file will be empty. This option configures what file
name to u
se. Either you can specify a fixed name. Or you can use dynamic placeholders.
The <em>done</em> file will <strong>always</strong> be written in the same
folder as the original file. See <em>writing done file</em> section for
examples.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>allowNullBody</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.1:</strong> Used to
specify if a null body is allowed during file writing. If set to true then an
empty file will be created, when set to false, and attempting to send a null
body to the file component, a GenericFileWriteException of 'Cannot write null
body to file.' will be thrown. If the `fileExist` option is set to 'Override',
then the file will be truncated, and if set to `append` the file will remain
unchanged.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>forceWrites</
code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.10.5/2.11:</strong> Whether to force
syncing writes to the file system. You can turn this off if you do not want
this level of guarantee, for example if writing to logs / audit logs etc; this
would yield better performance.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>chmod</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.15.0</strong>: Specify the file p<span
style="line-height: 1.4285715;">ermissions which is sent by the
producer</span>, the <span style="line-height: 1.4285715;">chmod value must be
between 000 and 777; If there is a leading digit like in 0755 we will ignore
it.</span></td></tr></tbody></table></div></div><h4
id="File2-Defaultbehaviorforfileproducer">Default behavior for
file producer</h4><ul><li>By default it will override any existing file, if
one exist with the same name.</li></ul><h3
id="File2-MoveandDeleteoperations">Move and Delete operations</h3><p>Any move
or delete operations is executed after (post command) the routing has
completed; so during processing of the <code>Exchange</code> the file is still
located in the inbox folder.</p><p>Lets illustrate this with an
example:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[
from("file://inbox?move=.done").to("bean:handleOrder");
]]></script>
</div></div><p>When a file is dropped in the <code>inbox</code> folder, the
file consumer notices this and creates a new <code>FileExchange</code> that is
routed to the <code>handleOrder</code> bean. The bean then processes the
<code>File</code> object. At this point in time the file is still located in
the <code>inbox</code> folder. After the bean completes, and thus the route is
completed, the file consumer will perform the move operation and move the file
to the <code>.done</code> sub-folder.</p><p>The <strong>move</strong> and
<strong>preMove</strong> options is considered as a directory name (though if
you use an expression such as <a shape="rect" href="file-language.html">File
Language</a>, or <a shape="rect" href="simple.html">Simple</a> then the result
of the expression evaluation is the file name to be used - eg if you
set</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
Modified: websites/production/camel/content/raspberrypi.html
==============================================================================
--- websites/production/camel/content/raspberrypi.html (original)
+++ websites/production/camel/content/raspberrypi.html Mon May 11 11:20:00 2015
@@ -87,23 +87,22 @@
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2
id="RaspberryPi-RaspberryPi(raspberrypi)Component">Raspberry Pi (raspberrypi)
Component</h2><p><strong>Available as of Camel 2.16+ on Camel-extra-repository
(in progress, see code source paragraph below)<br
clear="none"></strong></p><p>The <strong>rbpi:</strong> component
provides Raspberry Pi based <a shape="rect"
href="https://cwiki.apache.org/confluence/display/CAMEL/Endpoint";>endpoints</a>
for consuming GPIO Event. It can generates GPIO output event<br clear="none">
The component uses the <a shape="rect" class="external-link"
href="http://pi4j.com/"; rel="nofollow">pi4j</a> library.</p><p>Maven users will
need to add the following dependency to their <code>pom.xml</code> for this
component:</p><p> </p><div class="container" title="Hint: double-click to
select code"><p> </p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
- <groupId>org.apache-extras.camel-extra</groupId>
- <artifactId>camel-raspberrypi</artifactId>
- <version>x.x.x</version>
- <!-- use the same version as your Camel core version -->
+ <groupId>com.github.camel-labs</groupId>
+ <artifactId>camel-pi4j</artifactId>
+ <version>0.0.0</version>
</dependency>]]></script>
</div></div><p> </p></div><h3 id="RaspberryPi-URIformat">URI
format</h3><p>The URI format to configure and manage PIN</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[raspberrypi://type:id?mode={output}&action={action}...
-raspberrypi:type:id[?options]]]></script>
+<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[pi4j-gpio://gpioId[?options]]]></script>
</div></div><div class="syntaxhighlighter nogutter
java"><p> </p></div><h3 id="RaspberryPi-RaspberryOption">Raspberry
Option</h3><p> </p><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">Type</th><th colspan="1" rowspan="1"
class="confluenceTh">Required</th><th colspan="1" rowspan="1"
class="confluenceTh">Enum Values</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">id</td><td colspan="1" rowspan="1"
class="confluenceTd">java.lang.String</td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">To configure the pin id (Pi4j index)</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">state</td><td colspan="1"
rowspan="1" class="confluenceTd">com.pi4j.io.gpio
.PinState</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>LOW</strong><br
clear="none">HIGH</td><td colspan="1" rowspan="1" class="confluenceTd"><p>To
configure pin state :</p><p>if DIGITAL_INPUT then it is the event trigger
state</p><p>if DIGITAL_OUTPUT then started state</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">mode</td><td colspan="1"
rowspan="1" class="confluenceTd">com.pi4j.io.gpio.PinMode</td><td colspan="1"
rowspan="1" class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>DIGITAL_OUTPUT</strong></p><p>DIGITAL_INPUT</p><p>PWM_OUTPUT</p><p>ANALOG_OUTPUT</p><p>ANALOG_INPUT</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>To configure GPIO pin
mode</p><p>Check Pi4j library for more details</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">action</td><td colspan="1" rowspan="1"
class="confluenceTd">org.apache.cam
el.component.raspberrypi.PinAction</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>TOGGLE</p><p>BUZZ</p><p>HIGH</p><p>LOW</p><p>HEADER</p></td><td
colspan="1" rowspan="1" class="confluenceTd">Default : use Body to if Action
for ouput Pin (TOGGLE, BUZZ, HIGH, LOW for digital only) (HEADER digital and
analog TODO)</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">value</td><td colspan="1" rowspan="1"
class="confluenceTd">double</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">0</td><td colspan="1" rowspan="1"
class="confluenceTd"><p>To configure the started value</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">shutdownExport</td><td colspan="1"
rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowsp
an="1" class="confluenceTd">To configure the pin shutdown
behavior</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">shutdownState</td><td colspan="1" rowspan="1"
class="confluenceTd">com.pi4j.io.gpio.PinState</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>LOW</strong><br clear="none">HIGH</td><td
colspan="1" rowspan="1" class="confluenceTd">To configure the pin state value
before exit</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">shutdownResistance</td><td colspan="1" rowspan="1"
class="confluenceTd">com.pi4j.io.gpio.PinPullResistance</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>OFF</strong><br clear="none">PULL_DOWN<br
clear="none">PULL_UP</td><td colspan="1" rowspan="1" class="confluenceTd">To
configure the pin resistance before exit</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">pullResist
ance</td><td colspan="1" rowspan="1"
class="confluenceTd">com.pi4j.io.gpio.PinPullResistance</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">OFF<br clear="none">PULL_DOWN<br
clear="none"><strong>PULL_UP</strong></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>To configure the input pull resistance,</p><p>Avoid
strange value for info <a shape="rect" class="external-link"
href="http://en.wikipedia.org/wiki/Pull-up_resistor";
rel="nofollow">http://en.wikipedia.org/wiki/Pull-up_resistor</a></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">type</td><td colspan="1"
rowspan="1"
class="confluenceTd">org.apache.camel.component.raspberrypi.RaspberryType</td><td
colspan="1" rowspan="1" class="confluenceTd">true</td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><strong>pin</strong></p><p>i2c</p><p>spi</p><p>serial</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>pin : GPIO pi4j and wiringpi
mapping,</p><p>i2c, spi, serial not yet
available</p></td></tr></tbody></table></div><p> </p><h3
id="RaspberryPi-Example:">Example :</h3><h4
id="RaspberryPi-Simplebuttonw/LEDmode">Simple button w/ LED mode</h4><p>Plug an
button on GPIO 1, and LED on GPIO 2 (with Resistor) and code a route like
this</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[public RouteBuilder createRouteBuilder()
throws Exception {
return new RouteBuilder() {
public void configure() {
-
from("raspberrypi://pin/1?mode=DIGITAL_INPUT&state=HIGH").id("rbpi-route").to("raspberrypi://pin/2?&action=TOGGLE");
+
from("pi4j-gpio://1?mode=DIGITAL_INPUT&state=HIGH").id("switch-led")
+ .to("pi4j-gpio://2?&action=TOGGLE");
}
};
}]]></script>
-</div></div><h3 id="RaspberryPi-SourceCode">Source
Code</h3><p>Camel-raspberrypi component uses pi4j and wiringpi. These
librairies are LGPL licensed and cannot be include to the official camel
repository.</p><p>Code source will be published to camel-extra repository
soon.</p><p> </p><p> </p></div>
+</div></div><h3 id="RaspberryPi-SourceCode">Source
Code</h3><p>Camel-raspberrypi component uses pi4j and wiringpi. These
librairies are LGPL licensed and cannot be include to the official camel
repository.</p><p>Code source is available at <a shape="rect"
class="external-link" href="https://github.com/camel-labs/camel-labs";
rel="nofollow">camel-iot-labs repository</a></p><p> </p><p> </p></div>
</td>
<td valign="top">
<div class="navigation">
