Author: buildbot
Date: Thu Feb 20 07:20:12 2014
New Revision: 898608
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/file2.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/file2.html
==============================================================================
--- websites/production/camel/content/file2.html (original)
+++ websites/production/camel/content/file2.html Thu Feb 20 07:20:12 2014
@@ -138,7 +138,7 @@ Notice from <strong>Camel 2.10</strong>
</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">
-<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>
+<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>Long</code> value containing the last modified
timestamp of the file. In <strong>Camel 2.10.3 and older</strong> the type is
<code>Date</code>. </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">
<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">
