Author: buildbot
Date: Mon Dec 1 15:19:57 2014
New Revision: 931176
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-dataformat-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/csv.html
Modified: websites/production/camel/content/book-dataformat-appendix.html
==============================================================================
--- websites/production/camel/content/book-dataformat-appendix.html (original)
+++ websites/production/camel/content/book-dataformat-appendix.html Mon Dec 1
15:19:57 2014
@@ -425,7 +425,12 @@ from("direct:marshal").
</camelContext>
]]></script>
</div></div>
-<h2 id="BookDataFormatAppendix-CSV">CSV</h2><p>The CSV <a shape="rect"
href="data-format.html">Data Format</a> uses <a shape="rect"
class="external-link"
href="http://commons.apache.org/proper/commons-csv/";>Apache Commons CSV</a> to
handle CSV payloads (Comma Separated Values) such as those exported/imported by
Excel.</p><h3 id="BookDataFormatAppendix-Options">Options</h3><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>config</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>CSVConfig</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Can be used to set a custom <code>CSVConfig</code>
object.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>strategy</p></td><td colsp
an="1" rowspan="1" class="confluenceTd"><p>CSVStrategy</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Can be used to set a custom
<code>CSVStrategy</code>; the default is
<code>CSVStrategy.DEFAULT_STRATEGY</code>.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>autogenColumns</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Whether or not columns are auto-generated in the
resulting CSV. The default value is <code>true</code>; subsequent messages use
the previously created columns with new fields being added at the end of the
line.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>delimiter</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.4:</strong> The column delimiter to
use; the default value is "<code>,</code>".</p></td></tr><tr><td colspan="1"
rowspan="1"
class="confluenceTd"><p>skipFirstLine</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.10:</strong> Whether or not to skip the
first line of CSV input when unmarshalling (e.g. if the content has headers on
the first line); the default value is <code>false</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">lazyLoad</td><td colspan="1"
rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.12.2:</strong><span><span> Whether or
not to </span></span><span style="line-height: 1.4285715;">Sequential access
CSV input through an iterator which could avoid OOM exception when processing
huge CSV file; </span><span>the default value is false </span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">useMaps</td><td colspan="1"
rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1"
class="co
nfluenceTd"><strong>Camel 2.13:</strong> Whether to use List<Map> when
unmarshalling instead of List<List>.</td></tr></tbody></table></div><h3
id="BookDataFormatAppendix-MarshallingaMaptoCSV">Marshalling a Map to
CSV</h3><p>The component allows you to marshal a Java Map (or any other message
type that can be <a shape="rect" href="type-converter.html">converted</a> in a
Map) into a CSV payload.</p><p>An example: if you send a message with this
map...</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<h2 id="BookDataFormatAppendix-CSV">CSV</h2><p>The CSV <a shape="rect"
href="data-format.html">Data Format</a> uses <a shape="rect"
class="external-link"
href="http://commons.apache.org/proper/commons-csv/";>Apache Commons CSV</a> to
handle CSV payloads (Comma Separated Values) such as those exported/imported by
Excel.</p><p>As of Camel 2.15.0, it now uses the <a shape="rect"
class="external-link"
href="http://commons.apache.org/proper/commons-csv/archives/1.1/index.html";>Apache
Commons CSV 1.1</a> which is based on a completely different set of
options.</p><h3
id="BookDataFormatAppendix-AvailableoptionsuntilCamel2.15">Available options
until Camel 2.15</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"
><p>config</p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>CSVConfig</p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>Can be used to set a custom <code>CSVConfig</code>
>object.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p>strategy</p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>CSVStrategy</p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>Can be used to set a custom <code>CSVStrategy</code>;
>the default is
><code>CSVStrategy.DEFAULT_STRATEGY</code>.</p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p>autogenColumns</p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>Whether or not columns are auto-generated
>in the resulting CSV. The default value is <code>true</code>; subsequent
>messages use the previously created columns with new fields being added at
>the end of the line.</p></td></tr><tr><td colspan="1" rowspan="1" class="
confluenceTd"><p>delimiter</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>String</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.4:</strong> The column delimiter to
use; the default value is "<code>,</code>".</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>skipFirstLine</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>boolean</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.10:</strong> Whether or not to skip the
first line of CSV input when unmarshalling (e.g. if the content has headers on
the first line); the default value is <code>false</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">lazyLoad</td><td colspan="1"
rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.12.2:</strong><span><span> Whether or
not to </span></span><span style="line-height: 1.4285715;">Sequential access
CSV input through
an iterator which could avoid OOM exception when processing huge CSV file;
</span><span>the default value is false </span></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">useMaps</td><td colspan="1" rowspan="1"
class="confluenceTd">boolean</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Camel 2.13:</strong> Whether to use
List<Map> when unmarshalling instead of
List<List>.</td></tr></tbody></table></div><h3
id="BookDataFormatAppendix-AvailableoptionsasofCamel2.15">Available options as
of Camel 2.15</h3><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Option</th><th colspan="1" rowspan="1"
class="confluenceTh">Type</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>format</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>CSVFormat</code></td><td colspan="1" rowspan="1"
class="confluen
ceTd">The reference format to use, it will be updated with the other format
options, the default value is <code>CSVFormat.DEFAULT</code></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>formatName</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>String</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Used in order to initialize the
reference format using the name of one of the default formats.</p><p>The
possible values are: <code>"DEFAULT"</code>, <code>"RFC4180"</code>,
<code>"EXCEL"</code>, <code>"TDF"</code>,
<code>"MYSQL"</code></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>commentMarker</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>Character</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Overrides the comment marker of the reference
format.</p><p>This option is <code>null</code> by default. When
<code>null</code> it keeps the value of the reference format which is <co
de>null</code> for <code>CSVFormat.DEFAULT</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>delimiter</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>Character</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Overrides the delimiter of the
reference format.</p><p>This option is <code>null</code> by defaut. <span>When
</span><code>null</code><span> it keeps the value of the reference format which
is </span><code>','</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>escapeDisabled</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Disables the escape character of the
reference format.</p><p>This option is <code>false</code> by
default.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>escape</code></td><td colspan="1" rowspan="
1" class="confluenceTd"><code>Character</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Overrides the escape character of the reference
format.</p><p>This option is <code>null</code> by default. <span>When
</span><code>null</code><span> it keeps the value of the reference format which
is </span><code>null</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>headerDisabled</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Disables the header of the reference
format.</p><p>This option is <code>false</code> by
default.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>header</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>String[]</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Overrides the header of the reference
format.</p><p>This option is <
code>null</code> by default. <span>When </span><code>null</code><span> it
keeps the value of the reference format which is </span><code>null</code><span>
for </span><code>CSVFormat.DEFAULT</code><span>.</span></p><p>In the XML DSL,
this option is configured using
children <code><header></code> tags:</p><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<csv formatRef="excelFormat"
delimiter="|" skipHeaderRecord="true">
+ <header>orderId</header>
+ <header>amount</header>
+</csv>]]></script>
+</div></div></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>allowMissingColumnNames</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Overrides the missing column names behavior
of the reference format.</p><p>This option is <code>null</code> by default.
<span>When </span><code>null</code><span> it keeps the value of the reference
format which is </span><code>false</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>ignoreEmptyLines</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Overrides the empty line behavior of the
reference format.</p><p><span>This option is </span><code>null</code><span> by
default. <span>When </span><code>null</code><span> it keeps the value of the
reference format which is </sp
an><code>true</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>ignoreSurroundingSpaces</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>Boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Overrides the surrounding spaces behavior
of the reference format.</p><p><span>This option is
</span><code>null</code><span> by default. <span>When
</span><code>null</code><span> it keeps the value of the reference format which
is </span><code>false</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>nullStringDisabled</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>boolean</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Disables the null string representation of
the reference format.</p><p>This option is <code>false</code> by default.</p>
</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>nullString</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>String</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Overrides the null string representation of the
reference format.</p><p><span>This option is </span><code>null</code><span> by
default. <span>When </span><code>null</code><span> it keeps the value of the
reference format which is </span><code>null</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>quoteDisabled</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Disables the quote of the
reference format.</p><p><span>This option is </span><code>false</code><span> by
default.</span></p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>quote</code></td><td colspan="1" rowspan
="1" class="confluenceTd"><code>Character</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Overrides the quote symbol of the reference
format.</p><p><span>This option is </span><code>null</code><span> by default.
<span>When </span><code>null</code><span> it keeps the value of the reference
format which is </span><code>'"'</code><span> (double quote) for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>quoteMode</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>QuoteMode</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Overrides the quote mode of the
reference format.</p><p><span>This option is </span><code>null</code><span> by
default. <span>When </span><code>null</code><span> it keeps the value of the
reference format which is </span><code>null</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspa
n="1" class="confluenceTd"><code>recordSeparatorDisabled</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Disables the record separator
of the reference format.</p><p><span>This option is
</span><code>false</code><span> by default.</span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>recordSeparator</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Overrides the record separator of the
reference format.</p><p><span>This option is </span><code>null</code><span> by
default. <span>When </span><code>null</code><span> it keeps the value of the
reference format which is </span><code>\r\n</code><span> (CRLF) for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><code>skipHeaderRecord</code></td><td colspan="1" rowspan="
1" class="confluenceTd"><code>Boolean</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Overrides the header record behavior of the reference
format.</p><p><span>This option is </span><code>null</code><span> by default.
<span>When </span><code>null</code><span> it keeps the value of the reference
format which is </span><code>false</code><span> for
</span><code>CSVFormat.DEFAULT</code><span>.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><code>lazyLoad</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><code>boolean</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Whether the unmarshalling
should produce an iterator that reads the lines on the fly or if all the lines
must be read at one.</p><p>This option is <code>false</code> by
default.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>useMaps</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>boolean</code></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>Whether the unmarshalling
should produce maps for the lines values instead of lists. It requires to have
header (either defined or collected).</p><p>This options
is <code>false</code> by default.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>recordConverter</code></td><td
colspan="1" rowspan="1"
class="confluenceTd"><code>CsvRecordConverter</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Sets the record converter to use. If
defines the <code>useMaps</code> options is disabled.</p><p><span>This option
is </span><code>null</code><span> by
default.</span></p></td></tr></tbody></table></div><h3
id="BookDataFormatAppendix-MarshallingaMaptoCSV">Marshalling a Map to
CSV</h3><p>The component allows you to marshal a Java Map (or any other message
type that can be <a shape="rect" href="type-converter.html">converted</a> in a
Map) into a CSV payload.</p><p>An example: if you send a message with t
his map...</p><p> </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[
Map<String, Object> body = new HashMap<String, Object>();
body.put("foo", "abc");
@@ -608,7 +613,7 @@ csvConfig.setDelimiter(';');
</div></div>
The String <a shape="rect" href="data-format.html">Data Format</a> is a
textual based format that supports encoding.
-<h3 id="BookDataFormatAppendix-Options.1">Options</h3>
+<h3 id="BookDataFormatAppendix-Options">Options</h3>
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Option </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Default </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Description
</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> charset
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> null </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> To use a specific charset for
encoding. If not provided Camel will use the JVM default charset.
</p></td></tr></tbody></table></div>
@@ -698,7 +703,7 @@ The result of the operation will contain
<p><strong>Notice:</strong> The Flatpack library does currently not support
header and trailers for the marshal operation.</p>
-<h3 id="BookDataFormatAppendix-Options.2">Options</h3>
+<h3 id="BookDataFormatAppendix-Options.1">Options</h3>
<p>The data format has the following options:</p>
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Option </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Default </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Description
</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>definition</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>null</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The flatpack pzmap configuration file. Can be omitted
in simpler situations, but its preferred to use the pzmap.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>fixed</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>false</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Delimited or fixed. </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>ignoreFirstRecord</code>
</p></td><td colspan="
1" rowspan="1" class="confluenceTd"><p> <code>true</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Whether the first line is
ignored for delimited files (for the column headers). </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>textQualifier</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>"</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> If the text is
qualified with a char such as <code>"</code>. </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>delimiter</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>,</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> The delimiter char (could be
<code>;</code> <code>,</code> or similar) </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>parserFactory</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>null</code> </p></td><td
cols
pan="1" rowspan="1" class="confluenceTd"><p> Uses the default Flatpack parser
factory. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>allowShortLines</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.7 and 2.10.5
onwards</strong>: Allows for lines to be shorter than expected and ignores the
extra characters. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>ignoreExtraColumns</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.7 and 2.10.5 onwards</strong>: Allows for lines to be longer than expected
and ignores the extra characters. </p></td></tr></tbody></table></div>
@@ -977,7 +982,7 @@ This is subject to change in the future,
</div>
-<h3 id="BookDataFormatAppendix-Options.3">Options</h3>
+<h3 id="BookDataFormatAppendix-Options.2">Options</h3>
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Option </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Default </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Description
</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
compressionLevel </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
null </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> To specify a
specific compression Level use <code>java.util.zip.Deflater</code> settings.
The possible settings are  <br clear="none" class="atl-forced-newline">
          -
<code>Deflater.BEST_SPEED</code> <br clear="none" class="atl-forced-newline">
@@ -2187,7 +2192,7 @@ context.addRoutes(new RouteBuilder() {
</div></div><h3
id="BookDataFormatAppendix-Dependencies.9">Dependencies</h3><p>This data format
is provided within the <strong>camel-xmlsecurity</strong> component.</p>
The GZip <a shape="rect" href="data-format.html">Data Format</a> is a message
compression and de-compression format. It uses the same deflate algorithm that
is used in <a shape="rect" href="zip-dataformat.html">Zip DataFormat</a>,
although some additional headers are provided. This format is produced by
popular <code>gzip</code>/<code>gunzip</code> tool. Messages marshalled using
GZip compression can be unmarshalled using GZip decompression just prior to
being consumed at the endpoint. The compression capability is quite useful when
you deal with large XML and Text based payloads or when you read messages
previously comressed using <code>gzip</code> tool.
-<h3 id="BookDataFormatAppendix-Options.4">Options</h3>
+<h3 id="BookDataFormatAppendix-Options.3">Options</h3>
<p>There are no options provided for this data format.</p>
@@ -2318,7 +2323,7 @@ castor.getUnmarshaller();
</div></div>
-<h3 id="BookDataFormatAppendix-Options.5">Options</h3>
+<h3 id="BookDataFormatAppendix-Options.4">Options</h3>
<p>Castor supports the following options</p>
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p> Option </p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p> Type </p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p> Default </p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> encoding </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> UTF-8 </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> Encoding to use when marshalling an Object
to XML </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
validation </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
Boolean </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> false
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Whether
validation is turned on or off. </p></td>
</tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> mappingFile
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> String
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> null </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> Path to a Castor mapping file
to load from the classpath. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> packages </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> String[] </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> null </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> Add additional packages to Castor XmlContext
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
classNames </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
String[] </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> null
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Add additional
class names to Castor XmlContext </p></td></t
r></tbody></table></div>
@@ -2682,7 +2687,7 @@ from("jms://queue:customerServiceQu
</dependency>
]]></script>
</div></div>
-<h2 id="BookDataFormatAppendix-Crypto">Crypto</h2><p><strong>Available as of
Camel 2.3</strong><br clear="none"> <strong>PGP Available as of Camel
2.9</strong></p><p>The Crypto <a shape="rect" href="data-format.html">Data
Format</a> integrates the Java Cryptographic Extension into Camel, allowing
simple and flexible encryption and decryption of messages using Camel's
familiar marshall and unmarshal formatting mechanism. It assumes marshalling to
mean encryption to cyphertext and unmarshalling to mean decryption back to the
original plaintext. This data format implements only symmetric (shared-key)
encryption and decyption.</p><h3
id="BookDataFormatAppendix-Options.6">Options</h3><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluence
Th"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>algorithm</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>DES/CBC/PKCS5Padding</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The JCE algorithm name
indicating the cryptographic algorithm that will be used.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>algorithmParameterSpec</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.security.spec.AlgorithmParameterSpec</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 JCE AlgorithmParameterSpec
used to initialize the Cipher.</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>
<code>Integer</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>2048</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>the size of the buffer used in the signature
process.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cryptoProvider</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The name of the JCE Security Provider that
should be used.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>initializationVector</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>byte[]</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 byte array containing the
Initialization Vector that will be used to initialize the Cip
her.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>inline</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Flag indicating that the configured IV
should be inlined into the encrypted data stream.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>macAlgorithm</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The JCE algorithm name indicating the
Message Authentication algorithm.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>shouldAppendHMAC</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
colspan="1" rowsp
an="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Flag indicating that a Message
Authentication Code should be calculated and appended to the encrypted
data.</p></td></tr></tbody></table></div><h3
id="BookDataFormatAppendix-BasicUsage">Basic Usage</h3><p>At its most basic all
that is required to encrypt/decrypt an exchange is a shared secret key. If one
or more instances of the Crypto data format are configured with this key the
format can be used to encrypt the payload in one route (or part of one) and
decrypted in another. For example, using the Java DSL as follows:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<h2 id="BookDataFormatAppendix-Crypto">Crypto</h2><p><strong>Available as of
Camel 2.3</strong><br clear="none"> <strong>PGP Available as of Camel
2.9</strong></p><p>The Crypto <a shape="rect" href="data-format.html">Data
Format</a> integrates the Java Cryptographic Extension into Camel, allowing
simple and flexible encryption and decryption of messages using Camel's
familiar marshall and unmarshal formatting mechanism. It assumes marshalling to
mean encryption to cyphertext and unmarshalling to mean decryption back to the
original plaintext. This data format implements only symmetric (shared-key)
encryption and decyption.</p><h3
id="BookDataFormatAppendix-Options.5">Options</h3><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1"
class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1"
class="confluence
Th"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>algorithm</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p><code>DES/CBC/PKCS5Padding</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The JCE algorithm name
indicating the cryptographic algorithm that will be used.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>algorithmParameterSpec</code></p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>java.security.spec.AlgorithmParameterSpec</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 JCE AlgorithmParameterSpec
used to initialize the Cipher.</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>
<code>Integer</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>2048</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>the size of the buffer used in the signature
process.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>cryptoProvider</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The name of the JCE Security Provider that
should be used.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>initializationVector</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>byte[]</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 byte array containing the
Initialization Vector that will be used to initialize the Cip
her.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>inline</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Flag indicating that the configured IV
should be inlined into the encrypted data stream.</p></td></tr><tr><td
colspan="1" rowspan="1"
class="confluenceTd"><p><code>macAlgorithm</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>The JCE algorithm name indicating the
Message Authentication algorithm.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>shouldAppendHMAC</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td
colspan="1" rowsp
an="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Flag indicating that a Message
Authentication Code should be calculated and appended to the encrypted
data.</p></td></tr></tbody></table></div><h3
id="BookDataFormatAppendix-BasicUsage">Basic Usage</h3><p>At its most basic all
that is required to encrypt/decrypt an exchange is a shared secret key. If one
or more instances of the Crypto data format are configured with this key the
format can be used to encrypt the payload in one route (or part of one) and
decrypted in another. For example, using the Java DSL as follows:</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"><