Modified: websites/production/camel/content/book-in-one-page.html ============================================================================== --- websites/production/camel/content/book-in-one-page.html (original) +++ websites/production/camel/content/book-in-one-page.html Fri Dec 19 20:19:14 2014 @@ -2097,7 +2097,7 @@ When writing software these days, its im <p>This functionality is deprecated and to be removed in future Camel releases.</p> </div> </div> -<p> </p><p>Camel supports the visualisation of your <a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a> using the <a shape="rect" class="external-link" href="http://graphviz.org" rel="nofollow">GraphViz</a> DOT files which can either be rendered directly via a suitable GraphViz tool or turned into HTML, PNG or SVG files via the <a shape="rect" href="camel-maven-plugin.html">Camel Maven Plugin</a>.</p><p>Here is a <a shape="rect" class="external-link" href="http://activemq.apache.org/camel/maven/camel-spring/cameldoc/index.html">typical example</a> of the kind of thing we can generate</p><p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/64021/org.apache.camel.example.docs.ContentBasedRouteRoute.png?version=1&modificationDate=1229506014000&api=v2" data-image-src="/confluence/download/attachments/64021/org.apache.camel.example.docs.ContentBasedRouteRoute.png?version=1&modi ficationDate=1229506014000&api=v2"></p><p>If you click on <a shape="rect" class="external-link" href="http://activemq.apache.org/camel/maven/examples/camel-example-docs/cameldoc/main/routes.html">the actual generated html</a>you will see that you can navigate from an EIP node to its pattern page, along with getting hover-over tool tips ec.</p><h3 id="BookInOnePage-Howtogenerate">How to generate</h3><p>See <a shape="rect" href="camel-dot-maven-goal.html">Camel Dot Maven Goal</a> or the other maven goals <a shape="rect" href="camel-maven-plugin.html">Camel Maven Plugin</a></p><h3 id="BookInOnePage-ForOSXusers">For OS X users</h3><p>If you are using OS X then you can open the DOT file using <a shape="rect" class="external-link" href="http://www.pixelglow.com/graphviz/" rel="nofollow">graphviz</a> which will then automatically re-render if it changes, so you end up with a real time graphical representation of the topic and queue hierarchies!</p><p>Also if you want to edit the layout a little before adding it to a wiki to distribute to your team, open the DOT file with <a shape="rect" class="external-link" href="http://www.omnigroup.com/applications/omnigraffle/" rel="nofollow">OmniGraffle</a> then just edit away <img class="emoticon emoticon-smile" src="https://cwiki.apache.org/confluence/s/en_GB-1988229788/4109/76e0dbb30bc8580e459c201f3535d84f9283a9ac.1/_/images/icons/emoticons/smile.png" data-emoticon-name="smile" alt="(smile)"></p> +<p> </p><p>Camel supports the visualisation of your <a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a> using the <a shape="rect" class="external-link" href="http://graphviz.org" rel="nofollow">GraphViz</a> DOT files which can either be rendered directly via a suitable GraphViz tool or turned into HTML, PNG or SVG files via the <a shape="rect" href="camel-maven-plugin.html">Camel Maven Plugin</a>.</p><p>Here is a <a shape="rect" class="external-link" href="http://activemq.apache.org/camel/maven/camel-spring/cameldoc/index.html">typical example</a> of the kind of thing we can generate</p><p><img class="confluence-embedded-image" src="book-in-one-page.data/org.apache.camel.example.docs.ContentBasedRouteRoute.png" data-image-src="/confluence/download/attachments/64021/org.apache.camel.example.docs.ContentBasedRouteRoute.png?version=1&modificationDate=1229506014000&api=v2"></p><p>If you click on <a shape="rect" class="external-lin k" href="http://activemq.apache.org/camel/maven/examples/camel-example-docs/cameldoc/main/routes.html">the actual generated html</a>you will see that you can navigate from an EIP node to its pattern page, along with getting hover-over tool tips ec.</p><h3 id="BookInOnePage-Howtogenerate">How to generate</h3><p>See <a shape="rect" href="camel-dot-maven-goal.html">Camel Dot Maven Goal</a> or the other maven goals <a shape="rect" href="camel-maven-plugin.html">Camel Maven Plugin</a></p><h3 id="BookInOnePage-ForOSXusers">For OS X users</h3><p>If you are using OS X then you can open the DOT file using <a shape="rect" class="external-link" href="http://www.pixelglow.com/graphviz/" rel="nofollow">graphviz</a> which will then automatically re-render if it changes, so you end up with a real time graphical representation of the topic and queue hierarchies!</p><p>Also if you want to edit the layout a little before adding it to a wiki to distribute to your team, open the DOT file with <a shape= "rect" class="external-link" href="http://www.omnigroup.com/applications/omnigraffle/" rel="nofollow">OmniGraffle</a> then just edit away <img class="emoticon emoticon-smile" src="https://cwiki.apache.org/confluence/s/en_GB-1988229788/4109/76e0dbb30bc8580e459c201f3535d84f9283a9ac.1/_/images/icons/emoticons/smile.png" data-emoticon-name="smile" alt="(smile)"></p> <h2 id="BookInOnePage-BusinessActivityMonitoring">Business Activity Monitoring </h2> <p>The <strong>Camel BAM</strong> module provides a Business Activity Monitoring (BAM) framework for testing business processes across multiple message exchanges on different <a shape="rect" href="endpoint.html">Endpoint</a> instances.</p> @@ -3835,7 +3835,7 @@ from("jetty:http://localhost:8080/s <p>The sequence diagram would look something like this:</p> -<p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/68592/simple-async-route.png?version=1&modificationDate=1192103278000&api=v2" data-image-src="/confluence/download/attachments/68592/simple-async-route.png?version=1&modificationDate=1192103278000&api=v2"></p> +<p><img class="confluence-embedded-image" src="book-in-one-page.data/simple-async-route.png" data-image-src="/confluence/download/attachments/68592/simple-async-route.png?version=1&modificationDate=1192103278000&api=v2"></p> <p>The diagram simplifies things by making it looks like processors implement the AsyncCallback interface when in reality the AsyncCallback interfaces are inline inner classes, but it illustrates the processing flow and shows how 2 separate threads are used to complete the processing of the original http request. The first thread is synchronous up until processing hits the jhc producer which issues the http request. It then reports that the exchange processing will complete async since it will use a NIO to complete getting the response back. Once the jhc component has received a full response it uses <code>AsyncCallback.done()</code> method to notify the caller. These callback notifications continue up until it reaches the original jetty consumer which then un-parks the http request and completes it by providing the response.</p> @@ -3854,7 +3854,7 @@ from("file:data/in").process(n <p>The sequence diagram would look something like this:</p> -<p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/68592/camel-mixed-processors.png?version=1&modificationDate=1192110286000&api=v2" data-image-src="/confluence/download/attachments/68592/camel-mixed-processors.png?version=1&modificationDate=1192110286000&api=v2"></p> +<p><img class="confluence-embedded-image" src="book-in-one-page.data/camel-mixed-processors.png" data-image-src="/confluence/download/attachments/68592/camel-mixed-processors.png?version=1&modificationDate=1192110286000&api=v2"></p> <p>You would actually have multiple threads executing the 2nd part of the thread sequence.</p> @@ -4126,11 +4126,11 @@ While not actual tutorials you might fin </div> </div> <h2 id="BookInOnePage-Preface">Preface</h2><p>This tutorial aims to guide the reader through the stages of creating a project which uses Camel to facilitate the routing of messages from a JMS queue to a <a shape="rect" class="external-link" href="http://www.springramework.org" rel="nofollow">Spring</a> service. The route works in a synchronous fashion returning a response to the client.</p><p><style type="text/css">/*<![CDATA[*/ -div.rbtoc1418897856650 {padding: 0px;} -div.rbtoc1418897856650 ul {list-style: disc;margin-left: 0px;} -div.rbtoc1418897856650 li {margin-left: 0px;padding-left: 0px;} +div.rbtoc1419020271046 {padding: 0px;} +div.rbtoc1419020271046 ul {list-style: disc;margin-left: 0px;} +div.rbtoc1419020271046 li {margin-left: 0px;padding-left: 0px;} -/*]]>*/</style></p><div class="toc-macro rbtoc1418897856650"> +/*]]>*/</style></p><div class="toc-macro rbtoc1419020271046"> <ul class="toc-indentation"><li><a shape="rect" href="#Tutorial-JmsRemoting-TutorialonSpringRemotingwithJMS">Tutorial on Spring Remoting with JMS</a></li><li><a shape="rect" href="#Tutorial-JmsRemoting-Preface">Preface</a></li><li><a shape="rect" href="#Tutorial-JmsRemoting-Prerequisites">Prerequisites</a></li><li><a shape="rect" href="#Tutorial-JmsRemoting-Distribution">Distribution</a></li><li><a shape="rect" href="#Tutorial-JmsRemoting-About">About</a></li><li><a shape="rect" href="#Tutorial-JmsRemoting-CreatetheCamelProject">Create the Camel Project</a> <ul class="toc-indentation"><li><a shape="rect" href="#Tutorial-JmsRemoting-UpdatethePOMwithDependencies">Update the POM with Dependencies</a></li></ul> </li><li><a shape="rect" href="#Tutorial-JmsRemoting-WritingtheServer">Writing the Server</a> @@ -4397,7 +4397,7 @@ public static void main(final String[] a DefaultInstrumentationAgent INFO JMX connector thread started on service:jmx:rmi:///jndi/rmi://claus-acer:1099/jmxrmi/camel ... ]]></script> -</div></div><p>In the screenshot below we can see the route and its performance metrics:<br clear="none"> <img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/82923/jconsole_jms_tutorial.PNG?version=1&modificationDate=1214345078000&api=v2" data-image-src="/confluence/download/attachments/82923/jconsole_jms_tutorial.PNG?version=1&modificationDate=1214345078000&api=v2"></p><h2 id="BookInOnePage-SeeAlso.5">See Also</h2><ul><li><a shape="rect" class="external-link" href="http://aminsblog.wordpress.com/2008/05/06/15/" rel="nofollow">Spring Remoting with JMS Example</a> on <a shape="rect" class="external-link" href="http://aminsblog.wordpress.com/" rel="nofollow">Amin Abbaspour's Weblog</a></li></ul> +</div></div><p>In the screenshot below we can see the route and its performance metrics:<br clear="none"> <img class="confluence-embedded-image" src="book-in-one-page.data/jconsole_jms_tutorial.PNG" data-image-src="/confluence/download/attachments/82923/jconsole_jms_tutorial.PNG?version=1&modificationDate=1214345078000&api=v2"></p><h2 id="BookInOnePage-SeeAlso.5">See Also</h2><ul><li><a shape="rect" class="external-link" href="http://aminsblog.wordpress.com/2008/05/06/15/" rel="nofollow">Spring Remoting with JMS Example</a> on <a shape="rect" class="external-link" href="http://aminsblog.wordpress.com/" rel="nofollow">Amin Abbaspour's Weblog</a></li></ul> <h2 id="BookInOnePage-Tutorial-camel-example-reportincident">Tutorial - camel-example-reportincident</h2> @@ -4429,12 +4429,12 @@ DefaultInstrumentationAgent INFO JMX <p>The figure below illustrates this process. The end users reports the incidents using the client applications. The incident is sent to the central integration platform as webservice. The integration platform will process the incident and send an OK acknowledgment back to the client. Then the integration will transform the message to an email and send it to the administration mail server. The users in the administration will receive the emails and take it from there.</p> -<p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90663/tutorial_reportincident_usecase_overview.png?version=1&modificationDate=1216248762000&api=v2" data-image-src="/confluence/download/attachments/90663/tutorial_reportincident_usecase_overview.png?version=1&modificationDate=1216248762000&api=v2"></p> +<p><img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_usecase_overview.png" data-image-src="/confluence/download/attachments/90663/tutorial_reportincident_usecase_overview.png?version=1&modificationDate=1216248762000&api=v2"></p> <h3 id="BookInOnePage-InEIPpatterns">In EIP patterns</h3> <p>We distill the use case as <a shape="rect" class="external-link" href="http://www.enterpriseintegrationpatterns.com" rel="nofollow">EIP</a> patterns:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90663/tutorial_reportincident_usecase_eip2.png?version=1&modificationDate=1219119425000&api=v2" data-image-src="/confluence/download/attachments/90663/tutorial_reportincident_usecase_eip2.png?version=1&modificationDate=1219119425000&api=v2"></p> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_usecase_eip2.png" data-image-src="/confluence/download/attachments/90663/tutorial_reportincident_usecase_eip2.png?version=1&modificationDate=1219119425000&api=v2"></p> <h2 id="BookInOnePage-Parts">Parts</h2> @@ -4781,14 +4781,14 @@ public class ReportIncidentEndpointImpl Jetty is smart that it will list the correct URI on the page to our web application, so just click on the link. This is smart as you don't have to remember the exact web context URI for your application - just fire up the default page and Jetty will help you.</p> <p>So where is the damn webservice then? Well as we did configure the web.xml to instruct the CXF servlet to accept the pattern <code>/webservices/*</code> we should hit this URL to get the attention of CXF: <code><a shape="rect" class="external-link" href="http://localhost:8080/camel-example-reportincident/webservices" rel="nofollow">http://localhost:8080/camel-example-reportincident/webservices</a></code>.<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90920/tutorial_reportincident_cxf_servicelist2.png?version=1&modificationDate=1216677217000&api=v2" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_cxf_servicelist2.png?version=1&modificationDate=1216677217000&api=v2"><br clear="none"> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_cxf_servicelist2.png" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_cxf_servicelist2.png?version=1&modificationDate=1216677217000&api=v2"><br clear="none">  </p> <h3 id="BookInOnePage-Hittingthewebservice">Hitting the webservice</h3> <p>Now we have the webservice running in a standard .war application in a standard web container such as Jetty we would like to invoke the webservice and see if we get our code executed. Unfortunately this isn't the easiest task in the world - its not so easy as a REST URL, so we need tools for this. So we fire up our trusty webservice tool <a shape="rect" class="external-link" href="http://www.soapui.org/" rel="nofollow">SoapUI</a> and let it be the one to fire the webservice request and see the response.</p> <p>Using SoapUI we sent a request to our webservice and we got the expected OK response and the console outputs the System.out so we are ready to code.<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90920/tutorial_reportincident_soapui2.png?version=1&modificationDate=1216677174000&api=v2" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_soapui2.png?version=1&modificationDate=1216677174000&api=v2"><br clear="none"> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_soapui2.png" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_soapui2.png?version=1&modificationDate=1216677174000&api=v2"><br clear="none">  </p> <h3 id="BookInOnePage-RemoteDebugging">Remote Debugging</h3> @@ -4804,11 +4804,11 @@ MAVEN_OPTS=-Xmx512m -XX:MaxPermSize=128m <p>Then we can from our IDE attach a remote debugger and debug as we want.<br clear="none"> First we configure IDEA to attach to a remote debugger on port 5005:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_setup2.png?version=1&modificationDate=1216677205000&api=v2" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_setup2.png?version=1&modificationDate=1216677205000&api=v2"><br clear="none"> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_remotedebug_idea_setup2.png" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_setup2.png?version=1&modificationDate=1216677205000&api=v2"><br clear="none">  </p> <p>Then we set a breakpoint in our code <code>ReportIncidentEndpoint</code> and hit the SoapUI once again and we are breaked at the breakpoint where we can inspect the parameters:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_breakpoint2.png?version=1&modificationDate=1216677190000&api=v2" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_breakpoint2.png?version=1&modificationDate=1216677190000&api=v2"><br clear="none"> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_remotedebug_idea_breakpoint2.png" data-image-src="/confluence/download/attachments/90920/tutorial_reportincident_remotedebug_idea_breakpoint2.png?version=1&modificationDate=1216677190000&api=v2"><br clear="none">  </p> <h3 id="BookInOnePage-Addingaunittest">Adding a unit test</h3> @@ -5852,7 +5852,7 @@ public class ReportIncidentRoutes extend <strong>to("velocity:MailBody.vm")</strong> is the producer that will receive a message and let Velocity generate the mail body response.</p> <p>So what we have implemented so far with our ReportIncidentRoutes RouteBuilder is this part of the picture:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/93043/tutorial_reportincident_route_1.png?version=1&modificationDate=1219011599000&api=v2" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_1.png?version=1&modificationDate=1219011599000&api=v2"></p> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_route_1.png" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_1.png?version=1&modificationDate=1219011599000&api=v2"></p> <h3 id="BookInOnePage-AddingtheRouteBuilder">Adding the RouteBuilder</h3> <p>Now we have our RouteBuilder we need to add/connect it to our CamelContext that is the hearth of Camel. So turning back to our webservice implementation class ReportIncidentEndpointImpl we add this constructor to the code, to create the CamelContext and add the routes from our route builder and finally to start it.</p> @@ -5905,7 +5905,7 @@ So we implement the logic in our webserv <p>We have now completed this part of the picture:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/93043/tutorial_reportincident_route_2b.png?version=1&modificationDate=1219476622000&api=v2" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_2b.png?version=1&modificationDate=1219476622000&api=v2"></p> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_route_2b.png" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_2b.png?version=1&modificationDate=1219476622000&api=v2"></p> <h2 id="BookInOnePage-Unittesting">Unit testing</h2> <p>Now is the time we would like to unit test what we got now. So we call for camel and its great test kit. For this to work we need to add it to the pom.xml</p> @@ -6174,7 +6174,7 @@ import static org.apache.camel.language. <p>Whatever worked for you we have now implemented the backup of the data files:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/93043/tutorial_reportincident_route_3.png?version=1&modificationDate=1219647451000&api=v2" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_3.png?version=1&modificationDate=1219647451000&api=v2"></p> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_route_3.png" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_3.png?version=1&modificationDate=1219647451000&api=v2"></p> <h2 id="BookInOnePage-Sendingtheemail.1">Sending the email</h2> @@ -6211,7 +6211,7 @@ public class ReportIncidentRoutes extend So we completed the last piece in the picture puzzle with just 3 lines of code.</p> <p>We have now completed the integration:<br clear="none"> -<img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/93043/tutorial_reportincident_route_4.png?version=1&modificationDate=1219648341000&api=v2" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_4.png?version=1&modificationDate=1219648341000&api=v2"></p> +<img class="confluence-embedded-image" src="book-in-one-page.data/tutorial_reportincident_route_4.png" data-image-src="/confluence/download/attachments/93043/tutorial_reportincident_route_4.png?version=1&modificationDate=1219648341000&api=v2"></p> <h2 id="BookInOnePage-Conclusion.1">Conclusion</h2> <p>We have just briefly touched the <strong>routing</strong> in Camel and shown how to implement them using the <strong>fluent builder</strong> syntax in Java. There is much more to the routing in Camel than shown here, but we are learning step by step. We continue in part 5. See you there.</p> @@ -6316,11 +6316,11 @@ So we completed the last piece in the pi <style type="text/css">/*<![CDATA[*/ -div.rbtoc1418897856947 {padding: 0px;} -div.rbtoc1418897856947 ul {list-style: disc;margin-left: 0px;} -div.rbtoc1418897856947 li {margin-left: 0px;padding-left: 0px;} +div.rbtoc1419020271684 {padding: 0px;} +div.rbtoc1419020271684 ul {list-style: disc;margin-left: 0px;} +div.rbtoc1419020271684 li {margin-left: 0px;padding-left: 0px;} -/*]]>*/</style><div class="toc-macro rbtoc1418897856947"> +/*]]>*/</style><div class="toc-macro rbtoc1419020271684"> <ul class="toc-indentation"><li><a shape="rect" href="#Tutorial-AXIS-Camel-TutorialusingAxis1.4withApacheCamel">Tutorial using Axis 1.4 with Apache Camel</a> <ul class="toc-indentation"><li><a shape="rect" href="#Tutorial-AXIS-Camel-Prerequisites">Prerequisites</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-Distribution">Distribution</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-Introduction">Introduction</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-SettinguptheprojecttorunAxis">Setting up the project to run Axis</a> <ul class="toc-indentation"><li><a shape="rect" href="#Tutorial-AXIS-Camel-Maven2">Maven 2</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-wsdl">wsdl</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-ConfiguringAxis">Configuring Axis</a></li><li><a shape="rect" href="#Tutorial-AXIS-Camel-RunningtheExample">Running the Example</a></li></ul> @@ -7466,11 +7466,11 @@ mvn -Dtest=false jetty:run <p>First, the input from the customers to Acme:</p> -<p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/97175/camel-trading-partners-input.png?version=1&modificationDate=1221300359000&api=v2" data-image-src="/confluence/download/attachments/97175/camel-trading-partners-input.png?version=1&modificationDate=1221300359000&api=v2"></p> +<p><img class="confluence-embedded-image" src="book-in-one-page.data/camel-trading-partners-input.png" data-image-src="/confluence/download/attachments/97175/camel-trading-partners-input.png?version=1&modificationDate=1221300359000&api=v2"></p> <p>And then, the output from Acme to the customers:</p> -<p><img class="confluence-embedded-image" src="https://cwiki.apache.org/confluence/download/attachments/97175/camel-trading-partners-output.png?version=1&modificationDate=1221300359000&api=v2" data-image-src="/confluence/download/attachments/97175/camel-trading-partners-output.png?version=1&modificationDate=1221300359000&api=v2"></p> +<p><img class="confluence-embedded-image" src="book-in-one-page.data/camel-trading-partners-output.png" data-image-src="/confluence/download/attachments/97175/camel-trading-partners-output.png?version=1&modificationDate=1221300359000&api=v2"></p> <h3 id="BookInOnePage-TutorialTasks">Tutorial Tasks</h3> @@ -19229,11 +19229,11 @@ template.send("direct:alias-verify& </div> </div> <p>The <strong>cxf:</strong> component provides integration with <a shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/ -div.rbtoc1418897862527 {padding: 0px;} -div.rbtoc1418897862527 ul {list-style: disc;margin-left: 0px;} -div.rbtoc1418897862527 li {margin-left: 0px;padding-left: 0px;} +div.rbtoc1419020278589 {padding: 0px;} +div.rbtoc1419020278589 ul {list-style: disc;margin-left: 0px;} +div.rbtoc1419020278589 li {margin-left: 0px;padding-left: 0px;} -/*]]>*/</style></p><div class="toc-macro rbtoc1418897862527"> +/*]]>*/</style></p><div class="toc-macro rbtoc1419020278589"> <ul class="toc-indentation"><li><a shape="rect" href="#CXF-CXFComponent">CXF Component</a> <ul class="toc-indentation"><li><a shape="rect" href="#CXF-URIformat">URI format</a></li><li><a shape="rect" href="#CXF-Options">Options</a> <ul class="toc-indentation"><li><a shape="rect" href="#CXF-Thedescriptionsofthedataformats">The descriptions of the dataformats</a> @@ -30016,7 +30016,11 @@ protected RouteBuilder createRouteBuilde ]]></script> </div></div><p>When using named parameters, Camel will lookup the names from, in the given precedence:<br clear="none"> 1. from message body if its a <code>java.util.Map</code><br clear="none"> 2. from message headers</p><p>If a named parameter cannot be resolved, then an exception is thrown.</p><p>From Camel 2.14 onward you can use Simple expressions as parameters as shown:</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[sql:select * from table where id=:#${property.myId} order by name[?options]]]></script> -</div></div><p>Notice that the standard <code>?</code> symbol that denotes the parameters to an SQL query is substituted with the <code>#</code> symbol, because the <code>?</code> symbol is used to specify options for the endpoint. The <code>?</code> symbol replacement can be configured on endpoint basis.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><h3 id="BookInOnePage-Options.75">Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code> boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes below on how the treatment of the inbound message body changes if this is set to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Str ing</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a <code>DataSource</code> to look up in the registry.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a character that will be replaced to <code>?</code> in SQL query. Notice, that it is simple <code>String.replaceAll()</code> operation and no SQL parsing is involved (quoted strings will also change). This replacement is <strong>only</strong> happening if the endpoint is created using the <code>SqlComponent</code>. If you manually create the endpoint, then use the expected <code>?</code> sign instead.< /p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>template.<xxx></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring <code>JdbcTemplate</code> that is used behind the scenes to execute the queries. For instance, <code>template.maxRows=10</code>. For detailed documentation, see the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html" rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan= "1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to allow using named parameters in the queries.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Allows to plugin to use a custom <code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute queries when the consumer has processed the rows/batch.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to use a custom <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> to control preparation of the query and prepared statement.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Delay in milliseconds between each poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Milliseconds before polling starts.</p></td>< /tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Set to <code>true</code> to use fixed delay between polls, otherwise 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><code>maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Ca mel 2.11:</strong> <strong>SQL consumer only:</strong> An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.useIterator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If <code>true</code> each row returned when polling will be processed individually. If <code>false</code> the entire <code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.routeEmptyResultSet</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Whether to route a single empty <a shape="rect" href="exchange.html">Exchange</a> if there was no data to poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsume</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing each row then this query can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> was processed successfully, for example to mark the row as processed. The query can have parameter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsumeFailed</code></p></td><td colspan="1" rowspan="1" class="confluenc eTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing each row then this query can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for example to mark the row as failed. The query can have parameter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsumeBatchComplete</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="con fluenceTd"><p><code>consumer.expectedUpdateCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> then this option can be used to set an expected number of rows being updated. Typically you may set this to <code>1</code> to expect one row to be updated.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.breakBatchOnConsumeFail</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> and it fails, then this o ption controls whether to break out of the batch or continue processing the next row from the batch.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL producer only:</strong> If enabled then the <code>populateStatement</code> method from <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is always invoked, also if there is no expected parameters to be prepared. When this is <code>false</code> then the <code>populateStatement</code> is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenc eTd"><p><code>separator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a <code>Map</code> type is used instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Make the output of consumer or producer to <code>SelectList</code> as List of Map, or <code>SelectOne</code> as single Java object in the following way:<br clear="none"> a) If the query has only single column, then that JDBC Column object is returned. (such as <code>SELECT COUNT( * ) FROM PROJECT</code> will return a Long object.<br clear="none"> b) If the query has more than one column, then it will return a Map of that result.<br clear="none"> c) If the <code>outputClass</code> is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with.<br clear="none"> d) If the query resulted in more than one rows, it throws an non-unique result exception.</p><p>From <strong>Camel 2.14.1</strong> onwards the SelectList also supports mapping each row to a Java object as the SelectOne does <span>(only step c)</span>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan=" 1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the full package and class name to use as conversion when <code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>outputHeader</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15:</strong> To store the result as a header instead of the message body. This allows to preserve the existing message body as-is.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><stron g>Camel 2.11.2/2.12.0</strong> If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>noop</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong> If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing</p></td></tr></tbody></table></div></div><h3 id="BookInOnePage-Treatmentofthemessagebody">Treatment of the message body</h3><p>The SQL component tries to convert the message body to an object of <code>java.util.Iterator</code> type and then uses this ite rator to fill the query parameters (where each query parameter is represented by a <code>#</code> symbol (or configured placeholder) in the endpoint URI). If the message body is not an array or collection, the conversion results in an iterator that iterates over only one object, which is the body itself.</p><p>For example, if the message body is an instance of <code>java.util.List</code>, the first item in the list is substituted into the first occurrence of <code>#</code> in the SQL query, the second item in the list is substituted into the second occurrence of <code>#</code>, and so on.</p><p>If <code>batch</code> is set to <code>true</code>, then the interpretation of the inbound message body changes slightly – instead of an iterator of parameters, the component expects an iterator that contains the parameter iterators; the size of the outer iterator determines the batch size.</p><h3 id="BookInOnePage-Resultofthequery">Result of the query</h3><p>For <code>select</code> oper ations, the result is an instance of <code>List<Map<String, Object>></code> type, as returned by the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)" rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code> operations, the result is the number of updated rows, returned as an <code>Integer</code>.</p><h3 id="BookInOnePage-Headervalues">Header values</h3><p>When performing <code>update</code> operations, the SQL Component stores the update count in the following message headers:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelSqlUpdateCount</code></p></td><td colspan="1 " rowspan="1" class="confluenceTd"><p>The number of rows updated for <code>update</code> operations, returned as an <code>Integer</code> object.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelSqlRowCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows returned for <code>select</code> operations, returned as an <code>Integer</code> object.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelSqlQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> Query to execute. This query takes precedence over the query specified in the endpoint URI. Note that query parameters in the header <em>are</em> represented by a <code>?</code> instead of a <code>#</code> symbol</p></td></tr></tbody></table></div><p>When performing <code>insert</code> operations, the SQL Component stores the rows with the generated keys and number of these rown in the followi ng message headers (<strong>Available as of Camel 2.12.4, 2.13.1</strong>):</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><pre>CamelSqlGeneratedKeysRowCount</pre></td><td colspan="1" rowspan="1" class="confluenceTd">The number of rows in the header that contains generated keys.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><pre>CamelSqlGeneratedKeyRows</pre></td><td colspan="1" rowspan="1" class="confluenceTd"> Rows that contains the generated keys (a list of maps of keys).</td></tr></tbody></table></div><h3 id="BookInOnePage-Generatedkeys.1">Generated keys</h3><p><strong>Available as of Camel 2.12.4, 2.13.1 and 2.14<br clear="none"></strong></p><p>If you insert data using SQL INSERT, then the RDBMS may support auto generated keys. You can instru ct the SQL producer to return the generated keys in headers.<br clear="none"> To do that set the header <code>CamelSqlRetrieveGeneratedKeys=true</code>. Then the generated keys will be provided as headers with the keys listed in the table above.</p><p>You can see more details in this <a shape="rect" class="external-link" href="https://git-wip-us.apache.org/repos/asf?p=camel.git;a=blob_plain;f=components/camel-sql/src/test/java/org/apache/camel/component/sql/SqlGeneratedKeysTest.java;hb=3962b23f94bb4bc23011b931add08c3f6833c82e">unit test</a>.</p><h3 id="BookInOnePage-Configuration.1">Configuration</h3><p>You can now set a reference to a <code>DataSource</code> in the URI directly:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl"> +</div></div><p>Notice that the standard <code>?</code> symbol that denotes the parameters to an SQL query is substituted with the <code>#</code> symbol, because the <code>?</code> symbol is used to specify options for the endpoint. The <code>?</code> symbol replacement can be configured on endpoint basis.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><h3 id="BookInOnePage-Options.75">Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>batch</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code> boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7.5, 2.8.4 and 2.9:</strong> Execute SQL batch update statements. See notes below on how the treatment of the inbound message body changes if this is set to <code>true</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>dataSourceRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>DataSource</code> to look up in the registry. Use <code>dataSource=#theName</code> instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>dataSource</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Str ing</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a <code>DataSource</code> to look up in the registry.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>placeholder</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>#</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.4:</strong> Specifies a character that will be replaced to <code>?</code> in SQL query. Notice, that it is simple <code>String.replaceAll()</code> operation and no SQL parsing is involved (quoted strings will also change). This replacement is <strong>only</strong> happening if the endpoint is created using the <code>SqlComponent</code>. If you manually create the endpoint, then use the expected <code>?</code> sign instead.< /p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>template.<xxx></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets additional options on the Spring <code>JdbcTemplate</code> that is used behind the scenes to execute the queries. For instance, <code>template.maxRows=10</code>. For detailed documentation, see the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html" rel="nofollow">JdbcTemplate javadoc</a> documentation.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>allowNamedParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan= "1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Whether to allow using named parameters in the queries.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>processingStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Allows to plugin to use a custom <code>org.apache.camel.component.sql.SqlProcessingStrategy</code> to execute queries when the consumer has processed the rows/batch.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>prepareStatementStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Allows to plugin to use a custom <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> to control preparation of the query and prepared statement.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.delay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>500</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Delay in milliseconds between each poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.initialDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>long</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Milliseconds before polling starts.</p></td>< /tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.useFixedDelay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Set to <code>true</code> to use fixed delay between polls, otherwise 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><code>maxMessagesPerPoll</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Ca mel 2.11:</strong> <strong>SQL consumer only:</strong> An integer value to define the maximum number of messages to gather per poll. By default, no maximum is set.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.useIterator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If <code>true</code> each row returned when polling will be processed individually. If <code>false</code> the entire <code>java.util.List</code> of data is set as the IN body.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.routeEmptyResultSet</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> Whether to route a single empty <a shape="rect" href="exchange.html">Exchange</a> if there was no data to poll.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsume</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing each row then this query can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> was processed successfully, for example to mark the row as processed. The query can have parameter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsumeFailed</code></p></td><td colspan="1" rowspan="1" class="confluenc eTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing each row then this query can be executed, if the <a shape="rect" href="exchange.html">Exchange</a> failed, for example to mark the row as failed. The query can have parameter.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.onConsumeBatchComplete</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> After processing the entire batch, this query can be executed to bulk update rows etc. The query cannot have parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="con fluenceTd"><p><code>consumer.expectedUpdateCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> then this option can be used to set an expected number of rows being updated. Typically you may set this to <code>1</code> to expect one row to be updated.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>consumer.breakBatchOnConsumeFail</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL consumer only:</strong> If using <code>consumer.onConsume</code> and it fails, then this o ption controls whether to break out of the batch or continue processing the next row from the batch.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>alwaysPopulateStatement</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>SQL producer only:</strong> If enabled then the <code>populateStatement</code> method from <code>org.apache.camel.component.sql.SqlPrepareStatementStrategy</code> is always invoked, also if there is no expected parameters to be prepared. When this is <code>false</code> then the <code>populateStatement</code> is only invoked if there is 1 or more expected parameters to be set; for example this avoids reading the message body/headers for SQL queries with no parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenc eTd"><p><code>separator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>char</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>,</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> The separator to use when parameter values is taken from message body (if the body is a String type), to be inserted at # placeholders. Notice if you use named parameters, then a <code>Map</code> type is used instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputType</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>SelectList</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Make the output of consumer or producer to <code>SelectList</code> as List of Map, or <code>SelectOne</code> as single Java object in the following way:<br clear="none"> a) If the query has only single column, then that JDBC Column object is returned. (such as <code>SELECT COUNT( * ) FROM PROJECT</code> will return a Long object.<br clear="none"> b) If the query has more than one column, then it will return a Map of that result.<br clear="none"> c) If the <code>outputClass</code> is set, then it will convert the query result into an Java bean object by calling all the setters that match the column names. It will assume your class has a default constructor to create instance with.<br clear="none"> d) If the query resulted in more than one rows, it throws an non-unique result exception.</p><p>From <strong>Camel 2.14.1</strong> onwards the SelectList also supports mapping each row to a Java object as the SelectOne does <span>(only step c)</span>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputClass</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan=" 1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0:</strong> Specify the full package and class name to use as conversion when <code>outputType=SelectOne</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>outputHeader</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><code>String</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15:</strong> To store the result as a header instead of the message body. This allows to preserve the existing message body as-is.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>parametersCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code></p></td><td colspan="1" rowspan="1" class="confluenc eTd"><p><strong>Camel 2.11.2/2.12.0</strong> If set greater than zero, then Camel will use this count value of parameters to replace instead of querying via JDBC metadata API. This is useful if the JDBC vendor could not return correct parameters count, then user may override instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>noop</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>boolean</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.0</strong> If set, will ignore the results of the SQL query and use the existing IN message as the OUT message for the continuation of processing</p></td></tr></tbody></table></div></div><h3 id="BookInOnePage-Treatmentofthemessagebody">Treatment of the message body</h3><p>The SQL component tries to convert the message body to an object of <code>java.util.Iterator</code> type and then uses this iterator to fill the query parameters (where each query parameter is represented by a <code>#</code> symbol (or configured placeholder) in the endpoint URI). If the message body is not an array or collection, the conversion results in an iterator that iterates over only one object, which is the body itself.</p><p>For example, if the message body is an instance of <code>java.util.List</code>, the first item in the list is substituted into the first occurrence of <code>#</code> in the SQL query, the second item in the list is substituted into the second occurrence of <code>#</code>, and so on.</p><p>If <code>batch</code> is set to <code>true</code>, then the interpretation of the inbound message body changes slightly – instead of an iterator of parameters, the component expects an iterator that contains the parameter iterators; the size of the outer iterator determines the batch size.</p><h3 id="BookInOnePage-Resultofthequery">Result of the query</h3><p>For <code>sele ct</code> operations, the result is an instance of <code>List<Map<String, Object>></code> type, as returned by the <a shape="rect" class="external-link" href="http://static.springframework.org/spring/docs/2.5.x/api/org/springframework/jdbc/core/JdbcTemplate.html#queryForList(java.lang.String,%20java.lang.Object%91%93)" rel="nofollow">JdbcTemplate.queryForList()</a> method. For <code>update</code> operations, the result is the number of updated rows, returned as an <code>Integer</code>.</p><p>By default, the result is placed in the message body.  If the outputHeader parameter is set, the result is placed in the header.  This is an alternative to using a full message enrichment pattern to add headers, it provides a concise syntax for querying a sequence or some other small value into a header.  It is convenient to use outputHeader and outputType together:</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("jms:order.inbox") + .to("sql:select order_seq.nextval from dual?outputHeader=OrderId&outputType=SelectOne") + .to("jms:order.booking");]]></script> +</div></div><p> </p><h3 id="BookInOnePage-Headervalues">Header values</h3><p>When performing <code>update</code> operations, the SQL Component stores the update count in the following message headers:</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelSqlUpdateCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows updated for <code>update</code> operations, returned as an <code>Integer</code> object.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelSqlRowCount</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The number of rows returned for <code>select</code> operations, returned as an <code>Integer</code> object.</p></td></tr><tr><td colspan="1" rowspan="1" class="con fluenceTd"><p><code>CamelSqlQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> Query to execute. This query takes precedence over the query specified in the endpoint URI. Note that query parameters in the header <em>are</em> represented by a <code>?</code> instead of a <code>#</code> symbol</p></td></tr></tbody></table></div><p>When performing <code>insert</code> operations, the SQL Component stores the rows with the generated keys and number of these rown in the following message headers (<strong>Available as of Camel 2.12.4, 2.13.1</strong>):</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Header</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><pre>CamelSqlGeneratedKeysRowCount</pre></td><td colspan="1" rowspan="1" class="confluenceTd">The number of rows in the heade r that contains generated keys.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><pre>CamelSqlGeneratedKeyRows</pre></td><td colspan="1" rowspan="1" class="confluenceTd"> Rows that contains the generated keys (a list of maps of keys).</td></tr></tbody></table></div><h3 id="BookInOnePage-Generatedkeys.1">Generated keys</h3><p><strong>Available as of Camel 2.12.4, 2.13.1 and 2.14<br clear="none"></strong></p><p>If you insert data using SQL INSERT, then the RDBMS may support auto generated keys. You can instruct the SQL producer to return the generated keys in headers.<br clear="none"> To do that set the header <code>CamelSqlRetrieveGeneratedKeys=true</code>. Then the generated keys will be provided as headers with the keys listed in the table above.</p><p>You can see more details in this <a shape="rect" class="external-link" href="https://git-wip-us.apache.org/repos/asf?p=camel.git;a=blob_plain;f=components/camel-sql/src/test/java/org/apache/camel/component/sql/SqlGe neratedKeysTest.java;hb=3962b23f94bb4bc23011b931add08c3f6833c82e">unit test</a>.</p><h3 id="BookInOnePage-Configuration.1">Configuration</h3><p>You can now set a reference to a <code>DataSource</code> in the URI directly:</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[sql:select * from table where id=# order by name?dataSource=myDS ]]></script> </div></div><h3 id="BookInOnePage-Sample.4">Sample</h3><p>In the sample below we execute a query and retrieve the result as a <code>List</code> of rows, where each row is a <code>Map<String, Object</code> and the key is the column name.</p><p>First, we set up a table to use for our sample. As this is based on an unit test, we do it in java:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/camel/content/cache/main.pageCache ============================================================================== Binary files - no diff available.