You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2014/02/03 11:19:38 UTC
svn commit: r896244 [2/2] - in /websites/production/camel/content:
cache/main.pageCache file2.html
Modified: websites/production/camel/content/file2.html
==============================================================================
--- websites/production/camel/content/file2.html (original)
+++ websites/production/camel/content/file2.html Mon Feb 3 10:19:38 2014
@@ -86,453 +86,171 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="File2-FileComponent">File Component</h2>
-
-<p>The File component provides access to file systems, allowing files to be processed by any other Camel <a shape="rect" href="components.html">Components</a> or messages from other components to be saved to disk.</p>
-
-<h3 id="File2-URIformat">URI format</h3>
-
-<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[
-file:directoryName[?options]
+<div class="wiki-content maincontent"><h2 id="File2-FileComponent">File Component</h2><p>The File component provides access to file systems, allowing files to be processed by any other Camel <a shape="rect" href="components.html">Components</a> or messages from other components to be saved to disk.</p><h3 id="File2-URIformat">URI format</h3><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[file:directoryName[?options]
]]></script>
-</div></div>
-
-<p>or</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[
-file://directoryName[?options]
+</div></div><p>or</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[file://directoryName[?options]
]]></script>
-</div></div>
-
-<p>Where <strong>directoryName</strong> represents the underlying file directory.</p>
-
-<p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p>
-
- <div class="aui-message success shadowed information-macro">
+</div></div><p>Where <strong>directoryName</strong> represents the underlying file directory.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p> <div class="aui-message success shadowed information-macro">
<p class="title">Only directories</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
-
-<p>Camel supports only endpoints configured with a starting directory. So the <strong>directoryName</strong> must be a directory.<br clear="none">
-If you want to consume a single file only, you can use the <strong>fileName</strong> option, e.g. by setting <code>fileName=thefilename</code>.<br clear="none">
-Also, the starting directory must not contain dynamic expressions with ${ } placeholders. Again use the <code>fileName</code> option to specify the dynamic part of the filename.</p>
+ <p>Camel supports only endpoints configured with a starting directory. So the <strong>directoryName</strong> must be a directory.<br clear="none"> If you want to consume a single file only, you can use the <strong>fileName</strong> option, e.g. by setting <code>fileName=thefilename</code>.<br clear="none"> Also, the starting directory must not contain dynamic expressions with ${ } placeholders. Again use the <code>fileName</code> option to specify the dynamic part of the filename.</p>
</div>
</div>
-
<div class="aui-message problem shadowed information-macro">
<p class="title">Avoid reading files currently being written by another application</p>
<span class="aui-icon icon-problem">Icon</span>
<div class="message-content">
-
-<p>Beware the JDK File IO API is a bit limited in detecting whether another application is currently writing/copying a file. And the implementation can be different depending on OS platform as well. This could lead to that Camel thinks the file is not locked by another process and start consuming it. Therefore you have to do you own investigation what suites your environment. To help with this Camel provides different <code>readLock</code> options and <code>doneFileName</code> option that you can use. See also the section <em>Consuming files from folders where others drop files directly</em>.</p>
+ <p>Beware the JDK File IO API is a bit limited in detecting whether another application is currently writing/copying a file. And the implementation can be different depending on OS platform as well. This could lead to that Camel thinks the file is not locked by another process and start consuming it. Therefore you have to do you own investigation what suites your environment. To help with this Camel provides different <code>readLock</code> options and <code>doneFileName</code> option that you can use. See also the section <em>Consuming files from folders where others drop files directly</em>.</p>
</div>
</div>
-
-
-<h3 id="File2-URIOptions">URI Options</h3>
-
-<h4 id="File2-Common">Common</h4>
-<div class="confluenceTableSmall">
+<h3 id="File2-URIOptions">URI Options</h3><h4 id="File2-Common">Common</h4><div class="confluenceTableSmall">
<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" title="Expression">Expression</a> such as <a shape="rect" href="file-language.html" title="File Language">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" title="Expression">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" title="File Language">File Language</a>. If the e
xpression 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" title="OGNL">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" title="File Language">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, and camel will set the Exchange property with <code>Exchange.CHARSET_NAME</code> with the value of this option. You can use this on the consumer, to specify the encodings of the files, whic
h 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" title="FTP2">FTP</a> component. </p></td></tr></tbody></table>
-</div>
-
-<h4 id="File2-Consumer">Consumer</h4>
-<div class="confluenceTableSmall">
+</div><h4 id="File2-Consumer">Consumer</h4><div class="confluenceTableSmall">
<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="confluenceTd"><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="confluenceTd"><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 </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" title="ETL">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" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <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" title="Expression">Expression</a> (such as <a shape="rect" href="file
-language.html" title="File Language">File Language</a>) used to dynamically set the filename when moving it <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" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">File Language</a>) used to dynamically set a different target directory when moving files after processing (configured via <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>. Mu
ltiple 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" title="Idempotent Consumer">Idempotent Consumer</a> EIP pattern to let Camel skip already processed files. Will by default use a memory based LRUCache that holds 1000 entries. If <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 colspan="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" title="File Language">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"><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" 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. </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>markerFile</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"> <code>markerFile</code> Camel creates a marker file and then holds a lock on it. This option is <strong>not</strong> available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. <br clear="none" class="atl-forced-newline"> <code>changed</code> 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 <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" title="FTP2">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" title="FTP2">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" 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"> <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" class="atl-forced-newline"> <code>none</code> is for no read locks at all. <br clear="none" class="atl-forced-newline">
+This option provides the build in strategies: <br clear="none" class="atl-forced-newline"> <code>markerFile</code> Camel creates a marker file (fileName.camelLock) and then holds a lock on it. This option is <strong>not</strong> available for the <a shape="rect" href="ftp2.html" title="FTP2">FTP</a> component. <br clear="none" class="atl-forced-newline"> <code>changed</code> 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 <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" title="FTP2">FTP</a> component from <strong>Camel 2.8</strong> onwards. Notice that from <strong>Camel 2.10.1</st
rong> onwards the <a shape="rect" href="ftp2.html" title="FTP2">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" 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"> <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" class="atl-forced-newline"> <code>none</code> is for no read locks at all. <br clear="none" class="atl-forced-newline">
Notice from <strong>Camel 2.10</strong> onwards the read locks <code>changed</code>, <code>fileLock</code> and <code>rename</code> will also use a <code>markerFile</code> 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). </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" title="FTP2">FTP</a> the default <code>readLockTimeout</code> value is <code>20000</code> instead of <code>10000</code>. </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" title="FTP2">FTP</a> the default <code>readLockCheckInterval</code> is <code>5000</code>. </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"><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>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 ca
n 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 th
at 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>. <strong>Notice:</strong> 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 <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" title="FTP2">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" title="FTP2">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, suc
h 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 pluggabl
e <code>org.apache.camel.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" 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 <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" 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" 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 <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" title="Polling Consumer">Polling Consumer</a>, for example there is a <a shape="rect" href="quartz2.html" title="Qua
rtz2">Quartz2</a>, and <a shape="rect" href="spring.html" title="Spring">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" title="Polling Consumer">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></tbody></table>
-</div>
-
-<h4 id="File2-Defaultbehaviorforfileconsumer">Default behavior for file consumer</h4>
-
-<ul><li>By default the file is 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><h4 id="File2-Defaultbehaviorforfileconsumer">Default behavior for file consumer</h4><ul><li>By default the file is 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">
<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 existin
g 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 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 read locks) reading in progress files. Is often used by <a shape="rect" href="ftp2.html" title="FTP2">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" title="File Language">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" title="Expression">Expression</a> (such as <a shape="rect" href="file-language.html" title="File Language">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" title="File Language">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" title="FTP2">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 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 is false, then an exception will be thrown if an existing file existed, if its true, then the existing file is deleted befor
e 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 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></tbody></table>
-</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");
+</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">
+</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">
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[move=../backup/copy-of-${file:name}]]></script>
-</div></div>
-<p> then that's using the <a shape="rect" href="file-language.html">File Language</a> which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed.</p>
-
-<p>By default, Camel will move consumed files to the <code>.camel</code> sub-folder relative to the directory where the file was consumed.</p>
-
-<p>If you want to delete the file after processing, the route should be:</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://inobox?delete=true").to("bean:handleOrder");
+</div></div><p>then that's using the <a shape="rect" href="file-language.html">File Language</a> which we use return the file name to be used), which can be either relative or absolute. If relative, the directory is created as a sub-folder from within the folder where the file was consumed.</p><p>By default, Camel will move consumed files to the <code>.camel</code> sub-folder relative to the directory where the file was consumed.</p><p>If you want to delete the file after processing, the route should be:</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://inobox?delete=true").to("bean:handleOrder");
]]></script>
-</div></div>
-
-<p>We have introduced a <strong>pre</strong> move operation to move files <strong>before</strong> they are processed. This allows you to mark which files have been scanned as they are moved to this sub folder before being processed.</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?preMove=inprogress").to("bean:handleOrder");
+</div></div><p>We have introduced a <strong>pre</strong> move operation to move files <strong>before</strong> they are processed. This allows you to mark which files have been scanned as they are moved to this sub folder before being processed.</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?preMove=inprogress").to("bean:handleOrder");
]]></script>
-</div></div>
-
-<p>You can combine the <strong>pre</strong> move and the regular move:</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?preMove=inprogress&move=.done").to("bean:handleOrder");
+</div></div><p>You can combine the <strong>pre</strong> move and the regular move:</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?preMove=inprogress&move=.done").to("bean:handleOrder");
]]></script>
-</div></div>
-<p>So in this situation, the file is in the <code>inprogress</code> folder when being processed and after it's processed, it's moved to the <code>.done</code> folder.</p>
-
-<h4 id="File2-FinegrainedcontroloverMoveandPreMoveoption">Fine grained control over Move and PreMove option</h4>
-
-<p>The <strong>move</strong> and <strong>preMove</strong> option is <a shape="rect" href="expression.html">Expression</a>-based, so we have the full power of the <a shape="rect" href="file-language.html">File Language</a> to do advanced configuration of the directory and name pattern.<br clear="none">
-Camel will, in fact, internally convert the directory name you enter into a <a shape="rect" href="file-language.html">File Language</a> expression. So when we enter <code>move=.done</code> Camel will convert this into: <code>${</code><code>file:parent</code><code>}/.done/${</code><code>file:onlyname</code>}. This is only done if Camel detects that you have not provided a ${ } in the option value yourself. So when you enter a ${ } Camel will <strong>not</strong> convert it and thus you have the full power.</p>
-
-<p>So if we want to move the file into a backup folder with today's date as the pattern, we 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[
-move=backup/${date:now:yyyyMMdd}/${file:name}
+</div></div><p>So in this situation, the file is in the <code>inprogress</code> folder when being processed and after it's processed, it's moved to the <code>.done</code> folder.</p><h4 id="File2-FinegrainedcontroloverMoveandPreMoveoption">Fine grained control over Move and PreMove option</h4><p>The <strong>move</strong> and <strong>preMove</strong> option is <a shape="rect" href="expression.html">Expression</a>-based, so we have the full power of the <a shape="rect" href="file-language.html">File Language</a> to do advanced configuration of the directory and name pattern.<br clear="none"> Camel will, in fact, internally convert the directory name you enter into a <a shape="rect" href="file-language.html">File Language</a> expression. So when we enter <code>move=.done</code> Camel will convert this into: <code>${</code><code>file:parent</code><code>}/.done/${</code><code>file:onlyname</code>}. This is only done if Camel detects that you have not provided a ${ } in the option value y
ourself. So when you enter a ${ } Camel will <strong>not</strong> convert it and thus you have the full power.</p><p>So if we want to move the file into a backup folder with today's date as the pattern, we 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[move=backup/${date:now:yyyyMMdd}/${file:name}
]]></script>
-</div></div>
-
-<h4 id="File2-AboutmoveFailed">About moveFailed</h4>
-
-<p>The <code>moveFailed</code> option allows you to move files that <strong>could not</strong> be processed succesfully to another location such as a error folder of your choice. For example to move the files in an error folder with a timestamp you can use <code>moveFailed=/error/${</code><code>file:name.noext</code><code>}-${date:now:yyyyMMddHHmmssSSS}.${</code><code>file:ext</code>}.</p>
-
-<p>See more examples at <a shape="rect" href="file-language.html">File Language</a></p>
-
-
-<h3 id="File2-MessageHeaders">Message Headers</h3>
-
-<p>The following headers are supported by this component:</p>
-
-<h4 id="File2-Fileproduceronly">File producer only</h4>
-<div class="confluenceTableSmall">
+</div></div><h4 id="File2-AboutmoveFailed">About moveFailed</h4><p>The <code>moveFailed</code> option allows you to move files that <strong>could not</strong> be processed succesfully to another location such as a error folder of your choice. For example to move the files in an error folder with a timestamp you can use <code>moveFailed=/error/${</code><code>file:name.noext</code><code>}-${date:now:yyyyMMddHHmmssSSS}.${</code><code>file:ext</code>}.</p><p>See more examples at <a shape="rect" href="file-language.html">File Language</a></p><h3 id="File2-MessageHeaders">Message Headers</h3><p>The following headers are supported by this component:</p><h4 id="File2-Fileproduceronly">File producer only</h4><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Header </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Specifies the name of the file to write (relative to the endpoint directory). The name can be a <code>String</code>; a <code>String</code> with a <a shape="rect" href="file-language.html" title="File Language">File Language</a> or <a shape="rect" href="simple.html" title="Simple">Simple</a> expression; or an <a shape="rect" href="expression.html" title="Expression">Expression</a> object. If it's <code>null</code> then Camel will auto-generate a filename based on the message unique ID. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileNameProduced</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The
actual absolute filepath (path + name) for the output file that was written. This header is set by Camel and its purpose is providing end-users with the name of the file that was written. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelOverruleFileName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11:</strong> Is used for overruling <code>CamelFileName</code> header and use the value instead (but only once, as the producer will remove this header after writing the file). The value can be only be a String. Notice that if the option <code>fileName</code> has been configured, then this is still being evaluated. </p></td></tr></tbody></table>
-</div>
-
-<h4 id="File2-Fileconsumeronly">File consumer only</h4>
-<div class="confluenceTableSmall">
+</div><h4 id="File2-Fileconsumeronly">File consumer only</h4><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Header </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileName</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Name of the consumed file as a relative file path with offset from the starting directory configured on the endpoint. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileNameOnly</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Only the file name (the name with no leading paths). </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileAbsolute</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A <code>boolean</code> option specifying whether the consumed file denotes an absolute path or not. Should normally be <code>false</code> for relative paths. Abso
lute paths should normally not be used but we added to the move option to allow moving files to absolute paths. But can be used elsewhere as well. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileAbsolutePath</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The absolute path to the file. For relative files this path holds the relative path instead. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFilePath</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The file path. For relative files this is the starting directory + the relative filename. For absolute files this is the absolute path. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileRelativePath</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The relative path. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileParent</code> </p></
td><td colspan="1" rowspan="1" class="confluenceTd"><p> The parent path. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileLength</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A <code>long</code> value containing the file size. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelFileLastModified</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A <code>Date</code> value containing the last modified timestamp of the file. </p></td></tr></tbody></table>
-</div>
-
-<h3 id="File2-BatchConsumer">Batch Consumer</h3>
-
-<p>This component implements the <a shape="rect" href="batch-consumer.html">Batch Consumer</a>.</p>
-
-<h4 id="File2-ExchangeProperties,fileconsumeronly">Exchange Properties, file consumer only</h4>
-
-<p>As the file consumer is <code>BatchConsumer</code> it supports batching the files it polls. By batching it means that Camel will add some properties to the <a shape="rect" href="exchange.html">Exchange</a> so you know the number of files polled the current index in that order.</p>
-<div class="confluenceTableSmall">
+</div><h3 id="File2-BatchConsumer">Batch Consumer</h3><p>This component implements the <a shape="rect" href="batch-consumer.html">Batch Consumer</a>.</p><h4 id="File2-ExchangeProperties,fileconsumeronly">Exchange Properties, file consumer only</h4><p>As the file consumer is <code>BatchConsumer</code> it supports batching the files it polls. By batching it means that Camel will add some properties to the <a shape="rect" href="exchange.html">Exchange</a> so you know the number of files polled the current index in that order.</p><div class="confluenceTableSmall">
<table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Property </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelBatchSize</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The total number of files that was polled in this batch. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelBatchIndex</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The current index of the batch. Starts from 0. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelBatchComplete</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> A <code>boolean</code> value indicating the last <a shape="rect" href="exchange.html" title="Exchange">Exchange</a> in the batch. Is only <code>true</code> for the last entry. </p></td></tr></tbody></table>
-</div>
-
-<p>This allows you for instance to know how many files exists in this batch and for instance let the <a shape="rect" href="aggregator2.html">Aggregator2</a> aggregate this number of files.</p>
-
-<h3 id="File2-Usingcharset">Using charset</h3>
-
-<p><strong>Available as of Camel 2.9.3</strong><br clear="none">
-The charset option allows for configuring an encoding of the files on both the consumer and producer endpoints. For example if you read utf-8 files, and want to convert the files to iso-8859-1, 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[
-from("file:inbox?charset=utf-8")
+</div><p>This allows you for instance to know how many files exists in this batch and for instance let the <a shape="rect" href="aggregator2.html">Aggregator2</a> aggregate this number of files.</p><h3 id="File2-Usingcharset">Using charset</h3><p><strong>Available as of Camel 2.9.3</strong><br clear="none"> The charset option allows for configuring an encoding of the files on both the consumer and producer endpoints. For example if you read utf-8 files, and want to convert the files to iso-8859-1, 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[from("file:inbox?charset=utf-8")
.to("file:outbox?charset=iso-8859-1")
]]></script>
-</div></div>
-
-<p>You can also use the <code>convertBodyTo</code> in the route. In the example below we have still input files in utf-8 format, but we want to convert the file content to a byte array in iso-8859-1 format. And then let a bean process the data. Before writing the content to the outbox folder using the current charset.</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?charset=utf-8")
+</div></div><p>You can also use the <code>convertBodyTo</code> in the route. In the example below we have still input files in utf-8 format, but we want to convert the file content to a byte array in iso-8859-1 format. And then let a bean process the data. Before writing the content to the outbox folder using the current charset.</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?charset=utf-8")
.convertBodyTo(byte[].class, "iso-8859-1")
.to("bean:myBean")
.to("file:outbox");
]]></script>
-</div></div>
-
-<p>If you omit the charset on the consumer endpoint, then Camel does not know the charset of the file, and would by default use "UTF-8". However you can configure a JVM system property to override and use a different default encoding with the key <code>org.apache.camel.default.charset</code>.</p>
-
-<p>In the example below this could be a problem if the files is not in UTF-8 encoding, which would be the default encoding for read the files.<br clear="none">
-In this example when writing the files, the content has already been converted to a byte array, and thus would write the content directly as is (without any further encodings).</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")
+</div></div><p>If you omit the charset on the consumer endpoint, then Camel does not know the charset of the file, and would by default use "UTF-8". However you can configure a JVM system property to override and use a different default encoding with the key <code>org.apache.camel.default.charset</code>.</p><p>In the example below this could be a problem if the files is not in UTF-8 encoding, which would be the default encoding for read the files.<br clear="none"> In this example when writing the files, the content has already been converted to a byte array, and thus would write the content directly as is (without any further encodings).</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")
.convertBodyTo(byte[].class, "iso-8859-1")
.to("bean:myBean")
.to("file:outbox");
]]></script>
-</div></div>
-
-<p>You can also override and control the encoding dynamic when writing files, by setting a property on the exchange with the key <code>Exchange.CHARSET_NAME</code>. For example in the route below we set the property with a value from a message header.</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")
+</div></div><p>You can also override and control the encoding dynamic when writing files, by setting a property on the exchange with the key <code>Exchange.CHARSET_NAME</code>. For example in the route below we set the property with a value from a message header.</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")
.convertBodyTo(byte[].class, "iso-8859-1")
.to("bean:myBean")
.setProperty(Exchange.CHARSET_NAME, header("someCharsetHeader"))
.to("file:outbox");
]]></script>
-</div></div>
-
-<p>We suggest to keep things simpler, so if you pickup files with the same encoding, and want to write the files in a specific encoding, then favor to use the <code>charset</code> option on the endpoints.</p>
-
-<p>Notice that if you have explicit configured a <code>charset</code> option on the endpoint, then that configuration is used, regardless of the <code>Exchange.CHARSET_NAME</code> property.</p>
-
-<p>If you have some issues then you can enable DEBUG logging on <code>org.apache.camel.component.file</code>, and Camel logs when it reads/write a file using a specific charset.<br clear="none">
-For example the route below will log the following:</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?charset=utf-8")
+</div></div><p>We suggest to keep things simpler, so if you pickup files with the same encoding, and want to write the files in a specific encoding, then favor to use the <code>charset</code> option on the endpoints.</p><p>Notice that if you have explicit configured a <code>charset</code> option on the endpoint, then that configuration is used, regardless of the <code>Exchange.CHARSET_NAME</code> property.</p><p>If you have some issues then you can enable DEBUG logging on <code>org.apache.camel.component.file</code>, and Camel logs when it reads/write a file using a specific charset.<br clear="none"> For example the route below will log the following:</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?charset=utf-8")
.to("file:outbox?charset=iso-8859-1")
]]></script>
-</div></div>
-<p>And the logs:</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[
-DEBUG GenericFileConverter - Read file /Users/davsclaus/workspace/camel/camel-core/target/charset/input/input.txt with charset utf-8
+</div></div><p>And the logs:</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[DEBUG GenericFileConverter - Read file /Users/davsclaus/workspace/camel/camel-core/target/charset/input/input.txt with charset utf-8
DEBUG FileOperations - Using Reader to write file: target/charset/output.txt with charset: iso-8859-1
]]></script>
-</div></div>
-
-<h3 id="File2-Commongotchaswithfolderandfilenames">Common gotchas with folder and filenames</h3>
-
-<p>When Camel is producing files (writing files) there are a few gotchas affecting how to set a filename of your choice. By default, Camel will use the message ID as the filename, and since the message ID is normally a unique generated ID, you will end up with filenames such as: <code>ID-MACHINENAME-2443-1211718892437-1-0</code>. If such a filename is not desired, then you must provide a filename in the <code>CamelFileName</code> message header. The constant, <code>Exchange.FILE_NAME</code>, can also be used.</p>
-
-<p>The sample code below produces files using the message ID as the filename:</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("direct:report").to("file:target/reports");
+</div></div><h3 id="File2-Commongotchaswithfolderandfilenames">Common gotchas with folder and filenames</h3><p>When Camel is producing files (writing files) there are a few gotchas affecting how to set a filename of your choice. By default, Camel will use the message ID as the filename, and since the message ID is normally a unique generated ID, you will end up with filenames such as: <code>ID-MACHINENAME-2443-1211718892437-1-0</code>. If such a filename is not desired, then you must provide a filename in the <code>CamelFileName</code> message header. The constant, <code>Exchange.FILE_NAME</code>, can also be used.</p><p>The sample code below produces files using the message ID as the filename:</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("direct:report").to("file:target/reports");
]]></script>
-</div></div>
-<p>To use <code>report.txt</code> as the filename you have to 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[
-from("direct:report").setHeader(Exchange.FILE_NAME, constant("report.txt")).to( "file:target/reports");
+</div></div><p>To use <code>report.txt</code> as the filename you have to 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[from("direct:report").setHeader(Exchange.FILE_NAME, constant("report.txt")).to( "file:target/reports");
]]></script>
-</div></div>
-<p>... the same as above, but with <code>CamelFileName</code>:</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("direct:report").setHeader("CamelFileName", constant("report.txt")).to( "file:target/reports");
+</div></div><p>... the same as above, but with <code>CamelFileName</code>:</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("direct:report").setHeader("CamelFileName", constant("report.txt")).to( "file:target/reports");
]]></script>
-</div></div>
-<p>And a syntax where we set the filename on the endpoint with the <strong>fileName</strong> URI option.</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("direct:report").to("file:target/reports/?fileName=report.txt");
+</div></div><p>And a syntax where we set the filename on the endpoint with the <strong>fileName</strong> URI option.</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("direct:report").to("file:target/reports/?fileName=report.txt");
]]></script>
-</div></div>
-
-<h3 id="File2-FilenameExpression">Filename Expression</h3>
-
-<p>Filename can be set either using the <strong>expression</strong> option or as a string-based <a shape="rect" href="file-language.html">File Language</a> expression in the <code>CamelFileName</code> header. See the <a shape="rect" href="file-language.html">File Language</a> for syntax and samples.</p>
-
-<h3 id="File2-Consumingfilesfromfolderswhereothersdropfilesdirectly">Consuming files from folders where others drop files directly</h3>
-
-<p>Beware if you consume files from a folder where other applications write files directly. Take a look at the different <code>readLock</code> options to see what suits your use cases. The best approach is however to write to another folder and after the write move the file in the drop folder. However if you write files directly to the drop folder then the option <code>changed</code> could better detect whether a file is currently being written/copied as it uses a file changed algorithm to see whether the file size / modification changes over a period of time. The other read lock options rely on Java File API that sadly is not always very good at detecting this. You may also want to look at the <code>doneFileName</code> option, which uses a marker file (done) to signal when a file is done and ready to be consumed.</p>
-
-
-<h3 id="File2-Usingdonefiles">Using done files</h3>
-
-<p><strong>Available as of Camel 2.6</strong></p>
-
-<p>See also section <em>writing done files</em> below.</p>
-
-<p>If you want only to consume files when a done file exists, then you can use the <code>doneFileName</code> option on the endpoint.</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:bar?doneFileName=done");
+</div></div><h3 id="File2-FilenameExpression">Filename Expression</h3><p>Filename can be set either using the <strong>expression</strong> option or as a string-based <a shape="rect" href="file-language.html">File Language</a> expression in the <code>CamelFileName</code> header. See the <a shape="rect" href="file-language.html">File Language</a> for syntax and samples.</p><h3 id="File2-Consumingfilesfromfolderswhereothersdropfilesdirectly">Consuming files from folders where others drop files directly</h3><p>Beware if you consume files from a folder where other applications write files directly. Take a look at the different <code>readLock</code> options to see what suits your use cases. The best approach is however to write to another folder and after the write move the file in the drop folder. However if you write files directly to the drop folder then the option <code>changed</code> could better detect whether a file is currently being written/copied as it uses a file changed algori
thm to see whether the file size / modification changes over a period of time. The other read lock options rely on Java File API that sadly is not always very good at detecting this. You may also want to look at the <code>doneFileName</code> option, which uses a marker file (done) to signal when a file is done and ready to be consumed.</p><h3 id="File2-Usingdonefiles">Using done files</h3><p><strong>Available as of Camel 2.6</strong></p><p>See also section <em>writing done files</em> below.</p><p>If you want only to consume files when a done file exists, then you can use the <code>doneFileName</code> option on the endpoint.</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:bar?doneFileName=done");
]]></script>
-</div></div>
-<p>Will only consume files from the bar folder, if a file name done exists in the same directory as the target files. Camel will automatically delete the done file when it's done consuming the files. From Camel <strong>2.9.3</strong> onwards Camel will not automatic delete the done file if <code>noop=true</code> is configured.</p>
-
-<p>However its more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the <code>doneFileName</code> option. Currently Camel supports the following two dynamic tokens: <code>file:name</code> and <code>file:name.noext</code> which must be enclosed in ${ }. The consumer only supports the static part of the done file name as either prefix or suffix (not both).</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:bar?doneFileName=${file:name}.done");
+</div></div><p>Will only consume files from the bar folder, if a file name done exists in the same directory as the target files. Camel will automatically delete the done file when it's done consuming the files. From Camel <strong>2.9.3</strong> onwards Camel will not automatic delete the done file if <code>noop=true</code> is configured.</p><p>However its more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the <code>doneFileName</code> option. Currently Camel supports the following two dynamic tokens: <code>file:name</code> and <code>file:name.noext</code> which must be enclosed in ${ }. The consumer only supports the static part of the done file name as either prefix or suffix (not both).</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:bar?doneFileName=${file:name}.done");
]]></script>
-</div></div>
-
-<p>In this example only files will be polled if there exists a done file with the name <em>file name</em>.done. For example</p>
-<ul class="alternate"><li><code>hello.txt</code> - is the file to be consumed</li><li><code>hello.txt.done</code> - is the associated done file</li></ul>
-
-
-<p>You can also use a prefix for the done file, such as:</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:bar?doneFileName=ready-${file:name}");
+</div></div><p>In this example only files will be polled if there exists a done file with the name <em>file name</em>.done. For example</p><ul class="alternate"><li><code>hello.txt</code> - is the file to be consumed</li><li><code>hello.txt.done</code> - is the associated done file</li></ul><p>You can also use a prefix for the done file, such as:</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:bar?doneFileName=ready-${file:name}");
]]></script>
-</div></div>
-<ul class="alternate"><li><code>hello.txt</code> - is the file to be consumed</li><li><code>ready-hello.txt</code> - is the associated done file</li></ul>
-
-
-
-
-<h3 id="File2-Writingdonefiles">Writing done files</h3>
-
-<p><strong>Available as of Camel 2.6</strong></p>
-
-<p>After you have written af file you may want to write an additional <em>done</em> file as a kinda of marker, to indicate to others that the file is finished and has been written. To do that you can use the <code>doneFileName</code> option on the file producer endpoint.</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[
-.to("file:bar?doneFileName=done");
+</div></div><ul class="alternate"><li><code>hello.txt</code> - is the file to be consumed</li><li><code>ready-hello.txt</code> - is the associated done file</li></ul><h3 id="File2-Writingdonefiles">Writing done files</h3><p><strong>Available as of Camel 2.6</strong></p><p>After you have written af file you may want to write an additional <em>done</em> file as a kinda of marker, to indicate to others that the file is finished and has been written. To do that you can use the <code>doneFileName</code> option on the file producer endpoint.</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[.to("file:bar?doneFileName=done");
]]></script>
-</div></div>
-<p>Will simply create a file named <code>done</code> in the same directory as the target file.</p>
-
-<p>However its more common to have one done file per target file. This means there is a 1:1 correlation. To do this you must use dynamic placeholders in the <code>doneFileName</code> option. Currently Camel supports the following two dynamic tokens: <code>file:name</code> and <code>file:name.noext</code> which must be enclosed in ${ }.</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[
-.to("file:bar?doneFileName=done-${file:name}");
[... 630 lines stripped ...]