You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2014/01/06 05:26:45 UTC
svn commit: r892936 - in /websites/production/camel/content: building.html
cache/main.pageCache cxfrs.html
Author: buildbot
Date: Mon Jan 6 04:26:45 2014
New Revision: 892936
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/building.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/cxfrs.html
Modified: websites/production/camel/content/building.html
==============================================================================
--- websites/production/camel/content/building.html (original)
+++ websites/production/camel/content/building.html Mon Jan 6 04:26:45 2014
@@ -41,6 +41,7 @@
<script src='http://camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
<script src='http://camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
<script src='http://camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+ <script src='http://camel.apache.org/styles/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
<script type="text/javascript">
SyntaxHighlighter.defaults['toolbar'] = false;
@@ -85,138 +86,45 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Building-BuildingCamelfromSource">Building Camel from Source</h2>
-
-<p>Camel uses <a shape="rect" class="external-link" href="http://maven.apache.org/">Maven</a> as its build and management tool. If you don't fancy using Maven you can use your IDE directly or <a shape="rect" href="download.html">Download</a> a distribution or JAR.</p>
-
-<h3 id="Building-Prequisites">Prequisites</h3>
-
-<p><strong>Required:</strong></p>
-<ul><li>Download and <a shape="rect" class="external-link" href="http://maven.apache.org/download.html">install Maven</a>.<br clear="none">
- (Maven [3.0.2,3.1.0) is required to build Camel 2.10 onwards).<br clear="none">
- (Maven [3.0.4,3.1.0] is required to build Camel 2.11 onwards).</li><li>Get the latest <a shape="rect" href="source.html">Source</a></li><li>Java 1.6<br clear="none">
- (Java 1.7 is supported from Camel 2.10 onwards)</li></ul>
-
-
-<p><strong>Optional:</strong></p>
-<ul><li><a shape="rect" class="external-link" href="http://www.princexml.com/download/" rel="nofollow">Prince</a> should be in the executable PATH to generate the PDF documentation</li></ul>
-
-
-
-<h3 id="Building-Mavenoptions">Maven options</h3>
-
-<p>To build camel maven has to be configured to use more memory</p>
-
-<h5 id="Building-Unix/Linux/Mac">Unix/Linux/Mac</h5>
-<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[
-export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"
+<div class="wiki-content maincontent"><h2 id="Building-BuildingCamelfromSource">Building Camel from Source</h2><p>Camel uses <a shape="rect" class="external-link" href="http://maven.apache.org/">Maven</a> as its build and management tool. If you don't fancy using Maven you can use your IDE directly or <a shape="rect" href="download.html">Download</a> a distribution or JAR.</p><h3 id="Building-Prequisites">Prequisites</h3><p><strong>Required:</strong></p><ul><li>Download and <a shape="rect" class="external-link" href="http://maven.apache.org/download.html">install Maven</a>.<br clear="none"> (Maven [3.0.2,3.1.0) is required to build Camel 2.10 onwards).<br clear="none"> (Maven [3.0.4,3.1.0] is required to build Camel 2.11 onwards).</li><li>Get the latest <a shape="rect" href="source.html">Source</a></li><li>Java 1.6<br clear="none"> (Java 1.7 is supported from Camel 2.10 onwards)</li></ul><p><strong>Optional:</strong></p><ul><li><a shape="rect" class="external-link" href="http://www.
princexml.com/download/" rel="nofollow">Prince</a> should be in the executable PATH to generate the PDF documentation</li></ul><h3 id="Building-Mavenoptions">Maven options</h3><p>To build camel maven has to be configured to use more memory</p><h5 id="Building-Unix/Linux/Mac">Unix/Linux/Mac</h5><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=512m"
]]></script>
-</div></div>
-<h5 id="Building-Windows">Windows</h5>
-<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[
-set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=512m
+</div></div><h5 id="Building-Windows">Windows</h5><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[set MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=512m
]]></script>
-</div></div>
-
-<h3 id="Building-Anormalbuild">A normal build</h3>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install
+</div></div><h3 id="Building-Anormalbuild">A normal build</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install
]]></script>
-</div></div>
-
-<h3 id="Building-Anormalbuildwithoutrunningtests">A normal build without running tests</h3>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install -Pfastinstall
+</div></div><h3 id="Building-Anormalbuildwithoutrunningtests">A normal build without running tests</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pfastinstall
]]></script>
-</div></div>
-
-<h3 id="Building-Anormalbuildwithoutrunningtestsbutcheckstyleverificationenabled">A normal build without running tests but checkstyle verification enabled</h3>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install -Pfastinstall,sourcecheck
+</div></div><h3 id="Building-Anormalbuildwithoutrunningtestsbutcheckstyleverificationenabled">A normal build without running tests but checkstyle verification enabled</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pfastinstall,sourcecheck
]]></script>
-</div></div>
-
-<h3 id="Building-DoingaQuickBuild">Doing a Quick Build</h3>
-<p><strong>Available as of Camel 2.6</strong></p>
-
-<p>The following skips building the manual, the distro and does not execute the unit tests.</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[
-mvn install -Pfastinstall
+</div></div><h3 id="Building-DoingaQuickBuild">Doing a Quick Build</h3><p><strong>Available as of Camel 2.6</strong></p><p>The following skips building the manual, the distro and does not execute the unit tests.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn install -Pfastinstall
]]></script>
-</div></div>
-
-<h3 id="Building-UsinganIDE">Using an IDE</h3>
-
-<p>If you prefer to use an IDE then you can auto-generate the IDE's project files using maven plugins. e.g.</p>
-
-<h4 id="Building-IntelliJ">IntelliJ</h4>
-<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[
-mvn idea:idea
+</div></div><h3 id="Building-UsinganIDE">Using an IDE</h3><p>If you prefer to use an IDE then you can auto-generate the IDE's project files using maven plugins. e.g.</p><h4 id="Building-IntelliJ">IntelliJ</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn idea:idea
]]></script>
-</div></div>
-
-<h4 id="Building-Eclipse">Eclipse</h4>
-<p>There are several ways to import the projects into Eclipse.</p>
-<h5 id="Building-m2e">m2e</h5>
-<p>At this point, usage of the m2e plugins to import Camel into Eclipse does not work due to plugins without LifeCycle hints, bundle plugin configuration problems, etc... Patches, notes, etc... to help get this supported would be more than welcome.</p>
-
-<h5 id="Building-maven-eclipse-plugin">maven-eclipse-plugin</h5>
-<p>The maven-eclipse-plugin can be used to generate the .classpath/.project/.settings file that Eclipse need. To do this, run:</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[
-mvn process-test-sources eclipse:eclipse
+</div></div><h4 id="Building-Eclipse">Eclipse</h4><p>There are several ways to import the projects into Eclipse.</p><h5 id="Building-m2e">m2e</h5><p>At this point, usage of the m2e plugins to import Camel into Eclipse does not work due to plugins without LifeCycle hints, bundle plugin configuration problems, etc... Patches, notes, etc... to help get this supported would be more than welcome.</p><h5 id="Building-maven-eclipse-plugin">maven-eclipse-plugin</h5><p>The maven-eclipse-plugin can be used to generate the .classpath/.project/.settings file that Eclipse need. To do this, run:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn process-test-sources eclipse:eclipse
]]></script>
-</div></div>
-
- <div class="aui-message success shadowed information-macro">
+</div></div> <div class="aui-message success shadowed information-macro">
<p class="title">Enable the apt Profile explicitly if using Java 6</p>
<span class="aui-icon icon-success">Icon</span>
<div class="message-content">
-
-<p>Per default this profile is enabled <strong>only</strong> when using Java 7+ however for many of the Camel components you would still need the <code>org.apache.camel:spi-annotations</code> Maven module on the class path inside the generated <code>.classpath</code>. To force this on Java 6 do:</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn -Papt process-test-sources eclipse:eclipse
+ <p>Per default this profile is enabled <strong>only</strong> when using Java 7+ however for many of the Camel components you would still need the <code>org.apache.camel:spi-annotations</code> Maven module on the class path inside the generated <code>.classpath</code>. To force this on Java 6 do:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn -Papt process-test-sources eclipse:eclipse
]]></script>
-</div></div>
-<p>As otherwise some of the Camel components inside your eclipse workspace would not compile (when using Java 6) because the <code>org.apache.camel:spi-annotations</code> Maven module would be missing on the class path.</p>
+</div></div><p>As otherwise some of the Camel components inside your eclipse workspace would not compile (when using Java 6) because the <code>org.apache.camel:spi-annotations</code> Maven module would be missing on the class path.</p>
</div>
</div>
-
-
-<p>or</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn -Psetup.eclipse -Declipse.workspace.dir=/path/to/your/workspace
+<p>or</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn -Psetup.eclipse -Declipse.workspace.dir=/path/to/your/workspace
]]></script>
-</div></div>
-
-<p>The latter is recommended as it would completely setup the workspace for you as well as provide options to wire in other projects also found in your workspace.</p>
-
-<p>After running the above command, from within Eclipse, do "File -> Import -> Existing Projects into Workspace", select the root camel checkout location and Eclipse should find all the projects. </p>
-
-<h5 id="Building-AddingCamelEclipsetemplatestoyourworkspace">Adding Camel Eclipse templates to your workspace</h5>
-
-<p>The above mentioned setup.eclipse profile does a few additional things to your workspace:</p>
-
-<ol><li>Adds the Camel code templates (see <a shape="rect" class="external-link" href="http://janstey.blogspot.com/2008/08/eclipse-templates-for-apache-camel.html" rel="nofollow">here</a>)</li><li>Sets the M2_REPO variable in the workspace that points to your local Maven repository (i.e., <code>~/.m2/repository</code> on Unix and <code>c:\Documents and Settings\<user>\.m2\repository</code> on Windows) which allows the jars to be resolved.</li></ol>
-
-
-<h5 id="Building-Hint:specifytheworkspacelocationinyour.m2/settings.xml">Hint: specify the workspace location in your .m2/settings.xml</h5>
-<p>You can add a profile to your .m2/settings.xml to specify your eclipse workspace location so you can avoid having to type that each time you need to update the projects.</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[
-<profiles>
+</div></div><p>The latter is recommended as it would completely setup the workspace for you as well as provide options to wire in other projects also found in your workspace.</p><p>After running the above command, from within Eclipse, do "File -> Import -> Existing Projects into Workspace", select the root camel checkout location and Eclipse should find all the projects.</p><h5 id="Building-AddingCamelEclipsetemplatestoyourworkspace">Adding Camel Eclipse templates to your workspace</h5><p>The above mentioned setup.eclipse profile does a few additional things to your workspace:</p><ol><li>Adds the Camel code templates (see <a shape="rect" class="external-link" href="http://janstey.blogspot.com/2008/08/eclipse-templates-for-apache-camel.html" rel="nofollow">here</a>)</li><li>Sets the M2_REPO variable in the workspace that points to your local Maven repository (i.e., <code>~/.m2/repository</code> on Unix and <code>c:\Documents and Settings\<user>\.m2\repository</code> on Wi
ndows) which allows the jars to be resolved.</li></ol><h5 id="Building-Hint:specifytheworkspacelocationinyour.m2/settings.xml">Hint: specify the workspace location in your .m2/settings.xml</h5><p>You can add a profile to your .m2/settings.xml to specify your eclipse workspace location so you can avoid having to type that each time you need to update the projects.</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[<profiles>
<profile>
<id>setup.eclipse</id>
<properties>
@@ -225,77 +133,34 @@ mvn -Psetup.eclipse -Declipse.workspace.
</profile>
</profiles>
]]></script>
-</div></div>
-
-<h3 id="Building-Buildingwithcheckstyle">Building with checkstyle</h3>
-
-<p>To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter</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[
-mvn -Psourcecheck clean install
+</div></div><h3 id="Building-Buildingwithcheckstyle">Building with checkstyle</h3><p>To enable source style checking with checkstyle, build Camel with the -Psourcecheck parameter</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn -Psourcecheck clean install
]]></script>
-</div></div>
-
-<h3 id="Building-Buildingsourcejars">Building source jars</h3>
-<p>If you want to build jar files with the source code, that for instance Eclipse can important so you can debug the Camel code as well. Then you can run this command from the camel root folder:</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[
-mvn clean source:jar install -Pfastinstall
+</div></div><h3 id="Building-Buildingsourcejars">Building source jars</h3><p>If you want to build jar files with the source code, that for instance Eclipse can important so you can debug the Camel code as well. Then you can run this command from the camel root folder:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean source:jar install -Pfastinstall
]]></script>
-</div></div>
-
-<h3 id="Building-BuildingwithSpring3.0">Building with Spring 3.0</h3>
-
- <div class="aui-message hint shadowed information-macro">
+</div></div><h3 id="Building-BuildingwithSpring3.0">Building with Spring 3.0</h3> <div class="aui-message hint shadowed information-macro">
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
-
-<p>Support for Spring 3.0 is deprecated from Camel 2.11 onwards.</p>
+ <p>Support for Spring 3.0 is deprecated from Camel 2.11 onwards.</p>
</div>
</div>
-
-
-<p>From Camel 2.11.0 onwards, if you want Camel to be build against Spring 3.0 you have to build with the maven profile <code>spring3.0</code>.</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install -Pspring3.0
+<p>From Camel 2.11.0 onwards, if you want Camel to be build against Spring 3.0 you have to build with the maven profile <code>spring3.0</code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pspring3.0
]]></script>
-</div></div>
-
-<h3 id="Building-BuildingwithSpring3.1">Building with Spring 3.1</h3>
-<p>From Camel 2.10.0 onwards, if you want Camel to be build against Spring 3.1 you have to build with the maven profile <code>spring3.1</code>.</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install -Pspring3.1
+</div></div><h3 id="Building-BuildingwithSpring3.1">Building with Spring 3.1</h3><p>From Camel 2.10.0 onwards, if you want Camel to be build against Spring 3.1 you have to build with the maven profile <code>spring3.1</code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pspring3.1
]]></script>
-</div></div>
-
-<p>From Camel 2.11.0 onwards, Spring 3.1 is the default.</p>
-
-<p><strong>Note:</strong> the <code>camel-test-spring</code> component requires to be built with Spring 3.1.</p>
-
-<h3 id="Building-BuildingwithSpring3.2">Building with Spring 3.2</h3>
-<p>From Camel 2.11.0 onwards, if you want Camel to be build against Spring 3.2 you have to build with the maven profile <code>spring3.2</code>.</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-mvn clean install -Pspring3.2
+</div></div><p>From Camel 2.11.0 onwards, Spring 3.1 is the default.</p><p><strong>Note:</strong> the <code>camel-test-spring</code> component requires to be built with Spring 3.1.</p><h3 id="Building-BuildingwithSpring3.2">Building with Spring 3.2</h3><p>From Camel 2.11.0 onwards, if you want Camel to be build against Spring 3.2 you have to build with the maven profile <code>spring3.2</code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pspring3.2
]]></script>
-</div></div>
-
-<p>From Camel 2.12.0 onwards, Spring 3.2 is the default.</p>
-
-<h3 id="Building-Workingwithfeatures">Working with features</h3>
-<p>If you change anything in the features.xml from <code>platform/karaf</code> you can run a validation step to ensure the generated features.xml file is correct. You can do this running the following maven goal from the <code>platform</code> directory.</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[
-mvn clean install -Pvalidate
+</div></div><p>From Camel 2.12.0 onwards, Spring 3.2 is the default.</p><p> </p><h3 id="Building-BuildingwithSpring4.0">Building with Spring 4.0</h3><p>From Camel 2.11.0 onwards, if you want Camel to be build against Spring 3.2 you have to build with the maven profile <code>spring3.2</code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pspring4
]]></script>
-</div></div>
-
-<h3 id="Building-SeeAlso">See Also</h3>
-
-<ul><li><a shape="rect" href="running-unit-tests.html">Running Unit Tests</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="examples.html">Examples</a></li></ul></div>
+</div></div><p>From Camel 2.12.0 onwards, Spring 3.2 is the default.</p><h3 id="Building-Workingwithfeatures">Working with features</h3><p>If you change anything in the features.xml from <code>platform/karaf</code> you can run a validation step to ensure the generated features.xml file is correct. You can do this running the following maven goal from the <code>platform</code> directory.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: text; gutter: false" type="syntaxhighlighter"><![CDATA[mvn clean install -Pvalidate
+]]></script>
+</div></div><h3 id="Building-SeeAlso">See Also</h3><ul><li><a shape="rect" href="running-unit-tests.html">Running Unit Tests</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="examples.html">Examples</a></li></ul></div>
</td>
<td valign="top">
<div class="navigation">
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 Mon Jan 6 04:26:45 2014
@@ -86,70 +86,34 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="CXFRS-CXFRSComponent">CXFRS Component</h2>
-
- <div class="aui-message warning shadowed information-macro">
+<div class="wiki-content maincontent"><h2 id="CXFRS-CXFRSComponent">CXFRS Component</h2> <div class="aui-message warning shadowed information-macro">
<span class="aui-icon icon-warning">Icon</span>
<div class="message-content">
-
-<p>When using CXF as a consumer, the <a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you to factor out how message payloads are received from their processing as a RESTful or SOAP web service. This has the potential of using a multitude of transports to consume web services. The bean component's configuration is also simpler and provides the fastest method to implement web services using Camel and CXF.</p>
+ <p>When using CXF as a consumer, the <a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you to factor out how message payloads are received from their processing as a RESTful or SOAP web service. This has the potential of using a multitude of transports to consume web services. The bean component's configuration is also simpler and provides the fastest method to implement web services using Camel and CXF.</p>
</div>
</div>
-
-
-<p>The <strong>cxfrs:</strong> component provides integration with <a shape="rect" class="external-link" href="http://incubator.apache.org/cxf/">Apache CXF</a> for connecting to JAX-RS services hosted in CXF.</p>
-
-<p>Maven users will need to add the following dependency to their pom.xml 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>
+<p>The <strong>cxfrs:</strong> component provides integration with <a shape="rect" class="external-link" href="http://incubator.apache.org/cxf/">Apache CXF</a> for connecting to JAX-RS services hosted in CXF.</p><p>Maven users will need to add the following dependency to their pom.xml 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-cxf</artifactId>
<version>x.x.x</version> <!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</div></div>
-
-<h3 id="CXFRS-URIformat">URI format</h3>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
-cxfrs://address?options
+</div></div><h3 id="CXFRS-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[cxfrs://address?options
]]></script>
-</div></div>
-<p>Where <strong>address</strong> represents the CXF endpoint's address</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:rsEndpoint
+</div></div><p>Where <strong>address</strong> represents the CXF endpoint's address</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:rsEndpoint
]]></script>
-</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
+</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="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> 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">
+</div></div><h3 id="CXFRS-Options">Options</h3><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.  The implementation caches CXF clients or ClientFactoryBean in CxfProvider and CxfRsProvider.  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" type="square"><li><code>SimpleConsumer</code> => 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> => 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> Add custom JAX-RS providers to the list of providers. </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></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 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">
+<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">
<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -201,87 +165,25 @@ You can find a Camel REST service route
</beans>
]]></script>
-</div></div>
-
-<h3 id="CXFRS-ConsumingaRESTRequest-SimpleBindingStyle">Consuming a REST Request - Simple Binding Style</h3>
-
-<p><strong>Available as of Camel 2.11</strong></p>
-
-<p>The <code>Default</code> binding style is rather low-level, requiring the user to manually process the <code>MessageContentsList</code> object coming into the route. Thus, it tightly couples the route logic with the method signature and parameter indices of the JAX-RS operation. Somewhat inelegant, difficult and error-prone.</p>
-
-<p>In contrast, the <code>SimpleConsumer</code> binding style performs the following mappings, in order to <strong>make the request data more accessible</strong> to you within the Camel Message:</p>
-
-<ul><li>JAX-RS Parameters (@HeaderParam, @QueryParam, etc.) are injected as IN message headers. The header name matches the value of the annotation.</li><li>The request entity (POJO or other type) becomes the IN message body. If a single entity cannot be identified in the JAX-RS method signature, it falls back to the original <code>MessageContentsList</code>.</li><li>Binary <code>@Multipart</code> body parts become IN message attachments, supporting <code>DataHandler</code>, <code>InputStream</code>, <code>DataSource</code> and CXF's <code>Attachment</code> class.</li><li>Non-binary <code>@Multipart</code> body parts are mapped as IN message headers. The header name matches the Body Part name.</li></ul>
-
-
-<p>Additionally, the following rules apply to the <strong>Response mapping</strong>:</p>
-
-<ul><li>If the message body type is different to <code>javax.ws.rs.core.Response</code> (user-built response), a new <code>Response</code> is created and the message body is set as the entity (so long it's not null). The response status code is taken from the <code>Exchange.HTTP_RESPONSE_CODE</code> header, or defaults to 200 OK if not present.</li><li>If the message body type is equal to <code>javax.ws.rs.core.Response</code>, it means that the user has built a custom response, and therefore it is respected and it becomes the final response.</li><li>In all cases, Camel headers permitted by custom or default <code>HeaderFilterStrategy</code> are added to the HTTP response.</li></ul>
-
-
-<h4 id="CXFRS-EnablingtheSimpleBindingStyle">Enabling the Simple Binding Style</h4>
-
-<p>This binding style can be activated by setting the <code>bindingStyle</code> parameter in the consumer endpoint to value <code>SimpleConsumer</code>:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
+</div></div><h3 id="CXFRS-ConsumingaRESTRequest-SimpleBindingStyle">Consuming a REST Request - Simple Binding Style</h3><p><strong>Available as of Camel 2.11</strong></p><p>The <code>Default</code> binding style is rather low-level, requiring the user to manually process the <code>MessageContentsList</code> object coming into the route. Thus, it tightly couples the route logic with the method signature and parameter indices of the JAX-RS operation. Somewhat inelegant, difficult and error-prone.</p><p>In contrast, the <code>SimpleConsumer</code> binding style performs the following mappings, in order to <strong>make the request data more accessible</strong> to you within the Camel Message:</p><ul><li>JAX-RS Parameters (@HeaderParam, @QueryParam, etc.) are injected as IN message headers. The header name matches the value of the annotation.</li><li>The request entity (POJO or other type) becomes the IN message body. If a single entity cannot be identified in the JAX-RS method signature
, it falls back to the original <code>MessageContentsList</code>.</li><li>Binary <code>@Multipart</code> body parts become IN message attachments, supporting <code>DataHandler</code>, <code>InputStream</code>, <code>DataSource</code> and CXF's <code>Attachment</code> class.</li><li>Non-binary <code>@Multipart</code> body parts are mapped as IN message headers. The header name matches the Body Part name.</li></ul><p>Additionally, the following rules apply to the <strong>Response mapping</strong>:</p><ul><li>If the message body type is different to <code>javax.ws.rs.core.Response</code> (user-built response), a new <code>Response</code> is created and the message body is set as the entity (so long it's not null). The response status code is taken from the <code>Exchange.HTTP_RESPONSE_CODE</code> header, or defaults to 200 OK if not present.</li><li>If the message body type is equal to <code>javax.ws.rs.core.Response</code>, it means that the user has built a custom response, and there
fore it is respected and it becomes the final response.</li><li>In all cases, Camel headers permitted by custom or default <code>HeaderFilterStrategy</code> are added to the HTTP response.</li></ul><h4 id="CXFRS-EnablingtheSimpleBindingStyle">Enabling the Simple Binding Style</h4><p>This binding style can be activated by setting the <code>bindingStyle</code> parameter in the consumer endpoint to value <code>SimpleConsumer</code>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
.to("log:TEST?showAll=true");
]]></script>
-</div></div>
-
-<h4 id="CXFRS-Examplesofrequestbindingwithdifferentmethodsignatures">Examples of request binding with different method signatures</h4>
-
-<p>Below is a list of method signatures along with the expected result from the Simple binding.</p>
-
-<p><strong><code>public Response doAction(BusinessObject request);</code></strong><br clear="none">
-Request payload is placed in IN message body, replacing the original MessageContentsList.</p>
-
-<p><strong><code>public Response doAction(BusinessObject request, @HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);</code></strong><br clear="none">
-Request payload placed in IN message body, replacing the original MessageContentsList. Both request params mapped as IN message headers with names abcd and defg.</p>
-
-<p><strong><code>public Response doAction(@HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);</code></strong><br clear="none">
-Both request params mapped as IN message headers with names abcd and defg. The original MessageContentsList is preserved, even though it only contains the 2 parameters.</p>
-
-<p><strong><code>public Response doAction(@Multipart(value="body1") BusinessObject request, @Multipart(value="body2") BusinessObject request2);</code></strong><br clear="none">
-The first parameter is transferred as a header with name body1, and the second one is mapped as header body2. The original MessageContentsList is preserved as the IN message body.</p>
-
-<p><strong><code>public Response doAction(InputStream abcd);</code></strong><br clear="none">
-The InputStream is unwrapped from the MessageContentsList and preserved as the IN message body. </p>
-
-<p><strong><code>public Response doAction(DataHandler abcd);</code></strong><br clear="none">
-The DataHandler is unwrapped from the MessageContentsList and preserved as the IN message body. </p>
-
-<h4 id="CXFRS-MoreexamplesoftheSimpleBindingStyle">More examples of the Simple Binding Style</h4>
-
-<p>Given a JAX-RS resource class with this method:</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[
- @POST @Path("/customers/{type}")
+</div></div><h4 id="CXFRS-Examplesofrequestbindingwithdifferentmethodsignatures">Examples of request binding with different method signatures</h4><p>Below is a list of method signatures along with the expected result from the Simple binding.</p><p><strong><code>public Response doAction(BusinessObject request);</code></strong><br clear="none"> Request payload is placed in IN message body, replacing the original MessageContentsList.</p><p><strong><code>public Response doAction(BusinessObject request, @HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);</code></strong><br clear="none"> Request payload placed in IN message body, replacing the original MessageContentsList. Both request params mapped as IN message headers with names abcd and defg.</p><p><strong><code>public Response doAction(@HeaderParam("abcd") String abcd, @QueryParam("defg") String defg);</code></strong><br clear="none"> Both request params mapped as IN message headers with names abcd and defg. The origi
nal MessageContentsList is preserved, even though it only contains the 2 parameters.</p><p><strong><code>public Response doAction(@Multipart(value="body1") BusinessObject request, @Multipart(value="body2") BusinessObject request2);</code></strong><br clear="none"> The first parameter is transferred as a header with name body1, and the second one is mapped as header body2. The original MessageContentsList is preserved as the IN message body.</p><p><strong><code>public Response doAction(InputStream abcd);</code></strong><br clear="none"> The InputStream is unwrapped from the MessageContentsList and preserved as the IN message body.</p><p><strong><code>public Response doAction(DataHandler abcd);</code></strong><br clear="none"> The DataHandler is unwrapped from the MessageContentsList and preserved as the IN message body.</p><h4 id="CXFRS-MoreexamplesoftheSimpleBindingStyle">More examples of the Simple Binding Style</h4><p>Given a JAX-RS resource class with this method:</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[ @POST @Path("/customers/{type}")
public Response newCustomer(Customer customer, @PathParam("type") String type, @QueryParam("active") @DefaultValue("true") boolean active) {
return null;
}
]]></script>
-</div></div>
-
-<p>Serviced by the following route:</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
- from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
+</div></div><p>Serviced by the following route:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[ from("cxfrs:bean:rsServer?bindingStyle=SimpleConsumer")
.recipientList(simple("direct:${header.operationName}"));
from("direct:newCustomer")
.log("Request: type=${header.type}, active=${header.active}, customerData=${body}");
]]></script>
-</div></div>
-
-<p>The following HTTP request with XML payload (given that the Customer DTO is JAXB-annotated):</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[
-POST /customers/gold?active=true
+</div></div><p>The following HTTP request with XML payload (given that the Customer DTO is JAXB-annotated):</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[POST /customers/gold?active=true
Payload:
<Customer>
@@ -290,26 +192,10 @@ Payload:
<project>Apache Camel</project>
</Customer>
]]></script>
-</div></div>
-
-<p>Will print the 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[
-Request: type=gold, active=true, customerData=<Customer.toString() representation>
+</div></div><p>Will print the message:</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[Request: type=gold, active=true, customerData=<Customer.toString() representation>
]]></script>
-</div></div>
-
-<p>For more examples on how to process requests and write responses can be found <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/jaxrs/simplebinding/">here</a>.</p>
-
-<h3 id="CXFRS-ConsumingaRESTRequest-DefaultBindingStyle">Consuming a REST Request - Default Binding Style</h3>
-
-<p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> implements the <a shape="rect" class="external-link" href="https://jsr311.dev.java.net/" rel="nofollow">JAXRS(JSR311) API</a>, so we can export the resources classes as a REST service. And we leverage the <a shape="rect" class="external-link" href="http://cwiki.apache.org/confluence/display/CXF20DOC/Invokers">CXF Invoker API</a> to turn a REST request into a normal Java object method invocation.<br clear="none">
-Unlike the <code>camel-restlet</code>, you don't need to specify the URI template within your restlet endpoint, CXF take care of the REST request URI to resource class method mapping according to the JSR311 specification. All you need to do in Camel is delegate this method request to a right processor or endpoint.</p>
-
-<p>Here is an example of a CXFRS route...</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>For more examples on how to process requests and write responses can be found <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-cxf/src/test/java/org/apache/camel/component/cxf/jaxrs/simplebinding/">here</a>.</p><h3 id="CXFRS-ConsumingaRESTRequest-DefaultBindingStyle">Consuming a REST Request - Default Binding Style</h3><p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> implements the <a shape="rect" class="external-link" href="https://jsr311.dev.java.net/" rel="nofollow">JAXRS(JSR311) API</a>, so we can export the resources classes as a REST service. And we leverage the <a shape="rect" class="external-link" href="http://cwiki.apache.org/confluence/display/CXF20DOC/Invokers">CXF Invoker API</a> to turn a REST request into a normal Java object method invocation.<br clear="none"> Unlike the <code>camel-restlet</code>, you don't need to specify the UR
I template within your restlet endpoint, CXF take care of the REST request URI to resource class method mapping according to the JSR311 specification. All you need to do in Camel is delegate this method request to a right processor or endpoint.</p><p>Here is an example of a CXFRS route...</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[
private static final String CXF_RS_ENDPOINT_URI = "cxfrs://http://localhost:" + CXT + "/rest?resourceClasses=org.apache.camel.component.cxf.jaxrs.testbean.CustomerServiceResource";
@@ -378,20 +264,13 @@ protected RouteBuilder createRouteBuilde
};
}
]]></script>
-</div></div>
-
-<p>And the corresponding resource class used to configure the endpoint...</p>
-
- <div class="aui-message hint shadowed information-macro">
+</div></div><p>And the corresponding resource class used to configure the endpoint...</p> <div class="aui-message hint shadowed information-macro">
<p class="title">note about the resource class</p>
<span class="aui-icon icon-hint">Icon</span>
<div class="message-content">
-
-<p>This class is used to configure the JAXRS properties ONLY. The methods will NOT be executed during the routing of messages to the endpoint, the route itself is responsible for ALL processing instead.</p>
+ <p>This class is used to configure the JAXRS properties ONLY. The methods will NOT be executed during the routing of messages to the endpoint, the route itself is responsible for ALL processing instead.</p>
</div>
</div>
-
-
<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[
@Path("/customerservice/")
@@ -406,16 +285,7 @@ public interface CustomerServiceResource
Response updateCustomer(Customer customer);
}
]]></script>
-</div></div>
-
-<h3 id="CXFRS-HowtoinvoketheRESTservicethroughcamel-cxfrsproducer">How to invoke the REST service through camel-cxfrs producer</h3>
-
-<p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> implements <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html#JAX-RS-ProxybasedAPI">a proxy based client API</a>, with this API you can invoke the remote REST service through a proxy.<br clear="none">
-<code>camel-cxfrs</code> producer is based on this <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html#JAX-RS-ProxybasedAPI">proxy API</a>.<br clear="none">
-So, you just need to specify the operation name in the message header and prepare the parameter in the message body, camel-cxfrs producer will generate right REST request for you.</p>
-
-<p>Here is an example</p>
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="CXFRS-HowtoinvoketheRESTservicethroughcamel-cxfrsproducer">How to invoke the REST service through camel-cxfrs producer</h3><p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> implements <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html#JAX-RS-ProxybasedAPI">a proxy based client API</a>, with this API you can invoke the remote REST service through a proxy.<br clear="none"> <code>camel-cxfrs</code> producer is based on this <a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html#JAX-RS-ProxybasedAPI">proxy API</a>.<br clear="none"> So, you just need to specify the operation name in the message header and prepare the parameter in the message body, camel-cxfrs producer will generate right REST request for you.</p><p>Here is an example</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"
>
<script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[
Exchange exchange = template.send("direct://proxy", new Processor() {
public void process(Exchange exchange) throws Exception {
@@ -443,10 +313,7 @@ assertEquals("Get a wrong customer
assertEquals("Get a wrong response code", 200, exchange.getOut().getHeader(Exchange.HTTP_RESPONSE_CODE));
assertEquals("Get a wrong header value", "value", exchange.getOut().getHeader("key"));
]]></script>
-</div></div>
-<p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> also provides <a shape="rect" href="http://cxf.apache.org/docs/jax-rs.html#JAX-RS-HTTPcentricclients">a http centric client API</a>, You can also invoke this API from <code>camel-cxfrs</code> producer. You need to specify the HTTP_PATH and Http method and let the the producer know to use the http centric client by using the URI option <strong>httpClientAPI</strong> or set the message header with CxfConstants.CAMEL_CXF_RS_USING_HTTP_API. You can turn the response object to the type class that you specify with CxfConstants.CAMEL_CXF_RS_RESPONSE_CLASS.</p>
-
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p><a shape="rect" class="external-link" href="http://cwiki.apache.org/CXF20DOC/jax-rs.html">CXF JAXRS front end</a> also provides <a shape="rect" href="http://cxf.apache.org/docs/jax-rs.html#JAX-RS-HTTPcentricclients">a http centric client API</a>, You can also invoke this API from <code>camel-cxfrs</code> producer. You need to specify the HTTP_PATH and Http method and let the the producer know to use the http centric client by using the URI option <strong>httpClientAPI</strong> or set the message header with CxfConstants.CAMEL_CXF_RS_USING_HTTP_API. You can turn the response object to the type class that you specify with CxfConstants.CAMEL_CXF_RS_RESPONSE_CLASS.</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[
Exchange exchange = template.send("direct://http", new Processor() {
public void process(Exchange exchange) throws Exception {
@@ -477,14 +344,11 @@ assertEquals("Get a wrong customer
assertEquals("Get a wrong response code", 200, exchange.getOut().getHeader(Exchange.HTTP_RESPONSE_CODE));
assertEquals("Get a wrong header value", "value", exchange.getOut().getHeader("key"));
]]></script>
-</div></div>
-<p>From Camel 2.1, we also support to specify the query parameters from cxfrs URI for the CXFRS http centric client.<br clear="none">
-</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>From Camel 2.1, we also support to specify the query parameters from cxfrs URI for the CXFRS http centric client.</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[
Exchange exchange = template.send("cxfrs://http://localhost:" + getPort2() + "/" + getClass().getSimpleName() + "/testQuery?httpClientAPI=true&q1=12&q2=13"
]]></script>
-</div></div>To support the Dynamical routing, you can override the URI's query parameters by using the CxfConstants.CAMEL_CXF_RS_QUERY_MAP header to set the parameter map for it.
-<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>To support the Dynamical routing, you can override the URI's query parameters by using the CxfConstants.CAMEL_CXF_RS_QUERY_MAP header to set the parameter map for it.</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, String> queryMap = new LinkedHashMap<String, String>();
queryMap.put("q1", "new");