camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r898457 - in /websites/production/camel/content: cache/main.pageCache cxfrs.html
Date Wed, 19 Feb 2014 03:46:04 GMT
Author: buildbot
Date: Wed Feb 19 03:46:04 2014
New Revision: 898457

Log:
Production update by buildbot for camel

Modified:
    websites/production/camel/content/cache/main.pageCache
    websites/production/camel/content/cxfrs.html

Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/camel/content/cxfrs.html
==============================================================================
--- websites/production/camel/content/cxfrs.html (original)
+++ websites/production/camel/content/cxfrs.html Wed Feb 19 03:46:04 2014
@@ -108,12 +108,7 @@
 </div></div><p>Where <strong>rsEndpoint</strong> represents
the spring bean's name which presents the CXFRS client or server</p><p>For either
style above, you can append options to the URI 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"><![CDATA[cxfrs:bean:cxfEndpoint?resourceClasses=org.apache.camel.rs.Example
 ]]></script>
-</div></div><h3 id="CXFRS-Options">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>
Description </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>
Example </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>
Required? </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>
default value </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>resourceClasses</code> </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> The resource classes which you want to export as REST service.
Multiple classes can be separated by comma. </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>resourceClasses=org.apache.camel.rs.Example1,</code><br
clear="none">
-<code>org.apache.camel.rs.Exchange2</code> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>resourceClass</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Deprecated</strong>:
Use <code>resourceClasses</code> The resource class which you want to export as
REST service. </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>resourceClass =org.apache.camel.rs.Example1</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>httpClientAPI</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>new
to Camel 2.1</strong> If it is true, the CxfRsProducer will use the HttpClientAPI to
invoke the se
 rvice <br clear="none" class="atl-forced-newline">
-If it is false, the CxfRsProducer will use the ProxyClientAPI to invoke the service </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> httpClientAPI=true </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <em>true</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> synchronous </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.5, this option will let
CxfRsConsumer decide to use sync or async API to do the underlying work. The default value
is false which means it will try to use async API by default. </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> synchronous=true </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> false </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> throwExceptionOnFailure </p></td><td
colspan="1" rowspan="1" class="confluenc
 eTd"><p> New in 2.6, this option tells the CxfRsProducer to inspect return codes
and will generate an Exception if the return code is larger than 207. </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> throwExceptionOnFailure=true </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> true </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>maxClientCacheSize</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New
in 2.6, you can set a IN message header CamelDestinationOverrideUrl to dynamically override
the target destination Web Service or REST Service defined in your routes.&#160; The implementation
caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.&#160; This option
allows you to configure the maximum size of the cache. <br clear="none" class="atl-forced-newline">
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> maxClien
 tCacheSize=5 </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
No <br clear="none" class="atl-forced-newline"> </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> 10 </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>setDefaultBus</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> New
in 2.9.0. Will set the default bus when CXF endpoint create a bus by itself </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>setDefaultBus=true</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>false</code> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>bus</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> New in 2.9.0. A default bus created
by CXF Bus Factory. Use <code>#</code> notation to reference a bus object from
the registry. The referenced object must be an instance of <code
 >org.apache.cxf.Bus</code>. </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>bus=#busName</code> </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>bindingStyle</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>As
of 2.11</strong>. Sets how requests and responses will be mapped to/from Camel. Two
values are possible: </p>
-<ul class="alternate"><li><code>SimpleConsumer</code> =&gt; see
the <a shape="rect" href="#CXFRS-ConsumingaRESTRequest-SimpleBindingStyle">Consuming
a REST Request with the Simple Binding Style</a> below.</li><li><code>Default</code>
=&gt; the default style. For consumers this passes on a <code>MessageContentsList</code>
to the route, requiring low-level processing in the route.</li></ul>
-</td><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>bindingStyle=SimpleConsumer</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <em>Default</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>providers</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Since Camel 2.12.2</strong>
set custom JAX-RS providers list to the CxfRs endpoint. </p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p> No </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> <em>None</em> </p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p> <code>schemaLocations</code>
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Since
Camel 2.12.2</strong> Sets the locations of the schemas which can be used to validate
the incoming XML or JAXB-driven JSON. </p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p> NO <
 /p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em>
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>features</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
<strong>Since Camel 2.12.3</strong> Set the feature list to the CxfRs endpoint.
</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> No </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p> <em>None</em> </p></td></tr></tbody></table></div>
-<p>You can also configure the CXF REST endpoint through the spring configuration. Since
there are lots of difference between the CXF REST client and CXF REST Server, we provide different
configuration for them.<br clear="none"> Please check out the <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">schema
file</a> and <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF
REST user guide</a> for more information.</p><h3 id="CXFRS-HowtoconfiguretheRESTendpointinCamel">How
to configure the REST endpoint in Camel</h3><p>In <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">camel-cxf
schema file</a>, there are two elements for the REST endpoint definition. <strong>cxf:rsServer</strong>
for REST consumer, <strong>cxf:rsClient</strong> for REST produce
 r.<br clear="none"> You can find a Camel REST service route configuration example here.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
+</div></div><h3 id="CXFRS-Options">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>Description</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Example</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Required?</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>default value</p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClasses</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>The resource classes which you want
to export as REST service. Multiple classes can be separated by comma.</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClasses=org.apache.camel.rs.Example1,</code><br
clear="none"> <code>org.apache.camel.rs.Exchange2</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" 
 class="confluenceTd"><p><em>None</em></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClass</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated</strong>:
Use <code>resourceClasses</code> The resource class which you want to export as
REST service.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>resourceClass
=org.apache.camel.rs.Example1</code></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><em>None</em></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientAPI</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>new to Camel 2.1</strong>
If it is true, the CxfRsProducer will use the HttpClientAPI to invoke the service <br clear="none"
class="atl-forced-newline"> If it is false, the CxfRsProducer will use the ProxyClientAPI
to invoke the service</p></td><td colspan="1" r
 owspan="1" class="confluenceTd"><p>httpClientAPI=true</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><em>true</em></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>synchronous</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.5, this option will let
CxfRsConsumer decide to use sync or async API to do the underlying work. The default value
is false which means it will try to use async API by default.</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>synchronous=true</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>false</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>throwExceptionOnFailure</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.6, this option tells the
CxfRsProducer to inspect return codes and will generate an Exception if the return cod
 e is larger than 207.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>throwExceptionOnFailure=true</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>true</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>maxClientCacheSize</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.6, you can set a IN message
header CamelDestinationOverrideUrl to dynamically override the target destination Web Service
or REST Service defined in your routes.&#160; The implementation caches CXF clients or
ClientFactoryBean in CxfProvider and CxfRsProvider.&#160; This option allows you to configure
the maximum size of the cache.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>maxClientCacheSize=5</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>10</p></td></tr><tr><td
colspan="1" rowspan="1" cl
 ass="confluenceTd"><p><code>setDefaultBus</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.9.0. Will set the default
bus when CXF endpoint create a bus by itself</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>setDefaultBus=true</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>bus</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>New in 2.9.0. A default bus created
by CXF Bus Factory. Use <code>#</code> notation to reference a bus object from
the registry. The referenced object must be an instance of <code>org.apache.cxf.Bus</code>.</p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>bus=#busName</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><em>None</em
 ></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bindingStyle</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><strong>As of 2.11</strong>.
Sets how requests and responses will be mapped to/from Camel. Two values are possible:</p><ul
class="alternate"><li><code>SimpleConsumer</code> =&gt; see the <a
shape="rect" href="#CXFRS-ConsumingaRESTRequest-SimpleBindingStyle">Consuming a REST Request
with the Simple Binding Style</a> below.</li><li><code>Default</code>
=&gt; the default style. For consumers this passes on a <code>MessageContentsList</code>
to the route, requiring low-level processing in the route.</li></ul></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>bindingStyle=SimpleConsumer</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>No</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><em>Default</em></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><span>providers</span></td
 ><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.2</strong><span>
set custom JAX-RS providers list to the CxfRs endpoint.</span></td><td colspan="1"
rowspan="1" class="confluenceTd">providers=#MyProviders</td><td colspan="1" rowspan="1"
class="confluenceTd">No</td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><span>schemaLocations</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.2</strong><span>
Sets the locations of the schemas which can be used to validate the incoming XML or JAXB-driven
JSON.</span></td><td colspan="1" rowspan="1" class="confluenceTd">schemaLocations=#MySchemaLocations</td><td
colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><span>features</span></td><td colspan="1"
rowspan="1" class="confluenceTd">
 <strong>Since Camel 2.12.3</strong><span> Set the feature list to the CxfRs
endpoint.</span></td><td colspan="1" rowspan="1" class="confluenceTd">features=#MyFeatures</td><td
colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">properties</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Since
Camel 2.12.4</strong><span> Set the properties to the CxfRs endpoint.</span></td><td
colspan="1" rowspan="1" class="confluenceTd">properties=#MyProperties</td><td
colspan="1" rowspan="1" class="confluenceTd">No</td><td colspan="1" rowspan="1"
class="confluenceTd"><em>None</em></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">inInterceptors</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Since Camel 2.12.4</strong><span> Set the
inInterceptors to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1"
class="confluenceTd">inIntercept
 ors=#MyInterceptors</td><td colspan="1" rowspan="1" class="confluenceTd">No</td><td
colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">outInterceptors</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span>
Set the outInterceptor to the CxfRs endpoint.</span></td><td colspan="1" rowspan="1"
class="confluenceTd"><span>outInterceptors=#MyInterceptors</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><span>No</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">inFaultInterceptors</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span>
Set the inFaultInterceptors to the CxfRs endpoint.</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><span>inFaultInterceptors=#MyInterceptors</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><spa
 n>No</span></td><td colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">outFaultIntercetpros</td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Since Camel 2.12.4</strong><span>
Set the outFaultInterceptors to the CxfRs endpoint.</span></td><td colspan="1"
rowspan="1" class="confluenceTd"><span>outFaultInterceptors=#MyInterceptors</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><span>No</span></td><td
colspan="1" rowspan="1" class="confluenceTd"><em>None</em></td></tr></tbody></table></div><p>You
can also configure the CXF REST endpoint through the spring configuration. Since there are
lots of difference between the CXF REST client and CXF REST Server, we provide different configuration
for them.<br clear="none"> Please check out the <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">schema
fil
 e</a> and <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF
REST user guide</a> for more information.</p><h3 id="CXFRS-HowtoconfiguretheRESTendpointinCamel">How
to configure the REST endpoint in Camel</h3><p>In <a shape="rect" class="external-link"
href="http://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/main/resources/schema/cxfEndpoint.xsd">camel-cxf
schema file</a>, there are two elements for the REST endpoint definition. <strong>cxf:rsServer</strong>
for REST consumer, <strong>cxf:rsClient</strong> for REST producer.<br clear="none">
You can find a Camel REST service route configuration example here.</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[
 &lt;beans xmlns=&quot;http://www.springframework.org/schema/beans&quot;
        xmlns:xsi=&quot;http://www.w3.org/2001/XMLSchema-instance&quot;



Mime
View raw message