Author: buildbot
Date: Fri Mar 14 15:18:46 2014
New Revision: 901571
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/hbase.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/hbase.html
==============================================================================
--- websites/production/camel/content/hbase.html (original)
+++ websites/production/camel/content/hbase.html Fri Mar 14 15:18:46 2014
@@ -86,88 +86,28 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="hbase-HBaseComponent">HBase
Component</h2>
-<p><strong>Available as of Camel 2.10</strong></p>
-
-<p>This component provides an idemptotent repository, producers and consumers
for <a shape="rect" class="external-link"
href="http://hbase.apache.org/";>Apache HBase</a>.</p>
-
-<p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[
-<dependency>
+<div class="wiki-content maincontent"><h2 id="hbase-HBaseComponent">HBase
Component</h2><p><strong>Available as of Camel 2.10</strong></p><p>This
component provides an idemptotent repository, producers and consumers for <a
shape="rect" class="external-link" href="http://hbase.apache.org/";>Apache
HBase</a>.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-hbase</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</div></div>
-
-<h3 id="hbase-ApacheHBaseOverview">Apache HBase Overview</h3>
-<p>HBase is an open-source, distributed, versioned, column-oriented store
modeled after Google's Bigtable: A Distributed Storage System for Structured
Data. You can use HBase when you need random, realtime read/write access to
your Big Data. More information at <a shape="rect" class="external-link"
href="http://hbase.apache.org";>Apache HBase</a>.</p>
-
-<h3 id="hbase-CamelandHBase">Camel and HBase</h3>
-<p>When using a datasotre inside a camel route, there is always the chalenge
of specifying how the camel message will stored to the datastore. In document
based stores things are more easy as the message body can be directly mapped to
a document. In relational databases an ORM solution can be used to map
properties to columns etc. In column based stores things are more challenging
as there is no standard way to perform that kind of mapping. </p>
-
-<p>HBase adds two additional challenges:</p>
-<ul class="alternate"><li>HBase groups columns into families, so just mapping
a property to a column using a name convention is just not
enough.</li><li>HBase doesn't have the notion of type, which means that it
stores everything as byte[] and doesn't know if the byte[] represents a String,
a Number, a serialized Java object or just binary data.</li></ul>
-
-
-<p>To overcome these challenges, camel-hbase makes use of the message headers
to specify the mapping of the message to HBase columns. It also provides the
ability to use some camel-hbase provided classes that model HBase data and can
be easily convert to and from xml/json etc.<br clear="none">
-Finally it provides the ability to the user to implement and use his own
mapping strategy.</p>
-
-<p>Regardless of the mapping strategy camel-hbase will convert a message into
an org.apache.camel.component.hbase.model.HBaseData object and use that object
for its internal operations.</p>
-
-<h3 id="hbase-Configuringthecomponent">Configuring the component</h3>
-
-<p>The HBase component can be provided a custom HBaseConfiguration object as a
property or it can create an HBase configuration object on its own based on the
HBase related resources that are found on classpath.</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[
- <bean id="hbase"
class="org.apache.camel.component.hbase.HBaseComponent">
+</div></div><h3 id="hbase-ApacheHBaseOverview">Apache HBase
Overview</h3><p>HBase is an open-source, distributed, versioned,
column-oriented store modeled after Google's Bigtable: A Distributed Storage
System for Structured Data. You can use HBase when you need random, realtime
read/write access to your Big Data. More information at <a shape="rect"
class="external-link" href="http://hbase.apache.org";>Apache HBase</a>.</p><h3
id="hbase-CamelandHBase">Camel and HBase</h3><p>When using a datasotre inside a
camel route, there is always the chalenge of specifying how the camel message
will stored to the datastore. In document based stores things are more easy as
the message body can be directly mapped to a document. In relational databases
an ORM solution can be used to map properties to columns etc. In column based
stores things are more challenging as there is no standard way to perform that
kind of mapping.</p><p>HBase adds two additional challenges:</p><ul
class="alternate"><li>HBase
groups columns into families, so just mapping a property to a column using a
name convention is just not enough.</li><li>HBase doesn't have the notion of
type, which means that it stores everything as byte[] and doesn't know if the
byte[] represents a String, a Number, a serialized Java object or just binary
data.</li></ul><p>To overcome these challenges, camel-hbase makes use of the
message headers to specify the mapping of the message to HBase columns. It also
provides the ability to use some camel-hbase provided classes that model HBase
data and can be easily convert to and from xml/json etc.<br clear="none">
Finally it provides the ability to the user to implement and use his own
mapping strategy.</p><p>Regardless of the mapping strategy camel-hbase will
convert a message into an org.apache.camel.component.hbase.model.HBaseData
object and use that object for its internal operations.</p><h3
id="hbase-Configuringthecomponent">Configuring the component</h3><p>The HBase
component c
an be provided a custom HBaseConfiguration object as a property or it can
create an HBase configuration object on its own based on the HBase related
resources that are found on classpath.</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[ <bean id="hbase"
class="org.apache.camel.component.hbase.HBaseComponent">
<property name="configuration" ref="config"/>
</bean>
]]></script>
-</div></div>
-
-<p>If no configuration object is provided to the component, the component will
create one. The created configuration will search the class path for an
hbase-site.xml file, from which it will draw the configuration. You can find
more information about how to configure HBase clients at: <a shape="rect"
class="external-link"
href="http://archive.apache.org/dist/hbase/docs/client_dependencies.html";>HBase
client configuration and dependencies </a></p>
-
-
-<h3 id="hbase-HBaseProducer">HBase Producer</h3>
-<p>As mentioned above camel provides produers endpoints for HBase. This allows
you to store, delete, retrieve or query data from HBase using your camel
routes.</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[
-hbase://table[?options]
+</div></div><p>If no configuration object is provided to the component, the
component will create one. The created configuration will search the class path
for an hbase-site.xml file, from which it will draw the configuration. You can
find more information about how to configure HBase clients at: <a shape="rect"
class="external-link"
href="http://archive.apache.org/dist/hbase/docs/client_dependencies.html";>HBase
client configuration and dependencies </a></p><h3
id="hbase-HBaseProducer">HBase Producer</h3><p>As mentioned above camel
provides produers endpoints for HBase. This allows you to store, delete,
retrieve or query data from HBase using your camel routes.</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[hbase://table[?options]
]]></script>
-</div></div>
-
-<p>where <strong>table</strong> is the table name.</p>
-
-<p>The supported operations are:</p>
-<ul class="alternate"><li>Put</li><li>Get</li><li>Delete</li><li>Scan</li></ul>
-
-
-<h4 id="hbase-SupportedURIoptionsonproducer">Supported URI options on
producer</h4>
-
-<div class="confluenceTableSmall">
+</div></div><p>where <strong>table</strong> is the table name.</p><p>The
supported operations are:</p><ul
class="alternate"><li>Put</li><li>Get</li><li>Delete</li><li>Scan</li></ul><h4
id="hbase-SupportedURIoptionsonproducer">Supported URI options on
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>operation</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelHBasePut</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The HBase
operation to perform. <strong>Supported values</strong>:
<code>CamelHBasePut</code>, <code>CamelHBaseGet</code>,
<code>CamelHBaseDelete</code>, and <code>CamelHBaseScan</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>maxResults</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>100</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The maximum number of rows to scan.<strong>Supported
operations</strong>: <code
>CamelHBaseScan</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p> <code>mappingStrategyName</code> </p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p> <code>header</code>
></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> The strategy to
>use for mapping Camel messages to HBase columns. Supported values:
><code>header</code>, or <code>body</code>. </p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p> <code>mappingStrategyClassName</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 class name of a custom mapping strategy
>implementation. </p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p> <code>filters</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 list of filters.
><strong>Supported operations</stron
g>: <code>CamelHBaseScan</code>. </p></td></tr></tbody></table>
-</div>
-
-<p>Header mapping options:</p>
-
-<div class="confluenceTableSmall">
+</div><p>Header mapping options:</p><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>rowId</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The id of the row. This has limited use as
the row usually changes per Exchange.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>rowType</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> The type to covert row id to.
<strong>Supported operations</strong>: <code>CamelHBaseScan</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>family</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The column family. <strong>Supports</strong> a number
suffix for referring to more than one columns </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>qualifier</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The column qualifier.
<strong>Supports</strong> a number suffix for referring to more than one
columns </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>value</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The value. <strong>Supports</strong> a number suffix
for referring to more than one columns </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>valueType</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> String </p>
</td><td colspan="1" rowspan="1" class="confluenceTd"><p> The value type.
Supports a number suffix for referring to more than one columns.
<strong>Supported operations</strong>: <code>CamelHBaseGet</code>, and
<code>CamelHBaseScan</code>. </p></td></tr></tbody></table>
-</div>
-
-<h4 id="hbase-PutOperations.">Put Operations.</h4>
-<p>HBase is a column based store, which allows you to store data into a
specific column of a specific row. Columns are grouped into families, so in
order to specify a column you need to specify the column family and the
qualifier of that column. To store data into a specific column you need to
specify both the column and the row.</p>
-
-<p>The simplest scenario for storing data into HBase from a camel route, would
be to store part of the message body to specified HBase column.</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[
- <route>
+</div><h4 id="hbase-PutOperations.">Put Operations.</h4><p>HBase is a column
based store, which allows you to store data into a specific column of a
specific row. Columns are grouped into families, so in order to specify a
column you need to specify the column family and the qualifier of that column.
To store data into a specific column you need to specify both the column and
the row.</p><p>The simplest scenario for storing data into HBase from a camel
route, would be to store part of the message body to specified HBase
column.</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[ <route>
<from uri="direct:in"/>
<!-- Set the HBase Row -->
<setHeader headerName="CamelHBaseRowId">
@@ -180,20 +120,15 @@ hbase://table[?options]
<to
uri="hbase:mytable?opertaion=CamelHBasePut&amp;family=myfamily&amp;qualifier=myqualifier"/>
</route>
]]></script>
-</div></div>
-
-<p>The route above assumes that the message body contains an object that has
an id and value property and will store the content of value in the HBase
column myfamily:myqualifier in the row specified by id. If we needed to specify
more than one column/value pairs we could just specify additional column
mappings:</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[
- <route>
+</div></div><p>The route above assumes that the message body contains an
object that has an id and value property and will store the content of value in
the HBase column myfamily:myqualifier in the row specified by id. If we needed
to specify more than one column/value pairs we could just specify additional
column mappings. Notice that you must use numbers from the 2nd header onwards,
eg RowId2, RowId3, RowId4, etc. Only the 1st header does not have the number
1.</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[ <route>
<from uri="direct:in"/>
<!-- Set the HBase Row 1st column -->
<setHeader headerName="CamelHBaseRowId">
<el>${in.body.id}</el>
</setHeader>
<!-- Set the HBase Row 2nd column -->
- <setHeader headerName="CamelHBaseRowId">
+ <setHeader headerName="CamelHBaseRowId2">
<el>${in.body.id}</el>
</setHeader>
<!-- Set the HBase Value for 1st column -->
@@ -207,16 +142,8 @@ hbase://table[?options]
<to
uri="hbase:mytable?opertaion=CamelHBasePut&amp;family=myfamily&amp;qualifier=myqualifier&amp;family2=myfamily&amp;qualifier2=myqualifier2"/>
</route>
]]></script>
-</div></div>
-
-<p>It is important to remember that you can use uri options, message headers
or a combination of both. It is recommended to specify constants as part of the
uri and dynamic values as headers. If something is defined both as header and
as part of the uri, the header will be used.</p>
-
-<h4 id="hbase-GetOperations.">Get Operations.</h4>
-<p>A Get Operation is an operation that is used to retrieve one or more values
from a specified HBase row. To specify what are the values that you want to
retrieve you can just specify them as part of the uri or as message headers.</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[
- <route>
+</div></div><p>It is important to remember that you can use uri options,
message headers or a combination of both. It is recommended to specify
constants as part of the uri and dynamic values as headers. If something is
defined both as header and as part of the uri, the header will be used.</p><h4
id="hbase-GetOperations.">Get Operations.</h4><p>A Get Operation is an
operation that is used to retrieve one or more values from a specified HBase
row. To specify what are the values that you want to retrieve you can just
specify them as part of the uri or as message headers.</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[ <route>
<from uri="direct:in"/>
<!-- Set the HBase Row of the Get -->
<setHeader headerName="CamelHBaseRowId">
@@ -226,16 +153,8 @@ hbase://table[?options]
<to uri="log:out"/>
</route>
]]></script>
-</div></div>
-
-<p>In the example above the result of the get operation will be stored as a
header with name CamelHBaseValue.</p>
-
-<h4 id="hbase-DeleteOperations.">Delete Operations.</h4>
-<p>You can also you camel-hbase to perform HBase delete operation. The delete
operation will remove an entire row. All that needs to be specified is one or
more rows as part of the message headers.</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[
- <route>
+</div></div><p>In the example above the result of the get operation will be
stored as a header with name CamelHBaseValue.</p><h4
id="hbase-DeleteOperations.">Delete Operations.</h4><p>You can also you
camel-hbase to perform HBase delete operation. The delete operation will remove
an entire row. All that needs to be specified is one or more rows as part of
the message headers.</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[ <route>
<from uri="direct:in"/>
<!-- Set the HBase Row of the Get -->
<setHeader headerName="CamelHBaseRowId">
@@ -244,30 +163,15 @@ hbase://table[?options]
<to
uri="hbase:mytable?opertaion=CamelHBaseDelete"/>
</route>
]]></script>
-</div></div>
-
-<h4 id="hbase-ScanOperations.">Scan Operations.</h4>
-<p>A scan operation is the equivalent of a query in HBase. You can use the
scan operation to retrieve multiple rows. To specify what columns should be
part of the result and also specify how the values will be converted to objects
you can use either uri options or headers.</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[
- <route>
+</div></div><h4 id="hbase-ScanOperations.">Scan Operations.</h4><p>A scan
operation is the equivalent of a query in HBase. You can use the scan operation
to retrieve multiple rows. To specify what columns should be part of the result
and also specify how the values will be converted to objects you can use either
uri options or headers.</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[ <route>
<from uri="direct:in"/>
<to
uri="hbase:mytable?opertaion=CamelHBaseScan&amp;family=myfamily&amp;qualifier=myqualifier&amp;valueType=java.lang.Long&amp;rowType=java.lang.String"/>
<to uri="log:out"/>
</route>
]]></script>
-</div></div>
-
-<p>In this case its probable that you also also need to specify a list of
filters for limiting the results. You can specify a list of filters as part of
the uri and camel will return only the rows that satisfy <strong>ALL</strong>
the filters. <br clear="none">
-To have a filter that will be aware of the information that is part of the
message, camel defines the ModelAwareFilter. This will allow your filter to
take into consideration the model that is defined by the message and the
mapping strategy.<br clear="none">
-When using a ModelAwareFilter camel-hbase will apply the selected mapping
strategy to the in message, will create an object that models the mapping and
will pass that object to the Filter.</p>
-
-<p>For example to perform scan using as criteria the message headers, you can
make use of the ModelAwareColumnMatchingFilter as shown below.</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[
- <route>
+</div></div><p>In this case its probable that you also also need to specify a
list of filters for limiting the results. You can specify a list of filters as
part of the uri and camel will return only the rows that satisfy
<strong>ALL</strong> the filters. <br clear="none"> To have a filter that will
be aware of the information that is part of the message, camel defines the
ModelAwareFilter. This will allow your filter to take into consideration the
model that is defined by the message and the mapping strategy.<br clear="none">
When using a ModelAwareFilter camel-hbase will apply the selected mapping
strategy to the in message, will create an object that models the mapping and
will pass that object to the Filter.</p><p>For example to perform scan using as
criteria the message headers, you can make use of the
ModelAwareColumnMatchingFilter as shown below.</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[ <route>
<from uri="direct:scan"/>
<!-- Set the Criteria -->
<setHeader headerName="CamelHBaseFamily">
@@ -306,98 +210,35 @@ When using a ModelAwareFilter camel-hbas
</constructor-arg>
</bean>
]]></script>
-</div></div>
-
-<p>The route above assumes that a pojo is with properties firstName and
lastName is passed as the message body, it takes those properties and adds them
as part of the message headers. The default mapping strategy will create a
model object that will map the headers to HBase columns and will pass that
model the the ModelAwareColumnMatchingFilter. The filter will filter out any
rows, that do not contain columns that match the model. It is like query by
example.</p>
-
-<h3 id="hbase-HBaseConsumer">HBase Consumer</h3>
-<p>The Camel HBase Consumer, will perform repeated scan on the specified HBase
table and will return the scan results as part of the message. You can either
specify header mapping (default) or body mapping. The later will just add the
org.apache.camel.component.hbase.model.HBaseData as part of the message
body.</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[
-hbase://table[?options]
+</div></div><p>The route above assumes that a pojo is with properties
firstName and lastName is passed as the message body, it takes those properties
and adds them as part of the message headers. The default mapping strategy will
create a model object that will map the headers to HBase columns and will pass
that model the the ModelAwareColumnMatchingFilter. The filter will filter out
any rows, that do not contain columns that match the model. It is like query by
example.</p><h3 id="hbase-HBaseConsumer">HBase Consumer</h3><p>The Camel HBase
Consumer, will perform repeated scan on the specified HBase table and will
return the scan results as part of the message. You can either specify header
mapping (default) or body mapping. The later will just add the
org.apache.camel.component.hbase.model.HBaseData as part of the message
body.</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[hbase://table[?options]
]]></script>
-</div></div>
-
-<p>You can specify the columns that you want to be return and their types as
part of the uri options:</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[
-hbase:mutable?family=name&qualifer=first&valueType=java.lang.String&family=address&qualifer=number&valueType2=java.lang.Integer&rowType=java.lang.Long
+</div></div><p>You can specify the columns that you want to be return and
their types as part of the uri options:</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[hbase:mutable?family=name&qualifer=first&valueType=java.lang.String&family=address&qualifer=number&valueType2=java.lang.Integer&rowType=java.lang.Long
]]></script>
-</div></div>
-
-<p>The example above will create a model object that is consisted of the
specified fields and the scan results will populate the model object with
values. Finally the mapping strategy will be used to map this model to the
camel message.</p>
-
-<h4 id="hbase-SupportedURIoptionsonconsumer">Supported URI options on
consumer</h4>
-
-<div class="confluenceTableSmall">
+</div></div><p>The example above will create a model object that is consisted
of the specified fields and the scan results will populate the model object
with values. Finally the mapping strategy will be used to map this model to the
camel message.</p><h4 id="hbase-SupportedURIoptionsonconsumer">Supported URI
options on 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 the first
polling 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.
</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> <code>true</code> </p></td><td colsp
an="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.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> timeUnit
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>TimeUnit.MILLISECONDS</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> time unit for <code>initialDelay</code> and
<code>delay</code> options. </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 tha
t. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>operation</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>CamelHBasePut</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The HBase operation to perform.
<strong>Supported values</strong>: <code>CamelHBasePut</code>,
<code>CamelHBaseGet</code>, <code>CamelHBaseDelete</code>, and
<code>CamelHBaseScan</code>. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>maxResults</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>100</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The maximum number of rows to scan.
<strong>Supported operations:</strong> <code>CamelHBaseScan</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>mappingStrategyName</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>header</code> </p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p> The strategy to use for mapping Camel messages to
HBase columns. Supported values: <code>header</code>, or <code>body</code>.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>mappingStrategyClassName</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 class name of a custom mapping strategy
implementation. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>filters</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 list of filters. <strong>Supported
operations</strong>: <code>CamelHBaseScan</code> </p></td></tr></tbody></table>
-</div>
-
-<p>Header mapping options:</p>
-
-<div class="confluenceTableSmall">
+</div><p>Header mapping options:</p><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>rowId</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The id of the row. This has limited use as
the row usually changes per Exchange.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>rowType</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> The type to covert row id to.
<strong>Supported operations</strong>: CamelHBaseScan </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>family</code>
</p></td><td colspan="1" rowspan="1" class="conflu
enceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
The column family. *upports a number suffix for referring to more than one
columns </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>qualifier</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The column qualifier. *Supports a number suffix for
referring to more than one columns </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>value</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> The value. Supports a number suffix for
referring to more than one columns </p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p> <code>rowModel</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> An inst
ance of org.apache.camel.component.hbase.model.HBaseRow which describes how
each row should be modeled </p></td></tr></tbody></table>
-</div>
-
-<p>If the role of the rowModel is not clear, it allows you to construct the
HBaseRow modle programmatically instead of "describing" it with uri options
(such as family, qualifier, type etc).</p>
-
-<h3 id="hbase-HBaseIdempotentrepository">HBase Idempotent repository</h3>
-
-<p>The camel-hbase component also provides an idempotent repository which can
be used when you want to make sure that each message is processed only once.
The HBase idempotent repository is configured with a table, a column family and
a column qualifier and will create to that table a row per message.</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[
-HBaseConfiguration configuration = HBaseConfiguration.create();
+</div><p>If the role of the rowModel is not clear, it allows you to construct
the HBaseRow modle programmatically instead of "describing" it with uri options
(such as family, qualifier, type etc).</p><h3
id="hbase-HBaseIdempotentrepository">HBase Idempotent repository</h3><p>The
camel-hbase component also provides an idempotent repository which can be used
when you want to make sure that each message is processed only once. The HBase
idempotent repository is configured with a table, a column family and a column
qualifier and will create to that table a row per message.</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[HBaseConfiguration configuration =
HBaseConfiguration.create();
HBaseIdempotentRepository repository = new
HBaseIdempotentRepository(configuration, tableName, family, qualifier);
from("direct:in")
.idempotentConsumer(header("messageId"), repository)
.to("log:out);
]]></script>
-</div></div>
-
-<h3 id="hbase-HBaseMapping">HBase Mapping</h3>
-<p>It was mentioned above that you the default mapping strategies are
<strong>header</strong> and <strong>body</strong> mapping.<br clear="none">
-Below you can find some detailed examples of how each mapping strategy
works.</p>
-
-<h4 id="hbase-HBaseHeadermappingExamples">HBase Header mapping Examples</h4>
-<p>The header mapping is the default mapping.<br clear="none">
-To put the value "myvalue" into HBase row "myrow" and column
"myfamily:mycolum" the message should contain the following headers:</p>
-
-<div class="confluenceTableSmall">
+</div></div><h3 id="hbase-HBaseMapping">HBase Mapping</h3><p>It was mentioned
above that you the default mapping strategies are <strong>header</strong> and
<strong>body</strong> mapping.<br clear="none"> Below you can find some
detailed examples of how each mapping strategy works.</p><h4
id="hbase-HBaseHeadermappingExamples">HBase Header mapping Examples</h4><p>The
header mapping is the default mapping.<br clear="none"> To put the value
"myvalue" into HBase row "myrow" and column "myfamily:mycolum" the message
should contain the following headers:</p><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> Value </p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseRowId </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> myrow </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseFamily </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> myfamily </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseQualifier </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> myqualifier </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> CamelHBaseValue </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> myvalue
</p></td></tr></tbody></table>
-</div>
-
-<p>To put more values for different columns and / or different rows you can
specify additional headers suffixed with the index of the headers, e.g:</p>
-
-<div class="confluenceTableSmall">
+</div><p>To put more values for different columns and / or different rows you
can specify additional headers suffixed with the index of the headers,
e.g:</p><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> Value </p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseRowId </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> myrow </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseFamily </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> myfamily </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseQualifier </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> myqualifier </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> CamelHBaseValue </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> myvalue </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> CamelHBaseRowId2 </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> myrow2 </p></td></tr><tr><td
colspan="1"
rowspan="1" class="confluenceTd"><p> CamelHBaseFamily2 </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> myfamily </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> CamelHBaseQualifier2
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> myqualifier
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
CamelHBaseValue2 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
myvalue2 </p></td></tr></tbody></table>
-</div>
-
-<p>In the case of retrieval operations such as get or scan you can also
specify for each column the type that you want the data to be converted to. For
exampe:</p>
-
-<div class="confluenceTableSmall">
+</div><p>In the case of retrieval operations such as get or scan you can also
specify for each column the type that you want the data to be converted to. For
exampe:</p><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> Value </p></th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseFamily </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> myfamily </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> CamelHBaseQualifier </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> myqualifier </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> CamelHBaseValueType
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Long
</p></td></tr></tbody></table>
-</div>
-
-<p>Please note that in order to avoid boilerplate headers that are considered
constant for all messages, you can also specify them as part of the endpoint
uri, as you will see below.</p>
-
-<h4 id="hbase-BodymappingExamples">Body mapping Examples</h4>
-<p>In order to use the body mapping strategy you will have to specify the
option mappingStrategy as part of the uri, for 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[
-hbase:mytable?mappingStrategy=body
+</div><p>Please note that in order to avoid boilerplate headers that are
considered constant for all messages, you can also specify them as part of the
endpoint uri, as you will see below.</p><h4 id="hbase-BodymappingExamples">Body
mapping Examples</h4><p>In order to use the body mapping strategy you will have
to specify the option mappingStrategy as part of the uri, for 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[hbase:mytable?mappingStrategy=body
]]></script>
-</div></div>
-
-<p>To use the body mapping strategy the body needs to contain an instance of
org.apache.camel.component.hbase.model.HBaseData. You can construct t</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[
-HBaseData data = new HBaseData();
+</div></div><p>To use the body mapping strategy the body needs to contain an
instance of org.apache.camel.component.hbase.model.HBaseData. You can construct
t</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[HBaseData data = new HBaseData();
HBaseRow row = new HBaseRow();
row.setId("myRowId");
HBaseCell cell = new HBaseCell();
@@ -407,14 +248,7 @@ cell.setValue("myValue");
row.getCells().add(cell);
data.addRows().add(row);
]]></script>
-</div></div>
-
-<p>The object above can be used for example in a put operation and will result
in creating or updating the row with id myRowId and add the value myvalue to
the column myfamily:myqualifier.<br clear="none">
-The body mapping strategy might not seem very appealing at first. The
advantage it has over the header mapping strategy is that the HBaseData object
can be easily converted to or from xml/json.</p>
-
-
-<h3 id="hbase-Seealso">See also</h3>
-<ul class="alternate"><li><a shape="rect" href="polling-consumer.html">Polling
Consumer</a></li><li><a shape="rect" class="external-link"
href="http://hbase.apache.org";>Apache HBase</a></li></ul></div>
+</div></div><p>The object above can be used for example in a put operation and
will result in creating or updating the row with id myRowId and add the value
myvalue to the column myfamily:myqualifier.<br clear="none"> The body mapping
strategy might not seem very appealing at first. The advantage it has over the
header mapping strategy is that the HBaseData object can be easily converted to
or from xml/json.</p><h3 id="hbase-Seealso">See also</h3><ul
class="alternate"><li><a shape="rect" href="polling-consumer.html">Polling
Consumer</a></li><li><a shape="rect" class="external-link"
href="http://hbase.apache.org";>Apache HBase</a></li></ul></div>
</td>
<td valign="top">
<div class="navigation">
