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 2019/03/31 15:23:09 UTC
svn commit: r1042911 [41/48] - in /websites/production/camel/content: ./
2007/08/17/ 2008/04/08/ 2008/04/28/ 2009/01/19/ 2009/10/26/ 2012/01/17/
2012/03/01/ 2019/03/ 2019/03/31/
Modified: websites/production/camel/content/stream-caching.html
==============================================================================
--- websites/production/camel/content/stream-caching.html (original)
+++ websites/production/camel/content/stream-caching.html Sun Mar 31 15:23:07 2019
@@ -108,7 +108,7 @@ This <code>StreamCache</code> is capable
<h3 id="Streamcaching-Enablingstreamcaching">Enabling stream caching</h3>
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
from("jbi:service:http://foo.bar.org/MyService")
.streamCaching()
@@ -117,7 +117,7 @@ from("jbi:service:http://foo.bar.org/MyS
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<route streamCache="true">
<from uri="jbi:service:http://foo.bar.org/MyService"/>
@@ -128,7 +128,7 @@ from("jbi:service:http://foo.bar.org/MyS
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext streamCache="true">
...
@@ -137,7 +137,7 @@ from("jbi:service:http://foo.bar.org/MyS
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<route streamCache="true">
<from uri="jbi:service:http://foo.bar.org/MyService"/>
@@ -147,7 +147,7 @@ from("jbi:service:http://foo.bar.org/MyS
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext streamCache="true">
<route>
@@ -166,7 +166,7 @@ from("jbi:service:http://foo.bar.org/MyS
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.setStreamCache(true);
@@ -179,7 +179,7 @@ from("jbi:service:http://foo.bar.org/MyS
<p>If you have enabled stream caching globally on the CamelContext and you want to disable it for certain routes in a selective manner, you can use the following syntax.</p>
<p><strong>Spring DSL:</strong></p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext streamCache="true">
<route streamCache="false">
@@ -191,7 +191,7 @@ from("jbi:service:http://foo.bar.org/MyS
</div></div>
<p><strong>Java DSL:</strong></p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.setStreamCache(true);
@@ -209,7 +209,7 @@ 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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.getProperties().put(CachedOutputStream.TEMP_DIR, "/tmp/cachedir");
context.getProperties().put(CachedOutputStream.THRESHOLD, "1048576");
@@ -220,7 +220,7 @@ context.getProperties().put(CachedOutput
</div></div>
<p>And in XML you do</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext xmlns="http://camel.apache.org/schema/blueprint">
@@ -236,7 +236,7 @@ context.getProperties().put(CachedOutput
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
// disable spooling to disk
context.getProperties().put(CachedOutputStream.THRESHOLD, "-1");
@@ -244,7 +244,7 @@ context.getProperties().put(CachedOutput
</div></div>
<p>And in XML you do</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext xmlns="http://camel.apache.org/schema/blueprint">
@@ -275,14 +275,14 @@ 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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.getStreamCachingStrategy().setSpoolDirectory"${java.io.tmpdir}#name#/");
</pre>
</div></div>
<p>To store in KARAF_HOME/tmp/bundleId directory</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.getStreamCachingStrategy().setSpoolDirectory"${env:KARAF_HOME}/tmp/bundle#bundleId#");
</pre>
@@ -292,7 +292,7 @@ context.getStreamCachingStrategy().setSp
<h4 id="Streamcaching-UsingStreamCachingStrategyinJava">Using StreamCachingStrategy in Java</h4>
<p>You can configure the <code>StreamCachingStrategy</code> in Java as shown below:</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.getStreamCachingStrategy().setSpoolDirectory"/tmp/cachedir");
context.getStreamCachingStrategy().setSpoolThreshold(64 * 1024);
@@ -303,7 +303,7 @@ context.getStreamCachingStrategy().setBu
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
context.setStreamCaching(true);
</pre>
@@ -312,7 +312,7 @@ context.setStreamCaching(true);
<h4 id="Streamcaching-UsingStreamCachingStrategyinXML">Using StreamCachingStrategy in XML</h4>
<p>And in XML you do:</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<camelContext streamCache="true" xmlns="http://camel.apache.org/schema/blueprint">
@@ -330,7 +330,7 @@ context.setStreamCaching(true);
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<!-- define a bean of type StreamCachingStrategy which CamelContext will automatic use -->
<bean id="streamStrategy" class="org.apache.camel.impl.DefaultStreamCachingStrategy">
@@ -350,7 +350,7 @@ context.setStreamCaching(true);
<p>By default stream caching will spool only big payloads (128kb or bigger) to disk. However you can also set the spoolUsedHeapMemoryThreshold option which is a percentage of used heap memory. This can be used to also spool to disk when running low on memory.</p>
<p>For example with:</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70"/>
</pre>
@@ -359,14 +359,14 @@ context.setStreamCaching(true);
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" anySpoolRules="true"/>
</pre>
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolThreshold="-1" spoolUsedHeapMemoryThreshold="70"/>
</pre>
@@ -375,7 +375,7 @@ context.setStreamCaching(true);
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolUsedHeapMemoryThreshold="70" spoolUsedHeapMemoryLimit="Committed"/>
</pre>
@@ -385,7 +385,7 @@ context.setStreamCaching(true);
<h4 id="Streamcaching-UsingcustomSpoolRuleimplementations">Using custom SpoolRule implementations</h4>
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
boolean shouldSpoolCache(long length);
</pre>
@@ -394,7 +394,7 @@ context.setStreamCaching(true);
<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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
SpoolRule mySpoolRule = ...
context.getStreamCachingStrategy().addSpoolRule(mySpoolRule);
@@ -402,7 +402,7 @@ context.setStreamCaching(true);
</div></div>
<p>And from XML you need to define a <bean> with your custom rule</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<bean id="mySpoolRule" class="com.foo.MySpoolRule"/>
@@ -411,7 +411,7 @@ context.setStreamCaching(true);
</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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<streamCaching id="myCacheConfig" spoolDirectory="/tmp/cachedir" spoolRules="mySpoolRule,myOtherSpoolRule"/>
</pre>
Modified: websites/production/camel/content/stub.html
==============================================================================
--- websites/production/camel/content/stub.html (original)
+++ websites/production/camel/content/stub.html Sun Mar 31 15:23:07 2019
@@ -97,7 +97,7 @@
<h3 id="Stub-URIformat">URI format</h3>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
stub:someUri
</pre>
Modified: websites/production/camel/content/swagger-java.html
==============================================================================
--- websites/production/camel/content/swagger-java.html (original)
+++ websites/production/camel/content/swagger-java.html Sun Mar 31 15:23:07 2019
@@ -87,7 +87,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="SwaggerJava-SwaggerJavaComponent">Swagger Java Component</h2><p><strong>Available as of Camel 2.16</strong></p><p>The  <a shape="rect" href="rest-dsl.html">Rest DSL</a> can be integrated with the <code>camel-swagger-java</code> module which is used for exposing the REST services and their APIs using <a shape="rect" class="external-link" href="http://swagger.io/" rel="nofollow">Swagger</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><p>From <strong>Camel 2.16</strong> onwards the swagger component is purely Java based, and its </p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="SwaggerJava-SwaggerJavaComponent">Swagger Java Component</h2><p><strong>Available as of Camel 2.16</strong></p><p>The  <a shape="rect" href="rest-dsl.html">Rest DSL</a> can be integrated with the <code>camel-swagger-java</code> module which is used for exposing the REST services and their APIs using <a shape="rect" class="external-link" href="http://swagger.io/" rel="nofollow">Swagger</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><p>From <strong>Camel 2.16</strong> onwards the swagger component is purely Java based, and its </p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-swagger-java</artifactId>
@@ -95,7 +95,7 @@
<!-- use the same version as your Camel core version -->
</dependency>
</pre>
-</div></div><p> </p><p>The camel-swagger-java module can be used as a Servlet or directly from the REST components (without the need for servlet)</p><p> For an example see the <code style="line-height: 1.42857;">camel-example-swagger-cdi</code> in the examples directory of the Apache Camel distribution.</p><p> </p><h3 id="SwaggerJava-UsingSwaggerasaServlet">Using Swagger as a Servlet</h3><p>You configure the swagger in the web.xml as shown below:</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p> </p><p>The camel-swagger-java module can be used as a Servlet or directly from the REST components (without the need for servlet)</p><p> For an example see the <code style="line-height: 1.42857;">camel-example-swagger-cdi</code> in the examples directory of the Apache Camel distribution.</p><p> </p><h3 id="SwaggerJava-UsingSwaggerasaServlet">Using Swagger as a Servlet</h3><p>You configure the swagger in the web.xml as shown below:</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"> <servlet>
 
<servlet-name>SwaggerServlet</servlet-name>
@@ -134,7 +134,7 @@
<servlet-name>SwaggerServlet</servlet-name>
<url-pattern>/api-docs/*</url-pattern>
</servlet-mapping></pre>
-</div></div><h3 id="SwaggerJava-UsingSwaggerinrest-dsl">Using Swagger in rest-dsl</h3><p>You can enable the swagger api from the rest-dsl by configuring the <code>apiContextPath</code> dsl as shown below:</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="SwaggerJava-UsingSwaggerinrest-dsl">Using Swagger in rest-dsl</h3><p>You can enable the swagger api from the rest-dsl by configuring the <code>apiContextPath</code> dsl as shown below:</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">public class UserRouteBuilder extends RouteBuilder {
@Override
public void configure() throws Exception {
@@ -164,14 +164,14 @@
.to("bean:userService?method=listUsers");
}
}</pre>
-</div></div><p> </p><h3 id="SwaggerJava-Options">Options</h3><p>The swagger module can be configured using the following options. To configure using a servlet you use the init-param as shown above. When configuring directly in the rest-dsl, you use the appropriate method, such as <code>enableCORS</code>, <code>host,<code>contextPath</code>,</code> dsl. The options with <code>api.xxx</code> is configured using <code>apiProperty</code> dsl.</p><div class="confluenceTableSmall conf-macro output-block" data-hasbody="true" data-macro-name="div"><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>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">cors</td><td colspan="1" rowspan="1" class="confluenceTd">Boolean</td><td colspan="1" rowspan="1"
class="confluenceTd">Whether to enable CORS. Notice this only enables CORS for the api browser, and not the actual access to the REST services. Is default false.<br clear="none">Instead of using this option is recommended to use the CorsFilte, see further below.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">swagger.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Swagger spec version. Is default 2.0.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">host</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">To setup the hostname. If not configured camel-swagger-java will calculate the name as localhost based.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">schemas</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">The protocol schemes to use. Multiple
values can be separated by comma such as "http,https". The default value is "http". This option is <strong>deprecated</strong> from Camel 2.17 onwards due it should have been named schemes.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">schemes</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> <span>The protocol schemes to use. Multiple values can be separated by comma such as "http,https". The default value is "http".</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">base.path<p> </p></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Required</strong>: To setup the base path where the REST services is available. The path is relative (eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be</p><div class="code panel pdl
conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p> </p><h3 id="SwaggerJava-Options">Options</h3><p>The swagger module can be configured using the following options. To configure using a servlet you use the init-param as shown above. When configuring directly in the rest-dsl, you use the appropriate method, such as <code>enableCORS</code>, <code>host,<code>contextPath</code>,</code> dsl. The options with <code>api.xxx</code> is configured using <code>apiProperty</code> dsl.</p><div class="confluenceTableSmall conf-macro output-block" data-hasbody="true" data-macro-name="div"><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>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">cors</td><td colspan="1" rowspan="1" class="confluenceTd">Boolean</td><td colspan="1" rowspan="1"
class="confluenceTd">Whether to enable CORS. Notice this only enables CORS for the api browser, and not the actual access to the REST services. Is default false.<br clear="none">Instead of using this option is recommended to use the CorsFilte, see further below.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">swagger.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Swagger spec version. Is default 2.0.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">host</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">To setup the hostname. If not configured camel-swagger-java will calculate the name as localhost based.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">schemas</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">The protocol schemes to use. Multiple
values can be separated by comma such as "http,https". The default value is "http". This option is <strong>deprecated</strong> from Camel 2.17 onwards due it should have been named schemes.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">schemes</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> <span>The protocol schemes to use. Multiple values can be separated by comma such as "http,https". The default value is "http".</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">base.path<p> </p></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Required</strong>: To setup the base path where the REST services is available. The path is relative (eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be</p><div class="code panel pdl
conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">protocol://host:port/context-path/base.path</pre>
-</div></div></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.path</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>To setup the path where the API is available (eg /api-docs). The path is relative <span>(eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be </span></span></p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.path</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>To setup the path where the API is available (eg /api-docs). The path is relative <span>(eg do not start with http/https) and camel-swagger-java will calculate the absolute base path at runtime, which will be </span></span></p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">protocol://host:port/context-path/api.path</pre>
</div></div><p><span><span>So using relative paths is much easier. See above for an example.</span></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>The version of the api. Is default 0.0.0.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.title</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>The title of the application.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.description</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>A short description of the application.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.<span>termsOfService</span></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1
" rowspan="1" class="confluenceTd"><span>A URL to the Terms of Service of the API.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.contact.name</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Name of person or organization to contact</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.contact.email</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>An email to be used for API-related correspondence.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.contact.url</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">A URL to a website for more contact information.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.license.name</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" clas
s="confluenceTd"><span>The license name used for the API.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.license.url</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>A URL to the license used for the API.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">apiContextIdListing</td><td colspan="1" rowspan="1" class="confluenceTd">boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Whether to allow listing all the CamelContext names in the JVM that has REST services. When enabled then the root path of the api-doc will list all the contexts. When disabled then no context ids is listed and the root path of the api-doc lists the current CamelContext. Is default false.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">apiContextIdPattern</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">A pattern
that allows to filter which CamelContext names is shown in the context listing. The pattern is using regular expression and * as wildcard. Its the same pattern matching as used by <a shape="rect" href="intercept.html">Intercept</a></td></tr></tbody></table></div></div>
-<h3 id="SwaggerJava-CorsFilter">CorsFilter</h3><p>If you use the swagger ui to view the REST api then you likely need to enable support for CORS. This is needed if the swagger ui is hosted and running on another hostname/port than the actual REST apis. When doing this the swagger ui needs to be allowed to access the REST resources across the origin (CORS). The CorsFilter adds the necessary HTTP headers to enable CORS.</p><p>To use CORS adds the following filter <code>org.apache.camel.swagger.servlet.RestSwaggerCorsFilter</code> to your web.xml.</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<h3 id="SwaggerJava-CorsFilter">CorsFilter</h3><p>If you use the swagger ui to view the REST api then you likely need to enable support for CORS. This is needed if the swagger ui is hosted and running on another hostname/port than the actual REST apis. When doing this the swagger ui needs to be allowed to access the REST resources across the origin (CORS). The CorsFilter adds the necessary HTTP headers to enable CORS.</p><p>To use CORS adds the following filter <code>org.apache.camel.swagger.servlet.RestSwaggerCorsFilter</code> to your web.xml.</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"> <!-- enable CORS filter so people can use swagger ui to browse and test the apis -->
<filter>
<filter-name>RestSwaggerCorsFilter</filter-name>
Modified: websites/production/camel/content/swagger.html
==============================================================================
--- websites/production/camel/content/swagger.html (original)
+++ websites/production/camel/content/swagger.html Sun Mar 31 15:23:07 2019
@@ -87,14 +87,14 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Swagger-SwaggerScalaComponent(deprecated)">Swagger Scala Component (deprecated)</h2><p><strong>Available as of Camel 2.14</strong></p><p>The  <a shape="rect" href="rest-dsl.html">Rest DSL</a> can be integrated with the <code>camel-swagger</code> module which is used for exposing the REST services and their APIs using <a shape="rect" class="external-link" href="http://swagger.io/" rel="nofollow">Swagger</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="confluence-information-macro confluence-information-macro-warning conf-macro output-block" data-hasbody="true" data-macro-name="warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>This component is deprecated. From Camel 2.16 onwards use the new Java based swagger module <a shape="re
ct" href="swagger-java.html">Swagger Java</a></p></div></div><p>The Scala based camel-swagger module is deprecated, and to be removed in a future release.</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="Swagger-SwaggerScalaComponent(deprecated)">Swagger Scala Component (deprecated)</h2><p><strong>Available as of Camel 2.14</strong></p><p>The  <a shape="rect" href="rest-dsl.html">Rest DSL</a> can be integrated with the <code>camel-swagger</code> module which is used for exposing the REST services and their APIs using <a shape="rect" class="external-link" href="http://swagger.io/" rel="nofollow">Swagger</a>.</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="confluence-information-macro confluence-information-macro-warning conf-macro output-block" data-hasbody="true" data-macro-name="warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>This component is deprecated. From Camel 2.16 onwards use the new Java based swagger module <a shape="re
ct" href="swagger-java.html">Swagger Java</a></p></div></div><p>The Scala based camel-swagger module is deprecated, and to be removed in a future release.</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-swagger</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency></pre>
-</div></div><h3 id="Swagger-UsingwithCamel2.15.x">Using with Camel 2.15.x</h3><p>The default servlet supports any environment using JMX to discover the CamelContext(s) to use.</p><p>The name of the servlet is <code>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</code>.</p><h3 id="Swagger-UsingwithCamel2.14.x">Using with Camel 2.14.x</h3><p>The Swagger servlet is integrated with Spring or <a shape="rect" href="servletlistener-component.html">ServletListener Component</a>. </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Component</th><th colspan="1" rowspan="1" class="confluenceTh">Servlet ClassName</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">spring</td><td colspan="1" rowspan="1" class="confluenceTd"><code>org.apache.camel.component.swagger.spring.SpringRestSwaggerApiDeclarationServlet</code> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">servlet
listener</td><td colspan="1" rowspan="1" class="confluenceTd"><code>org.apache.camel.component.swagger.servletlistener.ServletListenerRestSwaggerApiDeclarationServlet</code></td></tr></tbody></table></div><p>The servlet support the same options when using spring or servletlistener.</p><div class="confluence-information-macro confluence-information-macro-warning conf-macro output-block" data-hasbody="true" data-macro-name="warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>The servlets above from Camel 2.14.x is deprecated and replaced with a single default servlet from Camel 2.15 onwards.</p></div></div><p> </p><p>For example when using Spring you need to configure the <code>org.apache.camel.component.swagger.spring.SpringRestSwaggerApiDeclarationServlet</code> in the <code>WEB-INF/web.xml</code> file as shown below:</p><div class="confluence-informatio
n-macro confluence-information-macro-tip conf-macro output-block" data-hasbody="true" data-macro-name="tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>If you use Camel 2.15 onwards then just use the default servlet in any kind of environment.</p></div></div><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Swagger-UsingwithCamel2.15.x">Using with Camel 2.15.x</h3><p>The default servlet supports any environment using JMX to discover the CamelContext(s) to use.</p><p>The name of the servlet is <code>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</code>.</p><h3 id="Swagger-UsingwithCamel2.14.x">Using with Camel 2.14.x</h3><p>The Swagger servlet is integrated with Spring or <a shape="rect" href="servletlistener-component.html">ServletListener Component</a>. </p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Component</th><th colspan="1" rowspan="1" class="confluenceTh">Servlet ClassName</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">spring</td><td colspan="1" rowspan="1" class="confluenceTd"><code>org.apache.camel.component.swagger.spring.SpringRestSwaggerApiDeclarationServlet</code> </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">servlet
listener</td><td colspan="1" rowspan="1" class="confluenceTd"><code>org.apache.camel.component.swagger.servletlistener.ServletListenerRestSwaggerApiDeclarationServlet</code></td></tr></tbody></table></div><p>The servlet support the same options when using spring or servletlistener.</p><div class="confluence-information-macro confluence-information-macro-warning conf-macro output-block" data-hasbody="true" data-macro-name="warning"><span class="aui-icon aui-icon-small aui-iconfont-error confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>The servlets above from Camel 2.14.x is deprecated and replaced with a single default servlet from Camel 2.15 onwards.</p></div></div><p> </p><p>For example when using Spring you need to configure the <code>org.apache.camel.component.swagger.spring.SpringRestSwaggerApiDeclarationServlet</code> in the <code>WEB-INF/web.xml</code> file as shown below:</p><div class="confluence-informatio
n-macro confluence-information-macro-tip conf-macro output-block" data-hasbody="true" data-macro-name="tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"> </span><div class="confluence-information-macro-body"><p>If you use Camel 2.15 onwards then just use the default servlet in any kind of environment.</p></div></div><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"> <!-- to setup Camel Swagger api servlet when using Spring -->
<servlet>
 
@@ -151,14 +151,14 @@
<servlet-name>ApiDeclarationServlet</servlet-name>
<url-pattern>/api-docs/*</url-pattern>
</servlet-mapping></pre>
-</div></div><h3 id="Swagger-Options">Options</h3><p>The <code>org.apache.camel.component.swagger.RestSwaggerApiDeclarationServlet </code>and <code>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</code> supports the following options which can be configured as context-param in the web.xml file.</p><div class="confluenceTableSmall conf-macro output-block" data-hasbody="true" data-macro-name="div"><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>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">cors</td><td colspan="1" rowspan="1" class="confluenceTd">Boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Whether to enable CORS. Notice this only enables CORS for the api browser, and not the actual access to the REST services. Is de
fault false.<br clear="none">Instead of using this option is recommended to use the CorsFilte, see further below.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">swagger.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Swagger spec version. Is default 1.2.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">base.path<p> </p></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Required</strong>: To setup the base path where the REST services is available. Using Camel 2.14.x this path must be the absolute path to the services. From Camel 2.15 onwards you can use a relative path instead (eg do not start with http/https) and camel-swagger will calculate the absolute base path at runtime, which will be</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width
: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Swagger-Options">Options</h3><p>The <code>org.apache.camel.component.swagger.RestSwaggerApiDeclarationServlet </code>and <code>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</code> supports the following options which can be configured as context-param in the web.xml file.</p><div class="confluenceTableSmall conf-macro output-block" data-hasbody="true" data-macro-name="div"><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>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">cors</td><td colspan="1" rowspan="1" class="confluenceTd">Boolean</td><td colspan="1" rowspan="1" class="confluenceTd">Whether to enable CORS. Notice this only enables CORS for the api browser, and not the actual access to the REST services. Is de
fault false.<br clear="none">Instead of using this option is recommended to use the CorsFilte, see further below.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">swagger.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Swagger spec version. Is default 1.2.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">base.path<p> </p></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Required</strong>: To setup the base path where the REST services is available. Using Camel 2.14.x this path must be the absolute path to the services. From Camel 2.15 onwards you can use a relative path instead (eg do not start with http/https) and camel-swagger will calculate the absolute base path at runtime, which will be</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name
="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">protocol://host:port/context-path/base.path</pre>
-</div></div><p>So using relative paths is much easier. See above for an example.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">The version of the api. Is default 0.0.0.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.path</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>To setup the path where the API is available (eg /api-docs). <span>Using Camel 2.14.x this path must be the absolute path to the services. From Camel 2.15 onwards you can use a relative path instead (eg do not start with http/https) and camel-swagger will calculate the absolute base path at runtime, which will be </span></span></p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelConten
t pdl">
+</div></div><p>So using relative paths is much easier. See above for an example.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.version</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">The version of the api. Is default 0.0.0.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.path</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><p><span>To setup the path where the API is available (eg /api-docs). <span>Using Camel 2.14.x this path must be the absolute path to the services. From Camel 2.15 onwards you can use a relative path instead (eg do not start with http/https) and camel-swagger will calculate the absolute base path at runtime, which will be </span></span></p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelConten
t pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">protocol://host:port/context-path/api.path</pre>
</div></div><p><span><span>So using relative paths is much easier. See above for an example.</span></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.title</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Required.</strong><span> The title of the application.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.description</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Required.</strong><span> A short description of the application.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.<span>termsOfServiceUrl</span></td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>A URL to the Terms of Service of the API.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.contact</td><td col
span="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>An email to be used for API-related correspondence.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.license</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>The license name used for the API.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.licenseUrl</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>A URL to the license used for the API.</span></td></tr></tbody></table></div></div>
-<h3 id="Swagger-CorsFilter">CorsFilter</h3><p>If you use the swagger ui to view the REST api then you likely need to enable support for CORS. This is needed if the swagger ui is hosted and running on another hostname/port than the actual REST apis. When doing this the swagger ui needs to be allowed to access the REST resources across the origin (CORS). The CorsFilter adds the necessary HTTP headers to enable CORS.</p><p>To use CORS adds the following filter <code>org.apache.camel.component.swagger.RestSwaggerCorsFilter</code> to your web.xml.</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<h3 id="Swagger-CorsFilter">CorsFilter</h3><p>If you use the swagger ui to view the REST api then you likely need to enable support for CORS. This is needed if the swagger ui is hosted and running on another hostname/port than the actual REST apis. When doing this the swagger ui needs to be allowed to access the REST resources across the origin (CORS). The CorsFilter adds the necessary HTTP headers to enable CORS.</p><p>To use CORS adds the following filter <code>org.apache.camel.component.swagger.RestSwaggerCorsFilter</code> to your web.xml.</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"> <!-- enable CORS filter so people can use swagger ui to browse and test the apis -->
<filter>
<filter-name>RestSwaggerCorsFilter</filter-name>
Modified: websites/production/camel/content/syslog.html
==============================================================================
--- websites/production/camel/content/syslog.html (original)
+++ websites/production/camel/content/syslog.html Sun Mar 31 15:23:07 2019
@@ -87,7 +87,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Syslog-SyslogDataFormat">Syslog DataFormat</h2><p><strong>Available as of Camel 2.6</strong></p><p>The <strong>syslog</strong> dataformat is used for working with <a shape="rect" class="external-link" href="http://www.ietf.org/rfc/rfc3164.txt" rel="nofollow">RFC3164</a> and RFC5424 messages.</p><p>This component supports the following:</p><ul class="alternate"><li>UDP consumption of syslog messages</li><li>Agnostic data format using either plain String objects or SyslogMessage model objects.</li><li><a shape="rect" href="type-converter.html">Type Converter</a> from/to SyslogMessage and String</li><li>Integration with the <a shape="rect" href="mina.html">camel-mina</a> component.</li><li>Integration with the <a shape="rect" href="netty.html">camel-netty</a> component.</li><li><strong>Camel 2.14:</strong> Encoder and decoder for the <a shape="rect" href="netty.html">camel-netty</a> component.</li><li><strong>Camel 2.14:</str
ong> Support for RFC5424 also.</li></ul><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 conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="Syslog-SyslogDataFormat">Syslog DataFormat</h2><p><strong>Available as of Camel 2.6</strong></p><p>The <strong>syslog</strong> dataformat is used for working with <a shape="rect" class="external-link" href="http://www.ietf.org/rfc/rfc3164.txt" rel="nofollow">RFC3164</a> and RFC5424 messages.</p><p>This component supports the following:</p><ul class="alternate"><li>UDP consumption of syslog messages</li><li>Agnostic data format using either plain String objects or SyslogMessage model objects.</li><li><a shape="rect" href="type-converter.html">Type Converter</a> from/to SyslogMessage and String</li><li>Integration with the <a shape="rect" href="mina.html">camel-mina</a> component.</li><li>Integration with the <a shape="rect" href="netty.html">camel-netty</a> component.</li><li><strong>Camel 2.14:</strong> Encoder and decoder for the <a shape="rect" href="netty.html">camel-netty</a> component.</li><li><strong>Camel 2.14:</str
ong> Support for RFC5424 also.</li></ul><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 conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-syslog</artifactId>
@@ -95,7 +95,7 @@
<!-- use the same version as your Camel core version -->
</dependency>
</pre>
-</div></div><h3 id="Syslog-RFC3164Syslogprotocol">RFC3164 Syslog protocol</h3><p>Syslog uses the user datagram protocol (UDP) <a shape="rect" class="unresolved" href="#">1</a> as its underlying transport layer mechanism. <br clear="none"> The UDP port that has been assigned to syslog is 514.</p><p>To expose a Syslog listener service we reuse the existing <a shape="rect" href="mina.html">camel-mina</a> component or <a shape="rect" href="netty.html">camel-netty</a> where we just use the <code>Rfc3164SyslogDataFormat</code> to marshal and unmarshal messages. Notice that from <strong>Camel 2.14</strong> onwards the syslog dataformat is renamed to <code>SyslogDataFormat</code>.</p><h3 id="Syslog-RFC5424Syslogprotocol">RFC5424 Syslog protocol</h3><p><strong>Available as of Camel 2.14</strong></p><p>To expose a Syslog listener service we reuse the existing <a shape="rect" href="mina.html">camel-mina</a> component or <a shape="rect" href="netty.html">camel-netty</a> 
;where we just use the <code>SyslogDataFormat</code> to marshal and unmarshal messages</p><h4 id="Syslog-ExposingaSysloglistener">Exposing a Syslog listener</h4><p>In our Spring XML file, we configure an endpoint to listen for udp messages on port 10514, note that in netty we disable the defaultCodec, this <br clear="none"> will allow a fallback to a NettyTypeConverter and delivers the message as an InputStream:</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Syslog-RFC3164Syslogprotocol">RFC3164 Syslog protocol</h3><p>Syslog uses the user datagram protocol (UDP) <a shape="rect" class="unresolved" href="#">1</a> as its underlying transport layer mechanism. <br clear="none"> The UDP port that has been assigned to syslog is 514.</p><p>To expose a Syslog listener service we reuse the existing <a shape="rect" href="mina.html">camel-mina</a> component or <a shape="rect" href="netty.html">camel-netty</a> where we just use the <code>Rfc3164SyslogDataFormat</code> to marshal and unmarshal messages. Notice that from <strong>Camel 2.14</strong> onwards the syslog dataformat is renamed to <code>SyslogDataFormat</code>.</p><h3 id="Syslog-RFC5424Syslogprotocol">RFC5424 Syslog protocol</h3><p><strong>Available as of Camel 2.14</strong></p><p>To expose a Syslog listener service we reuse the existing <a shape="rect" href="mina.html">camel-mina</a> component or <a shape="rect" href="netty.html">camel-netty</a> 
;where we just use the <code>SyslogDataFormat</code> to marshal and unmarshal messages</p><h4 id="Syslog-ExposingaSysloglistener">Exposing a Syslog listener</h4><p>In our Spring XML file, we configure an endpoint to listen for udp messages on port 10514, note that in netty we disable the defaultCodec, this <br clear="none"> will allow a fallback to a NettyTypeConverter and delivers the message as an InputStream:</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><camelContext id="myCamel" xmlns="http://camel.apache.org/schema/spring">
<dataFormats>
@@ -110,7 +110,7 @@
</camelContext>
</pre>
-</div></div><p>The same route using <a shape="rect" href="mina.html">camel-mina</a></p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>The same route using <a shape="rect" href="mina.html">camel-mina</a></p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><camelContext id="myCamel" xmlns="http://camel.apache.org/schema/spring">
<dataFormats>
@@ -125,7 +125,7 @@
</camelContext>
</pre>
-</div></div><h4 id="Syslog-Sendingsyslogmessagestoaremotedestination">Sending syslog messages to a remote destination</h4><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h4 id="Syslog-Sendingsyslogmessagestoaremotedestination">Sending syslog messages to a remote destination</h4><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><camelContext id="myCamel" xmlns="http://camel.apache.org/schema/spring">
<dataFormats>
Modified: websites/production/camel/content/test.html
==============================================================================
--- websites/production/camel/content/test.html (original)
+++ websites/production/camel/content/test.html Sun Mar 31 15:23:07 2019
@@ -88,7 +88,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Test-TestComponent">Test Component</h2><p></p><div class="conf-macro output-block" data-hasbody="false" data-macro-name="include"><a shape="rect" href="testing.html">Testing</a> of distributed and asynchronous processing is notoriously difficult. The <a shape="rect" href="mock.html">Mock</a>, <a shape="rect" href="test.html">Test</a> and <a shape="rect" href="dataset.html">DataSet</a> endpoints work great with the <a shape="rect" href="testing.html">Camel Testing Framework</a> to simplify your unit and integration testing using <a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a> and Camel's large range of <a shape="rect" href="components.html">Components</a> together with the powerful <a shape="rect" href="bean-integration.html">Bean Integration</a>.</div><p>The <strong><code>test</code></strong> component extends the <a shape="rect" href="mock.html">Mock</a> component to support pulling messag
es from another endpoint on startup to set the expected message bodies on the underlying <a shape="rect" href="mock.html">Mock</a> endpoint. That is, you use the test endpoint in a route and messages arriving on it will be implicitly compared to some expected messages extracted from some other location.</p><p>So you can use, for example, an expected set of message bodies as files. This will then set up a properly configured <a shape="rect" href="mock.html">Mock</a> endpoint, which is only valid if the received messages match the number of expected messages and their message payloads are equal.</p><p>Maven users will need to add the following dependency to their <strong><code>pom.xml</code></strong> for this component when using <strong>Camel 2.8</strong> or older:</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="Test-TestComponent">Test Component</h2><p></p><div class="conf-macro output-block" data-hasbody="false" data-macro-name="include"><a shape="rect" href="testing.html">Testing</a> of distributed and asynchronous processing is notoriously difficult. The <a shape="rect" href="mock.html">Mock</a>, <a shape="rect" href="test.html">Test</a> and <a shape="rect" href="dataset.html">DataSet</a> endpoints work great with the <a shape="rect" href="testing.html">Camel Testing Framework</a> to simplify your unit and integration testing using <a shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration Patterns</a> and Camel's large range of <a shape="rect" href="components.html">Components</a> together with the powerful <a shape="rect" href="bean-integration.html">Bean Integration</a>.</div><p>The <strong><code>test</code></strong> component extends the <a shape="rect" href="mock.html">Mock</a> component to support pulling messag
es from another endpoint on startup to set the expected message bodies on the underlying <a shape="rect" href="mock.html">Mock</a> endpoint. That is, you use the test endpoint in a route and messages arriving on it will be implicitly compared to some expected messages extracted from some other location.</p><p>So you can use, for example, an expected set of message bodies as files. This will then set up a properly configured <a shape="rect" href="mock.html">Mock</a> endpoint, which is only valid if the received messages match the number of expected messages and their message payloads are equal.</p><p>Maven users will need to add the following dependency to their <strong><code>pom.xml</code></strong> for this component when using <strong>Camel 2.8</strong> or older:</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default"><dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-spring</artifactId>
@@ -96,13 +96,13 @@
<!-- use the same version as your Camel core version -->
</dependency>
</pre>
-</div></div><p>From <strong>Camel 2.9</strong>: the <a shape="rect" href="test.html">Test</a> component is provided directly in <strong><code>camel-core</code></strong>.</p><h3 id="Test-URIformat">URI format</h3><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>From <strong>Camel 2.9</strong>: the <a shape="rect" href="test.html">Test</a> component is provided directly in <strong><code>camel-core</code></strong>.</p><h3 id="Test-URIformat">URI format</h3><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">test:expectedMessagesEndpointUri
</pre>
</div></div><p>Where <strong><code>expectedMessagesEndpointUri</code></strong> refers to some other <a shape="rect" href="component.html">Component</a> URI that the expected message bodies are pulled from before starting the test.</p><h3 id="Test-URIOptions">URI Options</h3><div class="confluenceTableSmall conf-macro output-block" data-hasbody="true" data-macro-name="div"><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>anyOrder</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.17:</strong> Whether the expected messages should arrive in the same order, or in any order.</p></td><
/tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>delimiter</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>\n|\r</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17:</strong> The delimiter to use when <strong><code>split=true</code></strong>. The delimiter can be a regular expression.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>split</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.17:</strong> If <strong><code>true</code></strong> messages loaded from the test endpoint will be split using the defined <strong><code>delimiter</code></strong>.For example to use a <strong><code>file</code></strong> endpoint to load a file where each line is an expected message. </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>2000</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> The timeout to use when polling for message bodies from the URI.</p></td></tr></tbody></table></div></div>
-<h3 id="Test-Example">Example</h3><p>For example, you could write a test case as follows:</p><div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<h3 id="Test-Example">Example</h3><p>For example, you could write a test case as follows:</p><div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">from("seda:someEndpoint")
.to("test:file://data/expectedOutput?noop=true");
</pre>
Modified: websites/production/camel/content/toasync.html
==============================================================================
--- websites/production/camel/content/toasync.html (original)
+++ websites/production/camel/content/toasync.html Sun Mar 31 15:23:07 2019
@@ -104,7 +104,7 @@
<p>Camel now has a new DSL named <code>toAsync</code> in the Java DSL. And in Spring XML there is a new <code>async</code> boolean attribute on the <code><to></code> XML tag. So in a Camel route you can leverage this by just using a using this when sending to an endpoint when you do <a shape="rect" href="request-reply.html">Request Reply</a> messaging.</p>
<p>The route below is from a unit test in Camel. Notice the new <code>toAsync</code> where we use this in action. What happens is that the message is send asynchronously to the <code>direct:bar</code> endpoint. When the reply comes back the message is continued being routed on <em>the other side</em> where its routed to the <code>mock:result</code> endpoint. The number 5 indicates the thread pool size, so we have 5 concurrent consumers to route the replies when they come back.</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
from("direct:start").to("mock:a").toAsync("direct:bar", 5).to("mock:result");
@@ -118,7 +118,7 @@
<h4 id="ToAsync-The">The <a shape="rect" href="http-async-example.html">HTTP Async Example</a></h4>
<p>In this example we use the following route:</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<route>
<!-- we route from a direct endpoint -->
@@ -140,7 +140,7 @@ To learn more see and try this example y
<h3 id="ToAsync-HowthisworksinsideCamel">How this works inside Camel</h3>
<p>Camel uses the <code>org.apache.camel.AsyncProcessor</code> which is responsible for processing the non blocking message.</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
void process(Exchange exchange, AsyncCallback callback) throws Exception;
</pre>
@@ -148,7 +148,7 @@ void process(Exchange exchange, AsyncCal
<p>The idea is that you invoke the callback when the reply is ready. </p>
<p>The <code>org.apache.camel.AsyncCallback</code> has the following method</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
void onTaskCompleted(Exchange exchange);
</pre>
@@ -162,7 +162,7 @@ If you want to take a look its implement
<p>This class is currently the only implementation of this feature.</p>
<p>Basically you do implement the <code>AsyncProcessor</code> interface</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
public class JettyHttpProducer extends DefaultProducer implements AsyncProcessor
</pre>
@@ -178,14 +178,14 @@ See the class <code>JettyContentExchange
<p>You configure the thread pool on the <code>toAsync</code> by either supply a pool size as the 2nd parameter as we saw in the first example.<br clear="none">
But you can also refer to a <code>java.util.concurrent.ExecutorService</code> as follows:</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
from("direct:start").to("mock:a").toAsync("direct:bar").executorServiceRef("mySharedPool").to("mock:result");
</pre>
</div></div>
<p>In the Spring XML there is an attribute to refer to the thread pool</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<to uri="jetty://http://0.0.0.0:9123/myapp" async="true" executorServiceRef="mySharedPool"/>
</pre>
Modified: websites/production/camel/content/tutorial-for-camel-on-google-app-engine.html
==============================================================================
--- websites/production/camel/content/tutorial-for-camel-on-google-app-engine.html (original)
+++ websites/production/camel/content/tutorial-for-camel-on-google-app-engine.html Sun Mar 31 15:23:07 2019
@@ -113,7 +113,7 @@
<p>First, checkout the sources from the Camel code repository.</p>
-<div class="preformatted panel conf-macro output-block" data-hasbody="true" data-macro-name="noformat" style="border-width: 1px;"><div class="preformattedContent panelContent">
+<div class="preformatted panel conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="noformat"><div class="preformattedContent panelContent">
<pre>svn co http://svn.apache.org/repos/asf/camel/trunk camel
</pre>
</div></div>
@@ -122,7 +122,7 @@
<p>Open the <code>camel-example-gae/src/main/webapp/WEB-INF/application-web.xml</code> file and replace the template application name <code>replaceme</code> with the name of the application that you created in the previous section. Optionally, adjust the version number if needed.</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>appengine-web.xml</b></div><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>appengine-web.xml</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
<?xml version="1.0" encoding="utf-8"?>
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
@@ -146,14 +146,14 @@
<p>Then go to the <code>camel-example-gae</code> directory and enter</p>
-<div class="preformatted panel conf-macro output-block" data-hasbody="true" data-macro-name="noformat" style="border-width: 1px;"><div class="preformattedContent panelContent">
+<div class="preformatted panel conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="noformat"><div class="preformattedContent panelContent">
<pre>mvn install
</pre>
</div></div>
<p>This will create the application <code>war</code> file in the target directory. Finally use the <code>appcfg</code> command-line tool of the App Engine SDK to deploy the application.</p>
-<div class="preformatted panel conf-macro output-block" data-hasbody="true" data-macro-name="noformat" style="border-width: 1px;"><div class="preformattedContent panelContent">
+<div class="preformatted panel conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="noformat"><div class="preformattedContent panelContent">
<pre>appcfg update target/camel-example-gae-<version>
</pre>
</div></div>
@@ -176,7 +176,7 @@
<p>The <code>home</code> link brings you back to the main page, the logout link is to logout from the application (which brings you back to the login page). In the background, the current weather conditions for the user-entered city will be retrieved from the Google weather service and a formatted weather report will be send by email. Submitting the form the first time initializes the application on Google App Engine which can take several seconds. Subsequent submissions (within a certain time frame) are served much faster. Check your emails and you should now see a new email with subject <code>Wheather report</code> and content similar to this one:</p>
-<div class="preformatted panel conf-macro output-block" data-hasbody="true" data-macro-name="noformat" style="border-width: 1px;"><div class="preformattedContent panelContent">
+<div class="preformatted panel conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="noformat"><div class="preformattedContent panelContent">
<pre>Weather report for: London, England
Current condition: Klar
Current temperature: 12 (Celsius)
@@ -189,7 +189,7 @@ Current temperature: 12 (Celsius)
<p>The <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/examples/camel-example-gae/src/main/java/org/apache/camel/example/gae/TutorialRouteBuilder.java?view=markup"><code>TutorialRouteBuilder</code></a> implements the message processing routes shown in the <a shape="rect" href="#TutorialforCamelonGoogleAppEngine-Overview">#Overview</a> section. Input form data are received via the <a shape="rect" href="ghttp.html">ghttp</a> component. After receiving the request a <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/examples/camel-example-gae/src/main/java/org/apache/camel/example/gae/RequestProcessor.java?view=markup"><code>RequestProcessor</code></a> adds the form data and information about the current user to a <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/examples/camel-example-gae/src/main/java/org/apache/camel/example/gae/ReportData.java?view=markup"><code>ReportData</cod
e></a> POJO. The <code>ReportData</code> object is then serialized and queued for background processing. Queueing messages on GAE is done with the <a shape="rect" href="gtask.html">gtask</a> component. After adding the <code>ReportData</code> object to the queue an HTML response is generated with the <a shape="rect" class="external-link" href="http://svn.apache.org/viewvc/camel/trunk/examples/camel-example-gae/src/main/java/org/apache/camel/example/gae/ResponseProcessor.java?view=markup"><code>ResponseProcessor</code></a>.</p>
-<div class="code panel pdl conf-macro output-block" data-hasbody="true" data-macro-name="code" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>TutorialRouteBuilder.java</b></div><div class="codeContent panelContent pdl">
+<div class="code panel pdl conf-macro output-block" style="border-width: 1px;" data-hasbody="true" data-macro-name="code"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>TutorialRouteBuilder.java</b></div><div class="codeContent panelContent pdl">
<pre class="syntaxhighlighter-pre" data-syntaxhighlighter-params="brush: java; gutter: false; theme: Default" data-theme="Default">
package org.apache.camel.example.gae;