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 2016/04/01 09:20:57 UTC
svn commit: r984391 [1/2] - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
netty-http.html netty.html netty4-http.html
Author: buildbot
Date: Fri Apr 1 07:20:57 2016
New Revision: 984391
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/book-component-appendix.html
websites/production/camel/content/book-in-one-page.html
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/netty-http.html
websites/production/camel/content/netty.html
websites/production/camel/content/netty4-http.html
Modified: websites/production/camel/content/book-component-appendix.html
==============================================================================
--- websites/production/camel/content/book-component-appendix.html (original)
+++ websites/production/camel/content/book-component-appendix.html Fri Apr 1 07:20:57 2016
@@ -1016,11 +1016,11 @@ template.send("direct:alias-verify&
]]></script>
</div></div><p></p><h3 id="BookComponentAppendix-SeeAlso.8">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><ul><li><a shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a shape="rect" href="data-format.html">Data Format</a></li></ul> <h2 id="BookComponentAppendix-CXFComponent">CXF Component</h2><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>When using CXF as a consumer, the <a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you to factor out how message payloads are received from their processing as a RESTful or SOAP web service. This has the potential of using a multitude of transports to cons
ume web services. The bean component's configuration is also simpler and provides the fastest method to implement web services using Camel and CXF.</p></div></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When using CXF in streaming modes (see DataFormat option), then also read about <a shape="rect" href="stream-caching.html">Stream caching</a>.</p></div></div><p>The <strong>cxf:</strong> component provides integration with <a shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1459459302198 {padding: 0px;}
-div.rbtoc1459459302198 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1459459302198 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1459495131576 {padding: 0px;}
+div.rbtoc1459495131576 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1459495131576 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1459459302198">
+/*]]>*/</style></p><div class="toc-macro rbtoc1459495131576">
<ul class="toc-indentation"><li><a shape="rect" href="#BookComponentAppendix-CXFComponent">CXF Component</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookComponentAppendix-URIformat">URI format</a></li><li><a shape="rect" href="#BookComponentAppendix-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookComponentAppendix-Thedescriptionsofthedataformats">The descriptions of the dataformats</a>
@@ -7208,7 +7208,7 @@ Camel also provides a <a shape="rect" hr
<p>In Spring XML its just a matter of defining a Spring bean with the type <code>EventNotifier</code> and Camel will pick it up as documented here: <a shape="rect" href="advanced-configuration-of-camelcontext-using-spring.html">Advanced configuration of CamelContext using Spring</a>.</p>
<h3 id="BookComponentAppendix-SeeAlso.44">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> <h2 id="BookComponentAppendix-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><p> </p><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>There is a <a shape="rect" href="netty4.html">Netty4</a> component that is using the newer Netty 4 which is recommend to use as this component is using the older Netty 3 library.</p></div></div><p>The <strong>netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" rel="nofollow
">Netty</a> project.<br clear="none"> Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programming such as TCP and UDP socket server.</p><p>This camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
+<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> <h2 id="BookComponentAppendix-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><div class="confluence-information-macro confluence-information-macro-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. You should use <a shape="rect" href="netty4.html">Netty4</a>.</p></div></div><p>The <strong style="line-height: 1.42857;">netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" style="line-height: 1.42857;" rel="nofollow">Netty</a> project.</p><p>Netty is a
NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programming such as TCP and UDP socket server.</p><p>This camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-netty</artifactId>
Modified: websites/production/camel/content/book-in-one-page.html
==============================================================================
--- websites/production/camel/content/book-in-one-page.html (original)
+++ websites/production/camel/content/book-in-one-page.html Fri Apr 1 07:20:57 2016
@@ -3729,11 +3729,11 @@ The tutorial has been designed in two pa
While not actual tutorials you might find working through the source of the various <a shape="rect" href="examples.html">Examples</a> useful.</li></ul>
<h2 id="BookInOnePage-TutorialonSpringRemotingwithJMS">Tutorial on Spring Remoting with JMS</h2><p> </p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Thanks</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>This tutorial was kindly donated to Apache Camel by Martin Gilday.</p></div></div><h2 id="BookInOnePage-Preface">Preface</h2><p>This tutorial aims to guide the reader through the stages of creating a project which uses Camel to facilitate the routing of messages from a JMS queue to a <a shape="rect" class="external-link" href="http://www.springramework.org" rel="nofollow">Spring</a> service. The route works in a synchronous fashion returning a response to the client.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1459459188761 {padding: 0px;}
-div.rbtoc1459459188761 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1459459188761 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1459495154288 {padding: 0px;}
+div.rbtoc1459495154288 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1459495154288 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1459459188761">
+/*]]>*/</style></p><div class="toc-macro rbtoc1459495154288">
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-TutorialonSpringRemotingwithJMS">Tutorial on Spring Remoting with JMS</a></li><li><a shape="rect" href="#BookInOnePage-Preface">Preface</a></li><li><a shape="rect" href="#BookInOnePage-Prerequisites">Prerequisites</a></li><li><a shape="rect" href="#BookInOnePage-Distribution">Distribution</a></li><li><a shape="rect" href="#BookInOnePage-About">About</a></li><li><a shape="rect" href="#BookInOnePage-CreatetheCamelProject">Create the Camel Project</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-UpdatethePOMwithDependencies">Update the POM with Dependencies</a></li></ul>
</li><li><a shape="rect" href="#BookInOnePage-WritingtheServer">Writing the Server</a>
@@ -5848,11 +5848,11 @@ So we completed the last piece in the pi
<p>This example has been removed from <strong>Camel 2.9</strong> onwards. Apache Axis 1.4 is a very old and unsupported framework. We encourage users to use <a shape="rect" href="cxf.html">CXF</a> instead of Axis.</p></div></div>
<style type="text/css">/*<![CDATA[*/
-div.rbtoc1459459190107 {padding: 0px;}
-div.rbtoc1459459190107 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1459459190107 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1459495154961 {padding: 0px;}
+div.rbtoc1459495154961 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1459495154961 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style><div class="toc-macro rbtoc1459459190107">
+/*]]>*/</style><div class="toc-macro rbtoc1459495154961">
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-TutorialusingAxis1.4withApacheCamel">Tutorial using Axis 1.4 with Apache Camel</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-Prerequisites">Prerequisites</a></li><li><a shape="rect" href="#BookInOnePage-Distribution">Distribution</a></li><li><a shape="rect" href="#BookInOnePage-Introduction">Introduction</a></li><li><a shape="rect" href="#BookInOnePage-SettinguptheprojecttorunAxis">Setting up the project to run Axis</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-Maven2">Maven 2</a></li><li><a shape="rect" href="#BookInOnePage-wsdl">wsdl</a></li><li><a shape="rect" href="#BookInOnePage-ConfiguringAxis">Configuring Axis</a></li><li><a shape="rect" href="#BookInOnePage-RunningtheExample">Running the Example</a></li></ul>
@@ -17281,11 +17281,11 @@ template.send("direct:alias-verify&
]]></script>
</div></div><p></p><h3 id="BookInOnePage-SeeAlso.28">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><ul><li><a shape="rect" href="crypto.html">Crypto</a> Crypto is also available as a <a shape="rect" href="data-format.html">Data Format</a></li></ul> <h2 id="BookInOnePage-CXFComponent">CXF Component</h2><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>When using CXF as a consumer, the <a shape="rect" href="cxf-bean-component.html">CXF Bean Component</a> allows you to factor out how message payloads are received from their processing as a RESTful or SOAP web service. This has the potential of using a multitude of transports to consume web
services. The bean component's configuration is also simpler and provides the fastest method to implement web services using Camel and CXF.</p></div></div><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>When using CXF in streaming modes (see DataFormat option), then also read about <a shape="rect" href="stream-caching.html">Stream caching</a>.</p></div></div><p>The <strong>cxf:</strong> component provides integration with <a shape="rect" href="http://cxf.apache.org">Apache CXF</a> for connecting to JAX-WS services hosted in CXF.</p><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1459459215765 {padding: 0px;}
-div.rbtoc1459459215765 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1459459215765 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1459495174186 {padding: 0px;}
+div.rbtoc1459495174186 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1459495174186 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1459459215765">
+/*]]>*/</style></p><div class="toc-macro rbtoc1459495174186">
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-CXFComponent">CXF Component</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-URIformat">URI format</a></li><li><a shape="rect" href="#BookInOnePage-Options">Options</a>
<ul class="toc-indentation"><li><a shape="rect" href="#BookInOnePage-Thedescriptionsofthedataformats">The descriptions of the dataformats</a>
@@ -23473,7 +23473,7 @@ Camel also provides a <a shape="rect" hr
<p>In Spring XML its just a matter of defining a Spring bean with the type <code>EventNotifier</code> and Camel will pick it up as documented here: <a shape="rect" href="advanced-configuration-of-camelcontext-using-spring.html">Advanced configuration of CamelContext using Spring</a>.</p>
<h3 id="BookInOnePage-SeeAlso.64">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> <h2 id="BookInOnePage-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><p> </p><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>There is a <a shape="rect" href="netty4.html">Netty4</a> component that is using the newer Netty 4 which is recommend to use as this component is using the older Netty 3 library.</p></div></div><p>The <strong>netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" rel="nofollow">Netty<
/a> project.<br clear="none"> Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programming such as TCP and UDP socket server.</p><p>This camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
+<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> <h2 id="BookInOnePage-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><div class="confluence-information-macro confluence-information-macro-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. You should use <a shape="rect" href="netty4.html">Netty4</a>.</p></div></div><p>The <strong style="line-height: 1.42857;">netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" style="line-height: 1.42857;" rel="nofollow">Netty</a> project.</p><p>Netty is a NIO clie
nt server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programming such as TCP and UDP socket server.</p><p>This camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-netty</artifactId>
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/netty-http.html
==============================================================================
--- websites/production/camel/content/netty-http.html (original)
+++ websites/production/camel/content/netty-http.html Fri Apr 1 07:20:57 2016
@@ -85,7 +85,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="NettyHTTP-NettyHTTPComponent">Netty HTTP Component</h2><p><strong>Available as of Camel 2.12</strong></p><p>The <strong>netty-http</strong> component is an extension to <a shape="rect" href="netty.html">Netty</a> component to facilitiate HTTP transport with <a shape="rect" href="netty.html">Netty</a>.</p><p>This camel component supports both producer and consumer endpoints.</p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Upgrade to Netty 4.0 planned</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>This component is intended to be upgraded to use Netty 4.0 when <code>camel-netty4</code> component has finished being upgraded. At the time being this component is still based on Netty 3.x. The upgrade is intended to be as backwards compatible as possible.</p></div></div><div class="conflue
nce-information-macro confluence-information-macro-information"><p class="title">Stream</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Netty is stream based, which means the input it receives is submitted to Camel as a stream. That means you will only be able to read the content of the stream <strong>once</strong>.<br clear="none"> If you find a situation where the message body appears to be empty or you need to access the data multiple times (eg: doing multicasting, or redelivery error handling)<br clear="none"> you should use <a shape="rect" href="stream-caching.html">Stream caching</a> or convert the message body to a <code>String</code> which is safe to be re-read multiple times.</p></div></div><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="codeConte
nt panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="NettyHTTP-NettyHTTPComponent">Netty HTTP Component</h2><p><strong>Available as of Camel 2.12</strong></p><p>The <strong>netty-http</strong> component is an extension to <a shape="rect" href="netty.html">Netty</a> component to facilitiate HTTP transport with <a shape="rect" href="netty.html">Netty</a>.</p><p>This camel component supports both producer and consumer endpoints.</p><div class="confluence-information-macro confluence-information-macro-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. You should use <a shape="rect" href="netty4-http.html">Netty4 HTTP</a>.</p></div></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Stream</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluen
ce-information-macro-body"><p>Netty is stream based, which means the input it receives is submitted to Camel as a stream. That means you will only be able to read the content of the stream <strong>once</strong>.<br clear="none"> If you find a situation where the message body appears to be empty or you need to access the data multiple times (eg: doing multicasting, or redelivery error handling)<br clear="none"> you should use <a shape="rect" href="stream-caching.html">Stream caching</a> or convert the message body to a <code>String</code> which is safe to be re-read multiple times.</p><p><span>Notice Netty4 HTTP reads the entire stream into memory using </span><code>io.netty.handler.codec.http.HttpObjectAggregator</code><span> to build the entire full http message. But the resulting message is still a stream based message which is readable once.</span></p></div></div><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div cla
ss="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-netty-http</artifactId>
@@ -96,7 +96,7 @@
</div></div><h3 id="NettyHTTP-URIformat">URI format</h3><p>The URI scheme for a netty component is as follows</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[netty-http:http://localhost:8080[?options]
]]></script>
-</div></div><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Query parameters vs endpoint options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You may be wondering how Camel recognizes URI query parameters and endpoint options. For example you might create endpoint URI as follows - <code>netty-http:http//example.com?myParam=myValue&compression=true</code> . In this example <code>myParam</code> is the HTTP parameter, while <code>compression</code> is the Camel endpoint option. The strategy used by Camel in such situations is to resolve available endpoint options and remove them from the URI. It means that for the discussed example, the HTTP request sent by Netty HTTP producer to the endpoint will look as f
ollows - <code>http//example.com?myParam=myValue</code> , because <code>compression</code> endpoint option will be resolved and removed from the target URL.</p><p>Keep also in mind that you cannot specify endpoint options using dynamic headers (like <code>CamelHttpQuery</code>). Endpoint options can be specified only at the endpoint URI definition level (like <code>to</code> or <code>from</code> DSL elements).</p></div></div><h3 id="NettyHTTP-HTTPOptions">HTTP Options</h3><div class="confluence-information-macro confluence-information-macro-information"><p class="title">A lot more options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p><strong>Important:</strong> This component inherits all the options from <a shape="rect" href="netty.html">Netty</a>. So make sure to look at the <a shape="rect" href="netty.html">Netty</a> documentation as well.<br clear="none"> Notice that some
options from <a shape="rect" href="netty.html">Netty</a> is not applicable when using this <a shape="rect" href="netty-http.html">Netty HTTP</a> component, such as options related to UDP transport.</p></div></div><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>chunkedMaxContentLength</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1mb</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Value in bytes the max content length per chunked frame received on the Netty HTTP server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>compression</code></p></td><td colspan="1" rowspan="1" class="confluenc
eTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.spi.HeaderFilterStrategy</code> to filter headers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpMethodRestrict</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>mapHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd">
<p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If this option is enabled, then during binding from Netty to Camel <a shape="rect" href="message.html">Message</a> then the headers will be mapped as well (eg added as header to the Camel <a shape="rect" href="message.html">Message</a> as well). You can turn off this option to disable this. The headers can still be accessed from the <code>org.apache.camel.component.netty.http.NettyHttpMessage</code> message with the method <code>getHttpRequest()</code> that returns the Netty HTTP request <code>org.jboss.netty.handler.codec.http.HttpRequest</code> instance.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>matchOnUriPrefix</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. Se
e further below for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>nettyHttpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> for binding to/from Netty and Camel Message API.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bridgeEndpoint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If the option is <code>true</code>, the producer will ignore the <code>Exchange.HTTP_URI</code> header, and use the endpoint's URI for request. You may also set the <code>throwExceptionOnFailure</code> to be <code>false</code> to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form
encoding (by adding the <code>Exchange.SKIP_GZIP_ENCODING</code> and <code>Exchange.SKIP_WWW_FORM_URLENCODED</code> headers to the consumed exchange).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnFailure</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Option to disable throwing the <code>HttpOperationFailedException</code> in case of failed responses from the remote server. This allows you to get all responses regardles of the HTTP status code.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>traceEnabled</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>transferException</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a <code>application/x-java-serialized-object</code> content type. On the producer side the exception will be deserialized and thrown as is, instead of the <code>HttpOperationFailedException</code>. The caused exception is required to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlDecodeHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If this option is enabled, then during binding from Netty to Camel <a shape="rect" href="message.html">Message</a> then the header values will be URL decoded (eg %20 will b
e a space character. Notice this option is used by the default <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> and therefore if you implement a custom <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> then you would need to decode the headers accordingly to this option. <strong>Notice:</strong> This option is default <code>true</code> for Camel 2.12.x, and default <code>false</code> from Camel 2.13 onwards.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>nettySharedHttpServer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a shared <a shape="rect" href="netty-http.html">Netty HTTP</a> server. See <a shape="rect" href="netty-http-server-example.html">Netty HTTP Server Example</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disableStreamCache</code></p></td><td colspan="
1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Determines whether or not the raw input stream from Netty <code>HttpRequest#getContent()</code> is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to <code>true</code> when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityConfiguration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</
code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Consumer only</strong>. Refers to a <code>org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration</code> for configuring secure web resources.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>send503whenSuspended</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Consumer only</strong>. Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is <code>false</code> then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>maxHeaderSize</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>8192</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15.3:</strong> <strong>Consumer only.
</strong>The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameException will be raised.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>okStatusCodeRange</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>200-299</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span class="hl_identifier">useRelativePath</span></td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16: Producer only:</strong> Whether to use a path (/myapp) in the request line or an absolute URI (<a shape="rect" class="external-link" href="http://0.0.0.0:8080/myapp%29," rel="nofollow">http://0.0.0.0:80
80/myapp),</a> which is default.</td></tr></tbody></table></div></div><p>The <code>NettyHttpSecurityConfiguration</code> has the following options:</p><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>authenticate</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether authentication is enabled. Can be used to quickly turn this off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>constraint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Basic</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The c
onstraint supported. Currently only <code>Basic</code> is implemented and supported.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>realm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name of the JAAS security realm. This option is mandatory.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityConstraint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to plugin a security constraint mapper where you can define ACL to web resources.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityAuthenticator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to plugin a authenticator that performs the au
thentication. If none has been configured then the <code>org.apache.camel.component.netty.http.JAASSecurityAuthenticator</code> is used by default.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>loginDeniedLoggingLevel</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>DEBUG</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Logging level used when a login attempt failed, which allows to see more details why the login failed.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>roleClassName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To specify FQN class names of <code>Principal</code> implementations that contains user roles. If none has been specified, then the <a shape="rect" href="netty-http.html">Netty HTTP</a> component will by default assume a <code>Principal</code> is role based if its FQ
N classname has the lower-case word <code>role</code> in its classname. You can specify multiple class names separated by comma.</p></td></tr></tbody></table></div></div><h3 id="NettyHTTP-MessageHeaders">Message Headers</h3><p>The following headers can be used on the producer to control the HTTP request.</p><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>CamelHttpMethod</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allow to control what HTTP method to use such as GET, POST, TRACE etc. The type can also be a <code>org.jboss.netty.handler.codec.http.HttpMethod</code> ins
tance.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to provide URI query parameters as a <code>String</code> value that overrides the endpoint configuration. Separate multiple parameters using the & sign. For example: <code>foo=bar&beer=yes</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpPath</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13.1/2.12.4:</strong> Allows to provide URI context-path and query parameters as a <code>String</code> value that overrides the endpoint configuration. This allows to reuse the same producer for calling same remote http server, but using a dynamic context-path and query parameters.</p></t
d></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Content-Type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To set the content-type of the HTTP body. For example: <code>text/plain; charset="UTF-8"</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>CamelHttpResponseCode</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>int</code></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to set the HTTP Status code to use. By default 200 is used for success, and 500 for failure.</td></tr></tbody></table></div></div><p>The following headers is provided as meta-data when a route starts from an <a shape="rect" href="netty-http.html">Netty HTTP</a> endpoint:</p><p>The description in the table takes offset in a route having: <code>from("netty-http:http:0.0.0.0:8080/myapp")...</code></p><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>CamelHttpMethod</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP method used, such as GET, POST, TRACE etc.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpUrl</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The URL including protocol, host and port, etc:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Query parameters vs endpoint options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You may be wondering how Camel recognizes URI query parameters and endpoint options. For example you might create endpoint URI as follows - <code>netty-http:http//example.com?myParam=myValue&compression=true</code> . In this example <code>myParam</code> is the HTTP parameter, while <code>compression</code> is the Camel endpoint option. The strategy used by Camel in such situations is to resolve available endpoint options and remove them from the URI. It means that for the discussed example, the HTTP request sent by Netty HTTP producer to the endpoint will look as f
ollows - <code>http//example.com?myParam=myValue</code> , because <code>compression</code> endpoint option will be resolved and removed from the target URL.</p><p>Keep also in mind that you cannot specify endpoint options using dynamic headers (like <code>CamelHttpQuery</code>). Endpoint options can be specified only at the endpoint URI definition level (like <code>to</code> or <code>from</code> DSL elements).</p></div></div><h3 id="NettyHTTP-HTTPOptions">HTTP Options</h3><div class="confluence-information-macro confluence-information-macro-information"><p class="title">A lot more options</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p><strong>Important:</strong> This component inherits all the options from <a shape="rect" href="netty.html">Netty</a>. So make sure to look at the <a shape="rect" href="netty.html">Netty</a> documentation as well.<br clear="none"> Notice that some
options from <a shape="rect" href="netty.html">Netty</a> is not applicable when using this <a shape="rect" href="netty-http.html">Netty HTTP</a> component, such as options related to UDP transport.</p></div></div><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>chunkedMaxContentLength</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>1mb</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Value in bytes the max content length per chunked frame received on the Netty HTTP server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>compression</code></p></td><td colspan="1" rowspan="1" class="confluenc
eTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allow using gzip/deflate for compression on the Netty HTTP server if the client supports it from the HTTP headers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.spi.HeaderFilterStrategy</code> to filter headers.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpMethodRestrict</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To disable HTTP methods on the Netty HTTP consumer. You can specify multiple separated by comma.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>mapHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd">
<p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If this option is enabled, then during binding from Netty to Camel <a shape="rect" href="message.html">Message</a> then the headers will be mapped as well (eg added as header to the Camel <a shape="rect" href="message.html">Message</a> as well). You can turn off this option to disable this. The headers can still be accessed from the <code>org.apache.camel.component.netty.http.NettyHttpMessage</code> message with the method <code>getHttpRequest()</code> that returns the Netty HTTP request <code>org.jboss.netty.handler.codec.http.HttpRequest</code> instance.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>matchOnUriPrefix</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether or not Camel should try to find a target consumer by matching the URI prefix if no exact match is found. Se
e further below for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>nettyHttpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> for binding to/from Netty and Camel Message API.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bridgeEndpoint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If the option is <code>true</code>, the producer will ignore the <code>Exchange.HTTP_URI</code> header, and use the endpoint's URI for request. You may also set the <code>throwExceptionOnFailure</code> to be <code>false</code> to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form
encoding (by adding the <code>Exchange.SKIP_GZIP_ENCODING</code> and <code>Exchange.SKIP_WWW_FORM_URLENCODED</code> headers to the consumed exchange).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnFailure</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Option to disable throwing the <code>HttpOperationFailedException</code> in case of failed responses from the remote server. This allows you to get all responses regardles of the HTTP status code.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>traceEnabled</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Specifies whether to enable HTTP TRACE for this Netty HTTP consumer. By default TRACE is turned off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p>
<code>transferException</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a <code>application/x-java-serialized-object</code> content type. On the producer side the exception will be deserialized and thrown as is, instead of the <code>HttpOperationFailedException</code>. The caused exception is required to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlDecodeHeaders</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p> </p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If this option is enabled, then during binding from Netty to Camel <a shape="rect" href="message.html">Message</a> then the header values will be URL decoded (eg %20 will b
e a space character. Notice this option is used by the default <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> and therefore if you implement a custom <code>org.apache.camel.component.netty.http.NettyHttpBinding</code> then you would need to decode the headers accordingly to this option. <strong>Notice:</strong> This option is default <code>true</code> for Camel 2.12.x, and default <code>false</code> from Camel 2.13 onwards.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>nettySharedHttpServer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a shared <a shape="rect" href="netty-http.html">Netty HTTP</a> server. See <a shape="rect" href="netty-http-server-example.html">Netty HTTP Server Example</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disableStreamCache</code></p></td><td colspan="
1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Determines whether or not the raw input stream from Netty <code>HttpRequest#getContent()</code> is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to <code>true</code> when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream.</p><p><span>Notice Netty4 HTTP reads the entire stream into memory using </span><code>io.netty.handler.codec.http.HttpObjectAggregator</code><span> to build the entire full htt
p message. But the resulting message is still a stream based message which is readable once.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityConfiguration</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Consumer only</strong>. Refers to a <code>org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration</code> for configuring secure web resources.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>send503whenSuspended</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Consumer only</strong>. Whether to send back HTTP status code 503 when the consumer has been suspended. If the option is <code>false</code> then the Netty Acceptor is unbound when the consumer is suspended, so clients cannot connect anymore.<
/p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>maxHeaderSize</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>8192</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.15.3:</strong> <strong>Consumer only. </strong>The maximum length of all headers. If the sum of the length of each header exceeds this value, a TooLongFrameException will be raised.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>okStatusCodeRange</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>200-299</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> The status codes which is considered a success response. The values are inclusive. The range must be defined as from-to with the dash included.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><span class="hl_identifier">useRelativePath</span></td><td colspan="1" rowspan="1" class="confluenceTd">false
</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16: Producer only:</strong> Whether to use a path (/myapp) in the request line or an absolute URI (<a shape="rect" class="external-link" href="http://0.0.0.0:8080/myapp%29," rel="nofollow">http://0.0.0.0:8080/myapp),</a> which is default.</td></tr></tbody></table></div></div><p>The <code>NettyHttpSecurityConfiguration</code> has the following options:</p><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>authenticate</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether authentication is enabled.
Can be used to quickly turn this off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>constraint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Basic</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The constraint supported. Currently only <code>Basic</code> is implemented and supported.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>realm</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name of the JAAS security realm. This option is mandatory.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>securityConstraint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to plugin a security constraint mapper where you can define ACL to web resources.</p></td></tr><tr><t
d colspan="1" rowspan="1" class="confluenceTd"><p><code>securityAuthenticator</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to plugin a authenticator that performs the authentication. If none has been configured then the <code>org.apache.camel.component.netty.http.JAASSecurityAuthenticator</code> is used by default.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>loginDeniedLoggingLevel</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>DEBUG</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Logging level used when a login attempt failed, which allows to see more details why the login failed.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>roleClassName</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluen
ceTd"><p>To specify FQN class names of <code>Principal</code> implementations that contains user roles. If none has been specified, then the <a shape="rect" href="netty-http.html">Netty HTTP</a> component will by default assume a <code>Principal</code> is role based if its FQN classname has the lower-case word <code>role</code> in its classname. You can specify multiple class names separated by comma.</p></td></tr></tbody></table></div></div><h3 id="NettyHTTP-MessageHeaders">Message Headers</h3><p>The following headers can be used on the producer to control the HTTP request.</p><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>CamelHttpMethod</code></p></td><td colspan=
"1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allow to control what HTTP method to use such as GET, POST, TRACE etc. The type can also be a <code>org.jboss.netty.handler.codec.http.HttpMethod</code> instance.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpQuery</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Allows to provide URI query parameters as a <code>String</code> value that overrides the endpoint configuration. Separate multiple parameters using the & sign. For example: <code>foo=bar&beer=yes</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpPath</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13.1/2.12.4:<
/strong> Allows to provide URI context-path and query parameters as a <code>String</code> value that overrides the endpoint configuration. This allows to reuse the same producer for calling same remote http server, but using a dynamic context-path and query parameters.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Content-Type</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To set the content-type of the HTTP body. For example: <code>text/plain; charset="UTF-8"</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>CamelHttpResponseCode</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>int</code></td><td colspan="1" rowspan="1" class="confluenceTd">Allows to set the HTTP Status code to use. By default 200 is used for success, and 500 for failure.</td></tr></tbody></table></div></div><p>The following headers is provid
ed as meta-data when a route starts from an <a shape="rect" href="netty-http.html">Netty HTTP</a> endpoint:</p><p>The description in the table takes offset in a route having: <code>from("netty-http:http:0.0.0.0:8080/myapp")...</code></p><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>CamelHttpMethod</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP method used, such as GET, POST, TRACE etc.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpUrl</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></
p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The URL including protocol, host and port, etc:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[http://0.0.0.0:8080/myapp]]></script>
</div></div></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>CamelHttpUri</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The URI without protocol, host and port, etc:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[/myapp]]></script>
Modified: websites/production/camel/content/netty.html
==============================================================================
--- websites/production/camel/content/netty.html (original)
+++ websites/production/camel/content/netty.html Fri Apr 1 07:20:57 2016
@@ -86,7 +86,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Netty-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><p> </p><div class="confluence-information-macro confluence-information-macro-tip"><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>There is a <a shape="rect" href="netty4.html">Netty4</a> component that is using the newer Netty 4 which is recommend to use as this component is using the older Netty 3 library.</p></div></div><p>The <strong>netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" rel="nofollow">Netty</a> project.<br clear="none"> Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programm
ing such as TCP and UDP socket server.</p><p>This camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
+<div class="wiki-content maincontent"><h2 id="Netty-NettyComponent">Netty Component</h2><p><strong>Available as of Camel 2.3</strong></p><div class="confluence-information-macro confluence-information-macro-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. You should use <a shape="rect" href="netty4.html">Netty4</a>.</p></div></div><p>The <strong style="line-height: 1.42857;">netty</strong> component in Camel is a socket communication component, based on the <a shape="rect" class="external-link" href="http://netty.io/" style="line-height: 1.42857;" rel="nofollow">Netty</a> project.</p><p>Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients.<br clear="none"> Netty greatly simplifies and streamlines network programming such as TCP and UDP socket server.</p><p>This
camel component supports both producer and consumer endpoints.</p><p>The Netty component has several options and allows fine-grained control of a number of TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates both In-Only and In-Out communication on a Camel route.</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">
<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-netty</artifactId>