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 2015/09/22 16:26:37 UTC
svn commit: r966362 [18/21] - /websites/production/camel/content/
Modified: websites/production/camel/content/snmp.html
==============================================================================
--- websites/production/camel/content/snmp.html (original)
+++ websites/production/camel/content/snmp.html Tue Sep 22 14:26:24 2015
@@ -86,24 +86,24 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="SNMP-SNMPComponent">SNMP Component</h2><p><strong>Available as of Camel 2.1</strong></p><p>The <strong>snmp:</strong> component gives you the ability to poll SNMP capable devices or receiving traps.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-snmp</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
-</pre>
+]]></script>
</div></div><h3 id="SNMP-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">snmp://hostname[:port][?Options]
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[snmp://hostname[:port][?Options]
+]]></script>
</div></div><p>The component supports polling OID values from an SNMP enabled device and receiving traps.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><h3 id="SNMP-Options">Options</h3><div class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>none</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The type of action you want to perform. Actually you can enter here <code>POLL</code> or <code>TRAP</code>. The value <code>POLL</code> will instruct the endpoint to poll a given host for the supplied OID keys. If yo
u put in <code>TRAP</code> you will setup a listener for SNMP Trap Events.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>protocol</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>udp</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Here you can select which protocol to use. You can use either <code>udp</code> or <code>tcp</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>retries</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>2</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Defines how often a retry is made before canceling the request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>timeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1500</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the timeout value for the request in millis.</p></td></tr><tr><td colspa
n="1" rowspan="1" class="confluenceTd"><p><code>snmpVersion</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>0</code> (which means SNMPv1)</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the snmp version for the request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>snmpCommunity</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>public</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the community octet string for the snmp request.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delay</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>60</code> seconds</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Defines the delay in seconds between to poll cycles. From <strong>Camel 2.15</strong> onwards the delay is using millis as its timeunit, so configure 30000 for 30 seconds. Older releases uses the value in seconds.
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>oids</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>none</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Defines which values you are interested in. Please have a look at the <a shape="rect" class="external-link" href="http://en.wikipedia.org/wiki/Object_identifier" rel="nofollow">Wikipedia </a> to get a better understanding. You may provide a single OID or a coma separated list of OIDs. Example: oids="1.3.6.1.2.1.1.3.0,1.3.6.1.2.1.25.3.2.1.5.1,1.3.6.1.2.1.25.3.5.1.1.1,1.3.6.1.2.1.43.5.1.1.11.1"</p></td></tr></tbody></table></div></div><h3 id="SNMP-Theresultofapoll">The result of a poll</h3><p>Given the situation, that I poll for the following OIDs:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>OIDs</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">1.3.6.1.2.1.1.3.0
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[1.3.6.1.2.1.1.3.0
1.3.6.1.2.1.25.3.2.1.5.1
1.3.6.1.2.1.25.3.5.1.1.1
1.3.6.1.2.1.43.5.1.1.11.1
-</pre>
+]]></script>
</div></div><p>The result will be the following:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Result of toString conversion</b></div><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><?xml version="1.0" encoding="UTF-8"?>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<?xml version="1.0" encoding="UTF-8"?>
<snmp>
<entry>
<oid>1.3.6.1.2.1.1.3.0</oid>
@@ -126,18 +126,18 @@
<value>My Very Special Printer Of Brand Unknown</value>
</entry>
</snmp>
-</pre>
+]]></script>
</div></div><p>As you maybe recognized there is one more result than requested....1.3.6.1.2.1.1.1.0.<br clear="none"> This one is filled in by the device automatically in this special case. So it may absolutely happen, that you receive more than you requested...be prepared.</p><h3 id="SNMP-Examples">Examples</h3><p>Polling a remote device:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">snmp:192.168.178.23:161?protocol=udp&type=POLL&oids=1.3.6.1.2.1.1.5.0
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[snmp:192.168.178.23:161?protocol=udp&type=POLL&oids=1.3.6.1.2.1.1.5.0
+]]></script>
</div></div><p>Setting up a trap receiver (<strong>Note that no OID info is needed here!</strong>):</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">snmp:127.0.0.1:162?protocol=udp&type=TRAP
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[snmp:127.0.0.1:162?protocol=udp&type=TRAP
+]]></script>
</div></div><p><strong>From Camel 2.10.0</strong>, you can get the community of SNMP TRAP with message header 'securityName',<br clear="none"> peer address of the SNMP TRAP with message header 'peerAddress'.</p><p>Routing example in Java: (converts the SNMP PDU to XML String)</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("snmp:192.168.178.23:161?protocol=udp&type=POLL&oids=1.3.6.1.2.1.1.5.0").
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("snmp:192.168.178.23:161?protocol=udp&type=POLL&oids=1.3.6.1.2.1.1.5.0").
convertBodyTo(String.class).
-to("activemq:snmp.states");
-</pre>
+to("activemq:snmp.states");
+]]></script>
</div></div><p></p><h3 id="SNMP-SeeAlso">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring Camel</a></li><li><a shape="rect" href="component.html">Component</a></li><li><a shape="rect" href="endpoint.html">Endpoint</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li></ul></div>
</td>
@@ -145,7 +145,7 @@ to("activemq:snmp.states");
<div class="navigation">
<div class="navigation_top">
<!-- NavigationBar -->
-<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overviewhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49132"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentationhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49534"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li>
<li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">
@@ -153,7 +153,7 @@ to("activemq:snmp.states");
<input type="submit" name="sa" value="Search">
</div>
</form>
-<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49115"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developershttps://cwi
ki.apache.org/confluence/pages/viewpage.action?pageId=49124"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
<!-- NavigationBar -->
</div>
</div>
Modified: websites/production/camel/content/spring-web-services.html
==============================================================================
--- websites/production/camel/content/spring-web-services.html (original)
+++ websites/production/camel/content/spring-web-services.html Tue Sep 22 14:26:24 2015
@@ -86,16 +86,16 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="SpringWebServices-SpringWebServicesComponent">Spring Web Services Component</h2><p><strong>Available as of Camel 2.6</strong></p><p>The <strong>spring-ws:</strong> component allows you to integrate with <a shape="rect" class="external-link" href="http://static.springsource.org/spring-ws/sites/1.5/" rel="nofollow">Spring Web Services</a>. It offers both <em>client</em>-side support, for accessing web services, and <em>server</em>-side support for creating your own contract-first web services.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-spring-ws</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
-</pre>
+]]></script>
</div></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Dependencies</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>As of Camel 2.8 this component ships with Spring-WS 2.0.x which (like the rest of Camel) requires Spring 3.0.x.</p><p>Earlier Camel versions shipped Spring-WS 1.5.9 which is compatible with Spring 2.5.x and 3.0.x. In order to run earlier versions of <code>camel-spring-ws</code> on Spring 2.5.x you need to add the <code>spring-webmvc</code> module from Spring 2.5.x. In order to run Spring-WS 1.5.9 on Spring 3.0.x you need to exclude the OXM module from Spring 3.0.x as this module is also included in Spring-WS 1.5.9 (see <a shape="rect" class="external-link" href="http://stackoverflow.com/questions/3313314/can-spring-ws-1-5-be-used-with-spring-3" rel="nofollow">this post</a>)</p></div></div><h3 id="SpringWebService
s-URIformat">URI format</h3><p>The URI scheme for this component is as follows</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">spring-ws:[mapping-type:]address[?options]
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[spring-ws:[mapping-type:]address[?options]
+]]></script>
</div></div><p>To expose a web service <strong>mapping-type</strong> needs to be set to any of the following:</p><div class="confluenceTableSmall">
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Mapping type </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>rootqname</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Offers the option to map web service requests based on the qualified name of the root element contained in the message. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>soapaction</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Used to map web service requests based on the SOAP action specified in the header of the message. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>uri</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> In order to map web service requests that target a specific URI. </p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p> <code>xpathresult</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Used to map web service requests based on the evaluation of an XPath <code>expression</code> against the incoming message. The result of the evaluation should match the XPath result specified in the endpoint URI. </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>beanname</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Allows you to reference an <code>org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher</code> object in order to integrate with existing (legacy) <a shape="rect" class="external-link" href="http://static.springsource.org/spring-ws/sites/1.5/reference/html/server.html#server-endpoint-mapping" rel="nofollow">endpoint mappings</a> like <code>PayloadRootQNameEndpointMapping</code>, <code>SoapActionEndpointMapping</code>, etc </p></td></tr></tbody></table></div>
</div><p>As a consumer the <strong>address</strong> should contain a value relevant to the specified mapping-type (e.g. a SOAP action, XPath expression). As a producer the address should be set to the URI of the web service your calling upon.</p><p>You can append query <strong>options</strong> to the URI in the following format, <code>?option=value&option=value&...</code></p><h3 id="SpringWebServices-Options">Options</h3><div class="confluenceTableSmall">
@@ -108,42 +108,42 @@
</div><h3 id="SpringWebServices-Messageheaders">Message headers</h3><div class="confluenceTableSmall">
<div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p> Name </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Type </p></th><th colspan="1" rowspan="1" class="confluenceTh"><p> Description </p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelSpringWebserviceEndpointUri</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> URI of the web service your accessing as a client, overrides <em>address</em> part of the endpoint URI </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelSpringWebserviceSoapAction</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> String </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Header to specify the SOAP action of the message, overrides <code>soapAction</code> option if present </p></td></tr><tr><td colspan="1
" rowspan="1" class="confluenceTd"><p> <code>CamelSpringWebserviceAddressingAction</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> URI </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Use this header to specify the WS-Addressing action of the message, overrides <code>wsAddressingAction</code> option if present </p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p> <code>CamelSpringWebserviceSoapHeader</code> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> Source </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> <strong>Camel 2.11.1:</strong> Use this header to specify/access the SOAP headers of the message. </p></td></tr></tbody></table></div>
</div><h2 id="SpringWebServices-Accessingwebservices">Accessing web services</h2><p>To call a web service at <code><a shape="rect" class="external-link" href="http://foo.com/bar" rel="nofollow">http://foo.com/bar</a></code> simply define a route:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:example").to("spring-ws:http://foo.com/bar")
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:example").to("spring-ws:http://foo.com/bar")
+]]></script>
</div></div><p>And sent a message:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">template.requestBody("direct:example", "<foobar xmlns=\"http://foo.com\"><msg>test message</msg></foobar>");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[template.requestBody("direct:example", "<foobar xmlns=\"http://foo.com\"><msg>test message</msg></foobar>");
+]]></script>
</div></div><p>Remember if it's a SOAP service you're calling you don't have to include SOAP tags. Spring-WS will perform the XML-to-SOAP marshaling.</p><h3 id="SpringWebServices-SendingSOAPandWS-Addressingactionheaders">Sending SOAP and WS-Addressing action headers</h3><p>When a remote web service requires a SOAP action or use of the WS-Addressing standard you define your route as:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:example")
-.to("spring-ws:http://foo.com/bar?soapAction=http://foo.com&wsAddressingAction=http://bar.com")
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:example")
+.to("spring-ws:http://foo.com/bar?soapAction=http://foo.com&wsAddressingAction=http://bar.com")
+]]></script>
</div></div><p>Optionally you can override the endpoint options with header values:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">template.requestBodyAndHeader("direct:example",
-"<foobar xmlns=\"http://foo.com\"><msg>test message</msg></foobar>",
-SpringWebserviceConstants.SPRING_WS_SOAP_ACTION, "http://baz.com");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[template.requestBodyAndHeader("direct:example",
+"<foobar xmlns=\"http://foo.com\"><msg>test message</msg></foobar>",
+SpringWebserviceConstants.SPRING_WS_SOAP_ACTION, "http://baz.com");
+]]></script>
</div></div><h3 id="SpringWebServices-UsingSOAPheaders">Using SOAP headers</h3><p><strong>Available as of Camel 2.11.1</strong></p><p>You can provide the SOAP header(s) as a Camel Message header when sending a message to a spring-ws endpoint, for example given the following SOAP header in a String</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">String body = ...
-String soapHeader = "<h:Header xmlns:h=\"http://www.webserviceX.NET/\"><h:MessageID>1234567890</h:MessageID><h:Nested><h:NestedID>1111</h:NestedID></h:Nested></h:Header>";
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[String body = ...
+String soapHeader = "<h:Header xmlns:h=\"http://www.webserviceX.NET/\"><h:MessageID>1234567890</h:MessageID><h:Nested><h:NestedID>1111</h:NestedID></h:Nested></h:Header>";
+]]></script>
</div></div><p>We can set the body and header on the Camel Message as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">exchange.getIn().setBody(body);
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[exchange.getIn().setBody(body);
exchange.getIn().setHeader(SpringWebserviceConstants.SPRING_WS_SOAP_HEADER, soapHeader);
-</pre>
+]]></script>
</div></div><p>And then send the Exchange to a <code>spring-ws</code> endpoint to call the Web Service.</p><p>Likewise the spring-ws consumer will also enrich the Camel Message with the SOAP header.</p><p>For an example see this <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-spring-ws/src/test/java/org/apache/camel/component/spring/ws/SoapHeaderTest.java">unit test</a>.</p><h3 id="SpringWebServices-Theheaderandattachmentpropagation">The header and attachment propagation</h3><p>Spring WS Camel supports propagation of the headers and attachments into Spring-WS WebServiceMessage response since version <strong>2.10.3</strong>. The endpoint will use so called "hook" the MessageFilter (default implementation is provided by BasicMessageFilter) to propagate the exchange headers and attachments into WebServiceMessage response. Now you can use</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">exchange.getOut().getHeaders().put("myCustom","myHeaderValue")
-exchange.getIn().addAttachment("myAttachment", new DataHandler(...))
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[exchange.getOut().getHeaders().put("myCustom","myHeaderValue")
+exchange.getIn().addAttachment("myAttachment", new DataHandler(...))
+]]></script>
</div></div><p>Note: If the exchange header in the pipeline contains text, it generates Qname(key)=value attribute in the soap header. Recommended is to create a QName class directly and put into any key into header.</p><h3 id="SpringWebServices-HowtouseMTOMattachments">How to use MTOM attachments</h3><p>The BasicMessageFilter provides all required information for Apache Axiom in order to produce MTOM message. If you want to use Apache Camel Spring WS within Apache Axiom, here is an example:<br clear="none"> 1. Simply define the messageFactory as is bellow and Spring-WS will use MTOM strategy to populate your SOAP message with optimized attachments.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><bean id="axiomMessageFactory"
-class="org.springframework.ws.soap.axiom.AxiomSoapMessageFactory">
-<property name="payloadCaching" value="false" />
-<property name="attachmentCaching" value="true" />
-<property name="attachmentCacheThreshold" value="1024" />
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="axiomMessageFactory"
+class="org.springframework.ws.soap.axiom.AxiomSoapMessageFactory">
+<property name="payloadCaching" value="false" />
+<property name="attachmentCaching" value="true" />
+<property name="attachmentCacheThreshold" value="1024" />
</bean>
-</pre>
+]]></script>
</div></div><p>2. Add into your pom.xml the following dependencies</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.ws.commons.axiom</groupId>
<artifactId>axiom-api</artifactId>
<version>1.2.13</version>
@@ -154,56 +154,56 @@ class="org.springframework.ws.soap.axiom
<version>1.2.13</version>
<scope>runtime</scope>
</dependency>
-</pre>
+]]></script>
</div></div><p>3. Add your attachment into the pipeline, for example using a Processor implementation.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">private class Attachement implements Processor {
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[private class Attachement implements Processor {
public void process(Exchange exchange) throws Exception
-{ exchange.getOut().copyFrom(exchange.getIn()); File file = new File("testAttachment.txt"); exchange.getOut().addAttachment("test", new DataHandler(new FileDataSource(file))); }
+{ exchange.getOut().copyFrom(exchange.getIn()); File file = new File("testAttachment.txt"); exchange.getOut().addAttachment("test", new DataHandler(new FileDataSource(file))); }
}
-</pre>
+]]></script>
</div></div><p>4. Define endpoint (producer) as ussual, for example like this:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:send")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:send")
.process(new Attachement())
-.to("spring-ws:http://localhost:8089/mySoapService?soapAction=mySoap&messageFactory=axiomMessageFactory");
-</pre>
+.to("spring-ws:http://localhost:8089/mySoapService?soapAction=mySoap&messageFactory=axiomMessageFactory");
+]]></script>
</div></div><p>5. Now, your producer will generate MTOM message with otpmized attachments.</p><h3 id="SpringWebServices-Thecustomheaderandattachmentfiltering">The custom header and attachment filtering</h3><p>If you need to provide your custom processing of either headers or attachments, extend existing BasicMessageFilter and override the appropriate methods or write a brand new implementation of the MessageFilter interface.<br clear="none"> To use your custom filter, add this into your spring context:</p><p>You can specify either a global a or a local message filter as follows:<br clear="none"> a) the global custom filter that provides the global configuration for all Spring-WS endpoints</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-<bean id="messageFilter" class="your.domain.myMessageFiler" scope="singleton" />
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<bean id="messageFilter" class="your.domain.myMessageFiler" scope="singleton" />
+]]></script>
</div></div><p>or<br clear="none"> b) the local messageFilter directly on the endpoint as follows:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">to("spring-ws:http://yourdomain.com?messageFilter=#myEndpointSpecificMessageFilter");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[to("spring-ws:http://yourdomain.com?messageFilter=#myEndpointSpecificMessageFilter");
+]]></script>
</div></div><p>For more information see <a shape="rect" class="external-link" href="https://issues.apache.org/jira/browse/CAMEL-5724">CAMEL-5724</a></p><p>If you want to create your own MessageFilter, consider overriding the following methods in the default implementation of MessageFilter in class BasicMessageFilter:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">protected void doProcessSoapHeader(Message inOrOut, SoapMessage soapMessage)
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[protected void doProcessSoapHeader(Message inOrOut, SoapMessage soapMessage)
{your code /*no need to call super*/ }
protected void doProcessSoapAttachements(Message inOrOut, SoapMessage response)
{ your code /*no need to call super*/ }
-</pre>
+]]></script>
</div></div><h3 id="SpringWebServices-UsingacustomMessageSenderandMessageFactory">Using a custom MessageSender and MessageFactory</h3><p>A custom message sender or factory in the registry can be referenced like this:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:example")
-.to("spring-ws:http://foo.com/bar?messageFactory=#messageFactory&messageSender=#messageSender")
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:example")
+.to("spring-ws:http://foo.com/bar?messageFactory=#messageFactory&messageSender=#messageSender")
+]]></script>
</div></div><p>Spring configuration:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><!-- authenticate using HTTP Basic Authentication -->
-<bean id="messageSender" class="org.springframework.ws.transport.http.HttpComponentsMessageSender">
- <property name="credentials">
- <bean class="org.apache.commons.httpclient.UsernamePasswordCredentials">
- <constructor-arg index="0" value="admin"/>
- <constructor-arg index="1" value="secret"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<!-- authenticate using HTTP Basic Authentication -->
+<bean id="messageSender" class="org.springframework.ws.transport.http.HttpComponentsMessageSender">
+ <property name="credentials">
+ <bean class="org.apache.commons.httpclient.UsernamePasswordCredentials">
+ <constructor-arg index="0" value="admin"/>
+ <constructor-arg index="1" value="secret"/>
</bean>
</property>
</bean>
<!-- force use of Sun SAAJ implementation, http://static.springsource.org/spring-ws/sites/1.5/faq.html#saaj-jboss -->
-<bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory">
- <property name="messageFactory">
- <bean class="com.sun.xml.messaging.saaj.soap.ver1_1.SOAPMessageFactory1_1Impl"></bean>
+<bean id="messageFactory" class="org.springframework.ws.soap.saaj.SaajSoapMessageFactory">
+ <property name="messageFactory">
+ <bean class="com.sun.xml.messaging.saaj.soap.ver1_1.SOAPMessageFactory1_1Impl"></bean>
</property>
</bean>
-</pre>
+]]></script>
</div></div><h2 id="SpringWebServices-Exposingwebservices">Exposing web services</h2><p>In order to expose a web service using this component you first need to set-up a <a shape="rect" class="external-link" href="http://static.springsource.org/spring-ws/sites/1.5/reference/html/server.html" rel="nofollow">MessageDispatcher</a> to look for endpoint mappings in a Spring XML file. If you plan on running inside a servlet container you probably want to use a <code>MessageDispatcherServlet</code> configured in <code>web.xml</code>.</p><p>By default the <code>MessageDispatcherServlet</code> will look for a Spring XML named <code>/WEB-INF/spring-ws-servlet.xml</code>. To use Camel with Spring-WS the only mandatory bean in that XML file is <code>CamelEndpointMapping</code>. This bean allows the <code>MessageDispatcher</code> to dispatch web service requests to your routes.</p><p><em>web.xml</em></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pd
l">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><web-app>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<web-app>
<servlet>
<servlet-name>spring-ws</servlet-name>
<servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class>
@@ -214,67 +214,67 @@ protected void doProcessSoapAttachements
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
-</pre>
+]]></script>
</div></div><p><em>spring-ws-servlet.xml</em></p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><bean id="endpointMapping" class="org.apache.camel.component.spring.ws.bean.CamelEndpointMapping" />
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="endpointMapping" class="org.apache.camel.component.spring.ws.bean.CamelEndpointMapping" />
-<bean id="wsdl" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
- <property name="schema">
- <bean class="org.springframework.xml.xsd.SimpleXsdSchema">
- <property name="xsd" value="/WEB-INF/foobar.xsd"/>
+<bean id="wsdl" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
+ <property name="schema">
+ <bean class="org.springframework.xml.xsd.SimpleXsdSchema">
+ <property name="xsd" value="/WEB-INF/foobar.xsd"/>
</bean>
</property>
- <property name="portTypeName" value="FooBar"/>
- <property name="locationUri" value="/"/>
- <property name="targetNamespace" value="http://example.com/"/>
+ <property name="portTypeName" value="FooBar"/>
+ <property name="locationUri" value="/"/>
+ <property name="targetNamespace" value="http://example.com/"/>
</bean>
-</pre>
+]]></script>
</div></div><p>More information on setting up Spring-WS can be found in <a shape="rect" class="external-link" href="http://static.springsource.org/spring-ws/sites/1.5/reference/html/tutorial.html" rel="nofollow">Writing Contract-First Web Services</a>. Basically paragraph 3.6 "Implementing the Endpoint" is handled by this component (specifically paragraph 3.6.2 "Routing the Message to the Endpoint" is where <code>CamelEndpointMapping</code> comes in). Also don't forget to check out the <a shape="rect" href="spring-ws-example.html">Spring Web Services Example</a> included in the Camel distribution.</p><h3 id="SpringWebServices-Endpointmappinginroutes">Endpoint mapping in routes</h3><p>With the XML configuration in-place you can now use Camel's DSL to define what web service requests are handled by your endpoint:</p><p>The following route will receive all web service requests that have a root element named "GetFoo" within the <code><a shape="rect" class="external-link" href="http://ex
ample.com/" rel="nofollow">http://example.com/</a></code> namespace.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("spring-ws:rootqname:{http://example.com/}GetFoo?endpointMapping=#endpointMapping")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("spring-ws:rootqname:{http://example.com/}GetFoo?endpointMapping=#endpointMapping")
.convertBodyTo(String.class).to(mock:example)
-</pre>
+]]></script>
</div></div><p>The following route will receive web service requests containing the <code><a shape="rect" class="external-link" href="http://example.com/GetFoo" rel="nofollow">http://example.com/GetFoo</a></code> SOAP action.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("spring-ws:soapaction:http://example.com/GetFoo?endpointMapping=#endpointMapping")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("spring-ws:soapaction:http://example.com/GetFoo?endpointMapping=#endpointMapping")
.convertBodyTo(String.class).to(mock:example)
-</pre>
+]]></script>
</div></div><p>The following route will receive all requests sent to <code><a shape="rect" class="external-link" href="http://example.com/foobar" rel="nofollow">http://example.com/foobar</a></code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("spring-ws:uri:http://example.com/foobar?endpointMapping=#endpointMapping")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("spring-ws:uri:http://example.com/foobar?endpointMapping=#endpointMapping")
.convertBodyTo(String.class).to(mock:example)
-</pre>
+]]></script>
</div></div><p>The route below will receive requests that contain the element <code><foobar>abc</foobar></code> anywhere inside the message (and the default namespace).</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("spring-ws:xpathresult:abc?expression=//foobar&endpointMapping=#endpointMapping")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("spring-ws:xpathresult:abc?expression=//foobar&endpointMapping=#endpointMapping")
.convertBodyTo(String.class).to(mock:example)
-</pre>
+]]></script>
</div></div><h3 id="SpringWebServices-Alternativeconfiguration,usingexistingendpointmappings">Alternative configuration, using existing endpoint mappings</h3><p>For every endpoint with mapping-type <code>beanname</code> one bean of type <code>CamelEndpointDispatcher</code> with a corresponding name is required in the Registry/ApplicationContext. This bean acts as a bridge between the Camel endpoint and an existing <a shape="rect" class="external-link" href="http://static.springsource.org/spring-ws/sites/1.5/reference/html/server.html#server-endpoint-mapping" rel="nofollow">endpoint mapping</a> like <code>PayloadRootQNameEndpointMapping</code>.</p><div class="confluence-information-macro confluence-information-macro-note"><span class="aui-icon aui-icon-small aui-iconfont-warning confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>The use of the <code>beanname</code> mapping-type is primarily meant for (legacy) situations where you're already us
ing Spring-WS and have endpoint mappings defined in a Spring XML file. The <code>beanname</code> mapping-type allows you to wire your Camel route into an existing endpoint mapping. When you're starting from scratch it's recommended to define your endpoint mappings as Camel URI's (as illustrated above with <code>endpointMapping</code>) since it requires less configuration and is more expressive. Alternatively you could use vanilla Spring-WS with the help of annotations.</p></div></div><p>An example of a route using <code>beanname</code>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"><camelContext xmlns="http://camel.apache.org/schema/spring">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<camelContext xmlns="http://camel.apache.org/schema/spring">
<route>
- <from uri="spring-ws:beanname:QuoteEndpointDispatcher" />
- <to uri="mock:example" />
+ <from uri="spring-ws:beanname:QuoteEndpointDispatcher" />
+ <to uri="mock:example" />
</route>
</camelContext>
-<bean id="legacyEndpointMapping" class="org.springframework.ws.server.endpoint.mapping.PayloadRootQNameEndpointMapping">
- <property name="mappings">
+<bean id="legacyEndpointMapping" class="org.springframework.ws.server.endpoint.mapping.PayloadRootQNameEndpointMapping">
+ <property name="mappings">
<props>
- <prop key="{http://example.com/}GetFuture">FutureEndpointDispatcher</prop>
- <prop key="{http://example.com/}GetQuote">QuoteEndpointDispatcher</prop>
+ <prop key="{http://example.com/}GetFuture">FutureEndpointDispatcher</prop>
+ <prop key="{http://example.com/}GetQuote">QuoteEndpointDispatcher</prop>
</props>
</property>
</bean>
-<bean id="QuoteEndpointDispatcher" class="org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher" />
-<bean id="FutureEndpointDispatcher" class="org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher" />
-</pre>
+<bean id="QuoteEndpointDispatcher" class="org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher" />
+<bean id="FutureEndpointDispatcher" class="org.apache.camel.component.spring.ws.bean.CamelEndpointDispatcher" />
+]]></script>
</div></div><h2 id="SpringWebServices-POJO(un)marshalling">POJO (un)marshalling</h2><p>Camel's <a shape="rect" href="data-format.html">pluggable data formats</a> offer support for pojo/xml marshalling using libraries such as JAXB, XStream, JibX, Castor and XMLBeans. You can use these data formats in your route to sent and receive pojo's, to and from web services.</p><p>When <em>accessing</em> web services you can marshal the request and unmarshal the response message:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">JaxbDataFormat jaxb = new JaxbDataFormat(false);
-jaxb.setContextPath("com.example.model");
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[JaxbDataFormat jaxb = new JaxbDataFormat(false);
+jaxb.setContextPath("com.example.model");
-from("direct:example").marshal(jaxb).to("spring-ws:http://foo.com/bar").unmarshal(jaxb);
-</pre>
+from("direct:example").marshal(jaxb).to("spring-ws:http://foo.com/bar").unmarshal(jaxb);
+]]></script>
</div></div><p>Similarly when <em>providing</em> web services, you can unmarshal XML requests to POJO's and marshal the response message back to XML:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("spring-ws:rootqname:{http://example.com/}GetFoo?endpointMapping=#endpointMapping").unmarshal(jaxb)
-.to("mock:example").marshal(jaxb);
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("spring-ws:rootqname:{http://example.com/}GetFoo?endpointMapping=#endpointMapping").unmarshal(jaxb)
+.to("mock:example").marshal(jaxb);
+]]></script>
</div></div><p></p><h3 id="SpringWebServices-SeeAlso">See Also</h3>
<ul><li><a shape="rect" href="configuring-camel.html">Configuring Camel</a></li><li><a shape="rect" href="component.html">Component</a></li><li><a shape="rect" href="endpoint.html">Endpoint</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li></ul></div>
</td>
@@ -282,7 +282,7 @@ from("direct:example").marshal(jaxb).to(
<div class="navigation">
<div class="navigation_top">
<!-- NavigationBar -->
-<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overviewhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49132"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentationhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49534"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li>
<li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">
@@ -290,7 +290,7 @@ from("direct:example").marshal(jaxb).to(
<input type="submit" name="sa" value="Search">
</div>
</form>
-<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49115"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developershttps://cwi
ki.apache.org/confluence/pages/viewpage.action?pageId=49124"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
<!-- NavigationBar -->
</div>
</div>
Modified: websites/production/camel/content/stream-caching.html
==============================================================================
--- websites/production/camel/content/stream-caching.html (original)
+++ websites/production/camel/content/stream-caching.html Tue Sep 22 14:26:24 2015
@@ -106,70 +106,70 @@ This <code>StreamCache</code> is capable
<p>In Apache Camel, you can explicitly enable stream caching for a single route with the <strong><code>streamCaching</code></strong> DSL method:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-from("jbi:service:http://foo.bar.org/MyService")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+from("jbi:service:http://foo.bar.org/MyService")
.streamCaching()
- .to("jbi:service:http://foo.bar.org/MyOtherService");
-</pre>
+ .to("jbi:service:http://foo.bar.org/MyOtherService");
+]]></script>
</div></div>
<p>In Spring XML you enable it by setting the <code>streamCache="true"</code> attribute on the <code>route</code> tag.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<route streamCache="true">
- <from uri="jbi:service:http://foo.bar.org/MyService"/>
- <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<route streamCache="true">
+ <from uri="jbi:service:http://foo.bar.org/MyService"/>
+ <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
</route>
-</pre>
+]]></script>
</div></div>
<h3 id="Streamcaching-Scopes">Scopes</h3>
<p>StreamCache supports the global and per route scope. So by setting the streamCache attribute on camelContext you can enable/disable it globally.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<camelContext streamCache="true">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<camelContext streamCache="true">
...
</camelContext>
-</pre>
+]]></script>
</div></div>
<p>The route scope is configured by the <code>streamCache</code> attribute on the <code><route></code> tag such as:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<route streamCache="true">
- <from uri="jbi:service:http://foo.bar.org/MyService"/>
- <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<route streamCache="true">
+ <from uri="jbi:service:http://foo.bar.org/MyService"/>
+ <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
</route>
-</pre>
+]]></script>
</div></div>
<p>You can mix and match for instance you can enable it globally and disable it on a particular route such as:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<camelContext streamCache="true">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<camelContext streamCache="true">
<route>
- <from uri="jbi:service:http://foo.bar.org/MyService"/>
- <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
+ <from uri="jbi:service:http://foo.bar.org/MyService"/>
+ <to uri="jbi:service:http://foo.bar.org/MyOtherService"/>
</route>
- <route streamCache="false">
- <from uri="jms:queue:foo"/>
- <to uri="jms:queue:bar"/>
+ <route streamCache="false">
+ <from uri="jms:queue:foo"/>
+ <to uri="jms:queue:bar"/>
</route>
</camelContext>
-</pre>
+]]></script>
</div></div>
<h4 id="Streamcaching-EnablingfromJavaDSL">Enabling from Java DSL</h4>
<p>You can enable stream cache by setting the property on CamelContext, for instance in a RouteBuilder class:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
context.setStreamCache(true);
- from("jbi:service:http://foo.bar.org/MyService")
- .to("jbi:service:http://foo.bar.org/MyOtherService");
-</pre>
+ from("jbi:service:http://foo.bar.org/MyService")
+ .to("jbi:service:http://foo.bar.org/MyOtherService");
+]]></script>
</div></div>
<h3 id="Streamcaching-Disablestreamcachingexplicitly">Disable stream caching explicitly</h3>
@@ -177,24 +177,24 @@ from("jbi:service:http://foo.bar.org/MyS
<p><strong>Spring DSL:</strong></p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<camelContext streamCache="true">
- <route streamCache="false">
- <from uri="jetty:http://0.0.0.0:9090"/>
- <to uri="file:target/incoming"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<camelContext streamCache="true">
+ <route streamCache="false">
+ <from uri="jetty:http://0.0.0.0:9090"/>
+ <to uri="file:target/incoming"/>
</route>
</camelContext>
-</pre>
+]]></script>
</div></div>
<p><strong>Java DSL:</strong></p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
context.setStreamCache(true);
- from("jetty:http://0.0.0.0:9090").noStreamCaching()
- .to("file:target/incoming");
-</pre>
+ from("jetty:http://0.0.0.0:9090").noStreamCaching()
+ .to("file:target/incoming");
+]]></script>
</div></div>
@@ -207,49 +207,49 @@ from("jbi:service:http://foo.bar.org/MyS
<p>You set these properties on the CamelContext as shown below, where we use a 1mb threshold to spool to disk for messages bigger than 1mb:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-context.getProperties().put(CachedOutputStream.TEMP_DIR, "/tmp/cachedir");
-context.getProperties().put(CachedOutputStream.THRESHOLD, "1048576");
-context.getProperties().put(CachedOutputStream.BUFFER_SIZE, "131072");
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+context.getProperties().put(CachedOutputStream.TEMP_DIR, "/tmp/cachedir");
+context.getProperties().put(CachedOutputStream.THRESHOLD, "1048576");
+context.getProperties().put(CachedOutputStream.BUFFER_SIZE, "131072");
// to enable encryption using RC4
-// context.getProperties().put(CachedOutputStream.CIPHER_TRANSFORMATION, "RC4");
-</pre>
+// context.getProperties().put(CachedOutputStream.CIPHER_TRANSFORMATION, "RC4");
+]]></script>
</div></div>
<p>And in XML you do</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<camelContext xmlns="http://camel.apache.org/schema/blueprint">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<camelContext xmlns="http://camel.apache.org/schema/blueprint">
<!-- disable stream caching spool to disk -->
<properties>
- <property key="CamelCachedOutputStreamOutputDirectory" value="/tmp/cachedir"/>
- <property key="CamelCachedOutputStreamThreshold" value="1048576"/>
- <property key="CamelCachedOutputStreamBufferSize" value="131072"/>
+ <property key="CamelCachedOutputStreamOutputDirectory" value="/tmp/cachedir"/>
+ <property key="CamelCachedOutputStreamThreshold" value="1048576"/>
+ <property key="CamelCachedOutputStreamBufferSize" value="131072"/>
</properties>
-</pre>
+]]></script>
</div></div>
<h4 id="Streamcaching-Disablingspoolingtodisk">Disabling spooling to disk</h4>
<p>You can disable spooling to disk by setting a threshold of 0 or a negative value.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
// disable spooling to disk
-context.getProperties().put(CachedOutputStream.THRESHOLD, "-1");
-</pre>
+context.getProperties().put(CachedOutputStream.THRESHOLD, "-1");
+]]></script>
</div></div>
<p>And in XML you do</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<camelContext xmlns="http://camel.apache.org/schema/blueprint">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<camelContext xmlns="http://camel.apache.org/schema/blueprint">
<!-- disable stream caching spool to disk -->
<properties>
- <property key="CamelCachedOutputStreamThreshold" value="-1"/>
+ <property key="CamelCachedOutputStreamThreshold" value="-1"/>
</properties>
-</pre>
+]]></script>
</div></div>
@@ -273,16 +273,16 @@ The old kind of configuration using prop
<p>A could of examples, to store in the java temp directory with a sub directory using the CamelContext name:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-context.getStreamCachingStrategy().setSpoolDirectory"${java.io.tmpdir}#name#/");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+context.getStreamCachingStrategy().setSpoolDirectory"${java.io.tmpdir}#name#/");
+]]></script>
</div></div>
<p>To store in KARAF_HOME/tmp/bundleId directory</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-context.getStreamCachingStrategy().setSpoolDirectory"${env:KARAF_HOME}/tmp/bundle#bundleId#");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+context.getStreamCachingStrategy().setSpoolDirectory"${env:KARAF_HOME}/tmp/bundle#bundleId#");
+]]></script>
</div></div>
@@ -290,55 +290,55 @@ context.getStreamCachingStrategy().setSp
<p>You can configure the <code>StreamCachingStrategy</code> in Java as shown below:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
-context.getStreamCachingStrategy().setSpoolDirectory"/tmp/cachedir");
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+context.getStreamCachingStrategy().setSpoolDirectory"/tmp/cachedir");
context.getStreamCachingStrategy().setSpoolThreshold(64 * 1024);
context.getStreamCachingStrategy().setBufferSize(16 * 1024);
// to enable encryption using RC4
-// context.getStreamCachingStrategy().setSpoolChiper("RC4");
-</pre>
+// context.getStreamCachingStrategy().setSpoolChiper("RC4");
+]]></script>
</div></div>
<p>And remember to enable <a shape="rect" href="stream-caching.html">Stream caching</a> on the <a shape="rect" href="camelcontext.html">CamelContext</a> or on routes</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
context.setStreamCaching(true);
-</pre>
+]]></script>
</div></div>
<h4 id="Streamcaching-UsingStreamCachingStrategyinXML">Using StreamCachingStrategy in XML</h4>
<p>And in XML you do:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
- <camelContext streamCache="true" xmlns="http://camel.apache.org/schema/blueprint">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+ <camelContext streamCache="true" xmlns="http://camel.apache.org/schema/blueprint">
- <streamCaching id="myCacheConfig" bufferSize="16384" spoolDirectory="/tmp/cachedir" spoolThreshold="65536"/>
+ <streamCaching id="myCacheConfig" bufferSize="16384" spoolDirectory="/tmp/cachedir" spoolThreshold="65536"/>
<route>
- <from uri="direct:c"/>
- <to uri="mock:c"/>
+ <from uri="direct:c"/>
+ <to uri="mock:c"/>
</route>
</camelContext>
-</pre>
+]]></script>
</div></div>
<p>You can also define a <bean> instead of using the <streamCaching> tag:</p>
<p>And in XML you do</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
<!-- define a bean of type StreamCachingStrategy which CamelContext will automatic use -->
-<bean id="streamStrategy" class="org.apache.camel.impl.DefaultStreamCachingStrategy">
- <property name="spoolDirectory" value="/tmp/cachedir"/>
- <property name="spoolThreshold" value="65536"/>
- <property name="bufferSize" value="16384"/>
+<bean id="streamStrategy" class="org.apache.camel.impl.DefaultStreamCachingStrategy">
+ <property name="spoolDirectory" value="/tmp/cachedir"/>
+ <property name="spoolThreshold" value="65536"/>
+ <property name="bufferSize" value="16384"/>
</bean>
<!-- remember to enable stream caching -->
-<camelContext streamCaching="true" xmlns="http://camel.apache.org/schema/spring">
-</pre>
+<camelContext streamCaching="true" xmlns="http://camel.apache.org/schema/spring">
+]]></script>
</div></div>
@@ -348,34 +348,34 @@ context.setStreamCaching(true);
<p>For example with:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
- <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70"/>
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+ <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70"/>
+]]></script>
</div></div>
<p>Then notice that as spoolThreshold is default enabled with 128kb, then we have both thresholds in use (spoolThreshold and spoolUsedHeapMemoryThreshold). And in this example then we only spool to disk if payload is > 128kb and that used heap memory is > 70%. The reason is that we have the option <code>anySpoolRules</code> as default <code>false</code>. That means both rules must be <code>true</code> (eg AND). </p>
<p>If we want to spool to disk if either of the rules (eg OR), then we can do:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
- <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" anySpoolRules="true"/>
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+ <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" anySpoolRules="true"/>
+]]></script>
</div></div>
<p>If we only want to spool to disk if we run low on memory then we can set:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
- <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolThreshold="-1" spoolUsedHeapMemoryThreshold="70"/>
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+ <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolThreshold="-1" spoolUsedHeapMemoryThreshold="70"/>
+]]></script>
</div></div>
<p>... then we do not use the spoolThreshold rule, and only the heap memory based is in use.</p>
<p>By default the upper limit of the used heap memory is based on the maximum heap size. Though you can also configure to use the committed heap size as the upper limit, this is done using the <code>spoolUsedHeapMemoryThreshold</code> option as shown below:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
- <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" spoolUsedHeapMemoryLimit="Committed"/>
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+ <streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" spoolUsedHeapMemoryLimit="Committed"/>
+]]></script>
</div></div>
@@ -383,35 +383,35 @@ context.setStreamCaching(true);
<p>You can implement your custom rules to determine if the stream should be spooled to disk. This can be done by implementing the interface <code>org.apache.camel.spi.StreamCachingStrategy.SpoolRule</code> which has a single method:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
boolean shouldSpoolCache(long length);
-</pre>
+]]></script>
</div></div>
<p>The length is the length of the stream. </p>
<p>To use the rule then add it to the <code>StreamCachingStrategy</code> as shown below:</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
SpoolRule mySpoolRule = ...
context.getStreamCachingStrategy().addSpoolRule(mySpoolRule);
-</pre>
+]]></script>
</div></div>
<p>And from XML you need to define a <bean> with your custom rule</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<bean id="mySpoolRule" class="com.foo.MySpoolRule"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<bean id="mySpoolRule" class="com.foo.MySpoolRule"/>
-<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolRules="mySpoolRule"/>
-</pre>
+<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolRules="mySpoolRule"/>
+]]></script>
</div></div>
<p>Using the <code>spoolRules</code> attribute on <streamCaching>. if you have more rules, then separate them by comma.</p>
<div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">
-<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolRules="mySpoolRule,myOtherSpoolRule"/>
-</pre>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolRules="mySpoolRule,myOtherSpoolRule"/>
+]]></script>
</div></div>
@@ -422,7 +422,7 @@ context.setStreamCaching(true);
<div class="navigation">
<div class="navigation_top">
<!-- NavigationBar -->
-<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overviewhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49132"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentationhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49534"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li>
<li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
+<div class="navigation_bottom" id="navigation_bottom"><h3 id="Navigation-Overview"><a shape="rect" href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a shape="rect" href="download.html">Download</a></li><li><a shape="rect" href="getting-started.html">Getting Started</a></li><li><a shape="rect" href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a shape="rect" href="documentation.html">Documentation</a></h3><ul class="alternate"><li><a shape="rect" href="user-guide.html">User Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a shape="rect" href="books.html">Books</a></li><li><a shape="rect" href="tutorials.html">Tutorials</a></li><li><a shape="rect" href="examples.html">Examples</a></li><li><a shape="rect" href="cookbook.html">Cookbook</a></li><li><a shape="rect" href="architecture.html">Architecture</a></li><li><a shape="rect" href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect" href="components.html">Components</a></li><li><a shape="rect" href="data-format.html">Data Format</a></li><li><a shape="rect" href="languages.html">Languages</a></li><li><a shape="rect" href="security.html">Security</a></li><li><a shape="rect" href="security-advisories.html">Security Advisories</a></li></ul><h3 id="Navigation-Search">Search</h3><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse">
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">
@@ -430,7 +430,7 @@ context.setStreamCaching(true);
<input type="submit" name="sa" value="Search">
</div>
</form>
-<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49115"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developershttps://cwi
ki.apache.org/confluence/pages/viewpage.action?pageId=49124"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
+<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script><h3 id="Navigation-Community"><a shape="rect" href="community.html">Community</a></h3><ul class="alternate"><li><a shape="rect" href="support.html">Support</a></li><li><a shape="rect" href="contributing.html">Contributing</a></li><li><a shape="rect" href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect" href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect" href="user-stories.html">User Stories</a></li><li><a shape="rect" href="news.html">News</a></li><li><a shape="rect" href="articles.html">Articles</a></li><li><a shape="rect" href="site.html">Site</a></li><li><a shape="rect" href="team.html">Team</a></li><li><a shape="rect" class="external-link" href="http://camel-extra.googlecode.com/" rel="nofollow">Camel Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect" href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect" href="source.html">Source</a></li><li><a shape="rect" href="building.html">Building</a></li><li><a shape="rect" href="javadoc.html">JavaDoc</a></li><li><a shape="rect" href="irc-room.html">IRC Room</a></li></ul><h3 id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul class="alternate"><li><a shape="rect" class="external-link" href="http://www.apache.org/licenses/">License</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/foundation/thanks.html">Thanks</a></li><li><a shape="rect" class="external-link" href="http://www.apache.org/security/">Security</a></li></ul></div>
<!-- NavigationBar -->
</div>
</div>