Modified: websites/production/camel/content/jetty.html ============================================================================== --- websites/production/camel/content/jetty.html (original) +++ websites/production/camel/content/jetty.html Fri Oct 21 11:21:26 2016 @@ -98,7 +98,7 @@ <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[jetty:http://hostname[:port][/resourceUri][?options] ]]></script> </div></div><p>Query options should be appended to the URI using the following format: <strong><code>?option=value&option=value&...</code></strong></p><h3 id="Jetty-Options">Options</h3><div class="confluenceTableSmall"><div class="table-wrap"> - <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>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><strong>Camel 2.1:</strong> If the option is <strong><code>true</code></strong>, <strong><code>HttpProducer</code></strong> will ignore the <strong><code>Exchange.HTTP_URI</code></strong> header, and use the endpoint's URI for request. You may also set the <strong><code>throwExceptionOnFailure</code></strong> to be false to let the <strong><code>HttpProducer</code></strong> send all the fault response back.</p><p><strong>Camel 2.3:</strong> If the option is true, <strong><code>HttpPr oducer</code></strong> and <strong><code>CamelServlet</code></strong> will skip the gzip processing if the <strong><code>Content-Encoding</code></strong> is <strong><code>gzip</code></strong>.</p><p>Consider setting <strong><code>disableStreamCache=true</code></strong> to optimize when bridging.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>chunked</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> If this option is <strong><code>false</code></strong> Jetty Servlet will disable the HTTP streaming and set the <strong><code>Content-Length</code></strong> header on the response</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>continuationTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p ><strong>Camel 2.6:</strong> Allows to set a timeout in milliseconds when >using <a shape="rect" href="jetty.html">Jetty</a> as consumer (server). By >default Jetty uses <strong><code>30000</code></strong>. You can use a value >of <strong><code><= 0</code></strong> to never expire. If a timeout occurs >then the request will be expired and Jetty will return back an HTTP >error <strong><code>503</code></strong> to the client.</p><p>This option >is only in use when using <a shape="rect" href="jetty.html">Jetty</a> with >the <a shape="rect" href="asynchronous-routing-engine.html">Asynchronous >Routing Engine</a>.</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><strong>Camel 2.3:</strong> Determines >whether or not the raw input stream from Jetty is cached or not (Camel will >read the stream into a in memory/overflow to file, <a shape="rect" href="stream-caching.html">Stream caching</a>) cache. By default Camel will cache the Jetty 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. </p><p><strong><code>DefaultHttpBinding</code></strong> will copy the request input stream into a stream cache and put it into message body if this option is <strong><code>false</code></strong> to support reading the stream multiple times. If you use <a shape="rect" href="jetty.html">Jetty</a> to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code><span>enableCORS</span></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.15:</strong> if the option is true, Jetty server will setup the <span style="line-height: 1.4285715;"><strong><code>CrossOriginFilter</code></strong> which supports the <span><a shape="rect" class="external-link" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS"; rel="nofollow">CORS</a> out of box.</span></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>enableJmx</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.3:</strong> If this option is <strong><code>true</code></strong>, Jetty JMX support will be enabled for this endpoint. See <a shape="rect" href="#Jetty-JettyJMXsupport">Jetty JMX support</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p ><code>enablemulti-partFilter</code></p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><strong>Camel 2.5:</strong> Whether Jetty ><strong><code>org.eclipse.jetty.servlets.multi-partFilter</code></strong> is >enabled or not.</p><p>Set this option to <strong><code>false</code></strong> >when bridging endpoints, to ensure multi-part requests is proxied/bridged as >well.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>filterInit.<em>xxx</em></code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17</strong>: >Configuration for the <strong><code>InitParameters</code></strong> of >filter.</p><p>For example, >setting <strong><code>filterInit.parameter=value</code></strong> ><span>the parameter could be used when calling the >filter <strong><code>init()</code></strong > method.</span></p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><p><code>filtersRef</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9:</strong> > Allows using a custom filters which is putted into a list and can be find in > the <a shape="rect" href="registry.html">Registry</a></p></td></tr><tr><td > colspan="1" rowspan="1" > class="confluenceTd"><p><code>handlers</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p>Specifies a comma-delimited > set of <strong><code>org.mortbay.jetty.Handler</code></strong> instances in > your <a shape="rect" href="registry.html">Registry</a> (such as your Spring > <strong><code>ApplicationContext</code></strong>). These handlers are added > to the Jetty Servlet context (for example, to add > security).</p><p><strong>Note</strong>: you can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.</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><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a instance of <strong><code>org.apache.camel.spi.HeaderFilterStrategy</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. It will be used to apply the custom <strong><code>headerFilterStrategy</code></strong> on the new create <strong><code>HttpJettyEndpoint</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBindingRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="co nfluenceTd"><p>Reference to an <strong><code>org.apache.camel.component.http.HttpBinding</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. <strong><code>HttpBinding</code></strong> can be used to customize how a response should be written for the consumer.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient.<em>xxx</em></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Configuration of Jetty's <a shape="rect" class="external-link" href="http://www.eclipse.org/jetty/documentation/current/http-client-api.html"; rel="nofollow">HttpClient</a>. For example, setting <strong><code>httpClient.idleTimeout=30000</code></strong> sets the idle timeout to <strong><code>30</code></strong> seconds. And <strong><code>httpClient.timeout=30000</code></strong> sets the request timeout to <strong><code>30</code></strong> seconds, in case you w ant to timeout sooner if you have long running request/response calls.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient</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 <strong><code>org.eclipse.jetty.client.HttpClient</code></strong> for all producers created by this endpoint. This option should only be used in special circumstances.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMinThreads</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong>: To set a value for minimum number of threads in <strong><code>HttpClient</code></strong> thread pool. This setting override any setting configured on component level. Notice that both a min and max size must b e configured. If not set it default to min 8 threads used in Jetty's thread pool.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMaxThreads</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong>: To set a value for maximum number of threads in <strong><code>HttpClient</code></strong> thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max <strong><code>16</code></strong> threads used in Jetty's thread pool.</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><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Consumer o nly</strong>: Used to only allow consuming if the <strong><code>HttpMethod</code></strong> matches, such as <strong><code>GET/POST/PUT</code></strong> etc. <span>From </span><strong>Camel 2.15</strong><span>: multiple methods can be specified separated by comma.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>jettyHttpBindingRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6.0+:</strong> Reference to an <strong><code>org.apache.camel.component.jetty.JettyHttpBinding</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. <strong><code>JettyHttpBinding</code></strong> can be used to customize how a response should be written for the producer.</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>fals e</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether or not the <strong><code>CamelServlet</code></strong> should try to find a target consumer by matching the URI prefix if no exact match is found.</p><p>See here <a shape="rect" href="how-do-i-let-jetty-match-wildcards.html">How do I let Jetty match wildcards</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>multi-partFilterRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> Allows using a custom multi-part filter.</p><p><strong>Note</strong>: setting <strong><code>multi-partFilterRef</code></strong> forces the value of <strong><code>enablemulti-partFilter</code></strong> to <strong><code>true</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>okStatusCodeRange</code></p></td><td colspan="1" rowspan="1" class="confl uenceTd"><p><code>200-299</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.16:</strong><span> <strong>Producer only</strong> 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></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>optionsEnabled</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> Specifies whether to enable <strong><code>HTTP OPTIONS</code></strong> for this Jetty consumer. By default <strong><code>OPTIONS</code></strong> is turned off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</s trong> <strong>Producer only</strong> The HTTP proxy Host URL which will be used by Jetty client.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> The HTTP proxy port which will be used by Jetty client.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>responseBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> To use a custom buffer size on the <strong><code>javax.servlet.ServletResponse</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sendDateHeader</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td c olspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong> if the option is true, jetty server will send the date header to the client which sends the request.</p><p><strong>Note</strong>: ensure that there are no any other <strong><code>camel-jetty</code></strong> endpoints that share the same port, otherwise this option may not work as expected.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sendServerVersion</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13:</strong> if the option is true, jetty will send the server header with the jetty version information to the client which sends the request.</p><p><strong>Note</strong>: ensure that there are no any other <strong><code>camel-jetty</code></strong> endpoints that share the same port, otherwise this option may not work as expected.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sessionSupport</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 the session manager on the server side of Jetty.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17:</strong> <span> Reference to a </span><strong><code>org.apache.camel.util.jsse.SSLContextParameters</code></strong><span> in the </span><a shape="rect" href="registry.html">Registry</a><span>.  This reference overrides any configured <strong><code>SSLContextParameters</code></strong> at the component level.  </span><span> </span></p><p><span>See </span><a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configu ration Utility</a><span>.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParametersRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> <strong>Deprecated</strong> Reference to a <strong><code>org.apache.camel.util.jsse.SSLContextParameters</code></strong> in the <a shape="rect" href="registry.html">Registry</a>.  This reference overrides any configured <strong><code>SSLContextParameters</code></strong> at the component level. </p><p>See <a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configuration Utility</a>.</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 <strong><code>HttpOperationFailedException</code></strong> in case of failed responses from the remote server. This allows you to get all responses regardless 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 <strong><code>HTTP TRACE</code></strong> for this Jetty consumer. By default <strong><code>TRACE</code></strong> 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><strong>Camel 2.6:</strong> If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused Exception was se nd back serialized in the response as a <strong><code>application/x-java-serialized-object</code></strong> content type.</p><p>On the producer side the exception will be deserialized and thrown as is, instead of the <strong><code>HttpOperationFailedException</code></strong>. The caused exception is required to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlRewrite</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> Refers to a custom <strong><code>org.apache.camel.component.http.UrlRewrite</code></strong> which allows you to rewrite URLs when you bridge/proxy endpoints.</p><p>See more details at <a shape="rect" href="urlrewrite.html">UrlRewrite</a> and <a shape="rect" href="how-to-use-camel-as-a-http-proxy-between-a-client-and-server.html">How to use Camel as a HTTP proxy between a clien t and server</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>useContinuation</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> Whether or not to use <a shape="rect" class="external-link" href="http://wiki.eclipse.org/Jetty/Feature/Continuations"; rel="nofollow">Jetty continuations</a> for the Jetty Server.</p></td></tr></tbody></table> + <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</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>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><strong>Camel 2.1:</strong> If the option is <strong><code>true</code></strong>, <strong><code>HttpProducer</code></strong> will ignore the <strong><code>Exchange.HTTP_URI</code></strong> header, and use the endpoint's URI for request. You may also set the <strong><code>throwExceptionOnFailure</code></strong> to be false to let the <strong><code>HttpProducer</code></strong> send all the fault response back.</p><p><strong>Camel 2.3:</strong> If the option is true, <strong><code>HttpPr oducer</code></strong> and <strong><code>CamelServlet</code></strong> will skip the gzip processing if the <strong><code>Content-Encoding</code></strong> is <strong><code>gzip</code></strong>.</p><p>Consider setting <strong><code>disableStreamCache=true</code></strong> to optimize when bridging.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>chunked</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.2:</strong> If this option is <strong><code>false</code></strong> Jetty Servlet will disable the HTTP streaming and set the <strong><code>Content-Length</code></strong> header on the response</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>continuationTimeout</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p ><strong>Camel 2.6:</strong> Allows to set a timeout in milliseconds when >using <a shape="rect" href="jetty.html">Jetty</a> as consumer (server). By >default Jetty uses <strong><code>30000</code></strong>. You can use a value >of <strong><code><= 0</code></strong> to never expire. If a timeout occurs >then the request will be expired and Jetty will return back an HTTP >error <strong><code>503</code></strong> to the client.</p><p>This option >is only in use when using <a shape="rect" href="jetty.html">Jetty</a> with >the <a shape="rect" href="asynchronous-routing-engine.html">Asynchronous >Routing Engine</a>.</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><strong>Camel 2.3:</strong> Determines >whether or not the raw input stream from Jetty is cached or not (Camel will >read the stream into a in memory/overflow to file, <a shape="rect" href="stream-caching.html">Stream caching</a>) cache. By default Camel will cache the Jetty 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. </p><p><strong><code>DefaultHttpBinding</code></strong> will copy the request input stream into a stream cache and put it into message body if this option is <strong><code>false</code></strong> to support reading the stream multiple times. If you use <a shape="rect" href="jetty.html">Jetty</a> to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code><span>enableCORS</span></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.15:</strong> if the option is true, Jetty server will setup the <span style="line-height: 1.4285715;"><strong><code>CrossOriginFilter</code></strong> which supports the <span><a shape="rect" class="external-link" href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS"; rel="nofollow">CORS</a> out of box.</span></span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>enableJmx</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.3:</strong> If this option is <strong><code>true</code></strong>, Jetty JMX support will be enabled for this endpoint. See <a shape="rect" href="#Jetty-JettyJMXsupport">Jetty JMX support</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p ><code>enablemulti-partFilter</code></p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" >class="confluenceTd"><p><strong>Camel 2.5:</strong> Whether Jetty ><strong><code>org.eclipse.jetty.servlets.multi-partFilter</code></strong> is >enabled or not.</p><p>Set this option to <strong><code>false</code></strong> >when bridging endpoints, to ensure multi-part requests is proxied/bridged as >well.</p></td></tr><tr><td colspan="1" rowspan="1" >class="confluenceTd"><p><code>filterInit.<em>xxx</em></code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td >colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17</strong>: >Configuration for the <strong><code>InitParameters</code></strong> of >filter.</p><p>For example, >setting <strong><code>filterInit.parameter=value</code></strong> ><span>the parameter could be used when calling the >filter <strong><code>init()</code></strong > method.</span></p></td></tr><tr><td colspan="1" rowspan="1" > class="confluenceTd"><p><code>filtersRef</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9:</strong> > Allows using a custom filters which is putted into a list and can be find in > the <a shape="rect" href="registry.html">Registry</a></p></td></tr><tr><td > colspan="1" rowspan="1" > class="confluenceTd"><p><code>handlers</code></p></td><td colspan="1" > rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td > colspan="1" rowspan="1" class="confluenceTd"><p>Specifies a comma-delimited > set of <strong><code>org.mortbay.jetty.Handler</code></strong> instances in > your <a shape="rect" href="registry.html">Registry</a> (such as your Spring > <strong><code>ApplicationContext</code></strong>). These handlers are added > to the Jetty Servlet context (for example, to add > security).</p><p><strong>Note</strong>: you can not use different handlers with different Jetty endpoints using the same port number. The handlers is associated to the port number. If you need different handlers, then use different port numbers.</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><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> Reference to a instance of <strong><code>org.apache.camel.spi.HeaderFilterStrategy</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. It will be used to apply the custom <strong><code>headerFilterStrategy</code></strong> on the new create <strong><code>HttpJettyEndpoint</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBindingRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="co nfluenceTd"><p>Reference to an <strong><code>org.apache.camel.component.http.HttpBinding</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. <strong><code>HttpBinding</code></strong> can be used to customize how a response should be written for the consumer.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient.<em>xxx</em></code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Configuration of Jetty's <a shape="rect" class="external-link" href="http://www.eclipse.org/jetty/documentation/current/http-client-api.html"; rel="nofollow">HttpClient</a>. For example, setting <strong><code>httpClient.idleTimeout=30000</code></strong> sets the idle timeout to <strong><code>30</code></strong> seconds. And <strong><code>httpClient.timeout=30000</code></strong> sets the request timeout to <strong><code>30</code></strong> seconds, in case you w ant to timeout sooner if you have long running request/response calls.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient</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 <strong><code>org.eclipse.jetty.client.HttpClient</code></strong> for all producers created by this endpoint. This option should only be used in special circumstances.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMinThreads</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong>: To set a value for minimum number of threads in <strong><code>HttpClient</code></strong> thread pool. This setting override any setting configured on component level. Notice that both a min and max size must b e configured. If not set it default to min 8 threads used in Jetty's thread pool.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMaxThreads</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong>: To set a value for maximum number of threads in <strong><code>HttpClient</code></strong> thread pool. This setting override any setting configured on component level. Notice that both a min and max size must be configured. If not set it default to max <strong><code>16</code></strong> threads used in Jetty's thread pool.</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><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Consumer o nly</strong>: Used to only allow consuming if the <strong><code>HttpMethod</code></strong> matches, such as <strong><code>GET/POST/PUT</code></strong> etc. <span>From </span><strong>Camel 2.15</strong><span>: multiple methods can be specified separated by comma.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>jettyHttpBindingRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6.0+:</strong> Reference to an <strong><code>org.apache.camel.component.jetty.JettyHttpBinding</code></strong> in the <a shape="rect" href="registry.html">Registry</a>. <strong><code>JettyHttpBinding</code></strong> can be used to customize how a response should be written for the producer.</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>fals e</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether or not the <strong><code>CamelServlet</code></strong> should try to find a target consumer by matching the URI prefix if no exact match is found.</p><p>See here <a shape="rect" href="how-do-i-let-jetty-match-wildcards.html">How do I let Jetty match wildcards</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>multi-partFilterRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> Allows using a custom multi-part filter.</p><p><strong>Note</strong>: setting <strong><code>multi-partFilterRef</code></strong> forces the value of <strong><code>enablemulti-partFilter</code></strong> to <strong><code>true</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>okStatusCodeRange</code></p></td><td colspan="1" rowspan="1" class="confl uenceTd"><p><code>200-299</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.16:</strong><span> <strong>Producer only</strong> 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></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>optionsEnabled</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> Specifies whether to enable <strong><code>HTTP OPTIONS</code></strong> for this Jetty consumer. By default <strong><code>OPTIONS</code></strong> is turned off.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</s trong> <strong>Producer only</strong> The HTTP proxy Host URL which will be used by Jetty client.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> The HTTP proxy port which will be used by Jetty client.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>responseBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12:</strong> To use a custom buffer size on the <strong><code>javax.servlet.ServletResponse</code></strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sendDateHeader</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td c olspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14:</strong> if the option is true, jetty server will send the date header to the client which sends the request.</p><p><strong>Note</strong>: ensure that there are no any other <strong><code>camel-jetty</code></strong> endpoints that share the same port, otherwise this option may not work as expected.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sendServerVersion</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.13:</strong> if the option is true, jetty will send the server header with the jetty version information to the client which sends the request.</p><p><strong>Note</strong>: ensure that there are no any other <strong><code>camel-jetty</code></strong> endpoints that share the same port, otherwise this option may not work as expected.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sessionSupport</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 the session manager on the server side of Jetty.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.17:</strong> <span> Reference to a </span><strong><code>org.apache.camel.util.jsse.SSLContextParameters</code></strong><span> in the </span><a shape="rect" href="registry.html">Registry</a><span>.  This reference overrides any configured <strong><code>SSLContextParameters</code></strong> at the component level.  </span><span> </span></p><p><span>See </span><a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configu ration Utility</a><span>.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParametersRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> <strong>Deprecated</strong> Reference to a <strong><code>org.apache.camel.util.jsse.SSLContextParameters</code></strong> in the <a shape="rect" href="registry.html">Registry</a>.  This reference overrides any configured <strong><code>SSLContextParameters</code></strong> at the component level. </p><p>See <a shape="rect" href="camel-configuration-utilities.html">Using the JSSE Configuration Utility</a>.</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 <strong><code>HttpOperationFailedException</code></strong> in case of failed responses from the remote server. This allows you to get all responses regardless 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 <strong><code>HTTP TRACE</code></strong> for this Jetty consumer. By default <strong><code>TRACE</code></strong> 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><strong>Camel 2.6:</strong> If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused Exception was se nd back serialized in the response as a <strong><code>application/x-java-serialized-object</code></strong> content type.</p><p>On the producer side the exception will be deserialized and thrown as is, instead of the <strong><code>HttpOperationFailedException</code></strong>. The caused exception is required to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlRewrite</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> Refers to a custom <strong><code>org.apache.camel.component.http.UrlRewrite</code></strong> which allows you to rewrite URLs when you bridge/proxy endpoints.</p><p>See more details at <a shape="rect" href="urlrewrite.html">UrlRewrite</a> and <a shape="rect" href="how-to-use-camel-as-a-http-proxy-between-a-client-and-server.html">How to use Camel as a HTTP proxy between a clien t and server</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>useContinuation</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.6:</strong> Whether or not to use <a shape="rect" class="external-link" href="http://wiki.eclipse.org/Jetty/Feature/Continuations"; rel="nofollow">Jetty continuations</a> for the Jetty Server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>cookieHandler</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.19: Producer only</strong> Configure a cookie handler to maintain a HTTP session</td></tr></tbody></table> </div></div><h3 id="Jetty-MessageHeaders">Message Headers</h3><p>Camel uses the same message headers as the <a shape="rect" href="http.html">HTTP</a> component. From <strong>Camel 2.2</strong>, it also uses (<strong><code>Exchange.HTTP_CHUNKED</code></strong>, <strong><code>CamelHttpChunked</code></strong>) header to toggle chunked encoding on the <strong><code>camel-jetty</code></strong> consumer. Camel also populates <em>all</em> <strong><code>request.parameter</code></strong> and <strong><code>request.headers</code></strong>. For example, given a client request with the URL, <code><a shape="rect" class="external-link" href="http://myserver/myserver?orderid=123"; rel="nofollow">http://myserver/myserver?orderid=123</a></code>, the exchange will contain a header named <strong><code>orderid</code></strong> with the value <strong><code>123</code></strong>.</p><p>From <strong>Camel 2.2.0</strong>: you can get the request.parameter from the message header not only from 0;<strong><code>GET</code></strong> HTTP Method, but also other HTTP method.</p><h3 id="Jetty-Usage">Usage</h3><p>The Jetty component supports both consumer and producer endpoints. Another option for producing to other HTTP endpoints, is to use the <a shape="rect" href="http.html">HTTP Component</a></p><h3 id="Jetty-ComponentOptions">Component Options</h3><p>The <strong><code>JettyHttpComponent</code></strong> provides the following options:</p><div class="confluenceTableSmall"><div class="table-wrap"> <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>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>allowJavaSerializedObject</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.16.1/2.15.5:</strong> Whether to allow java serialization when a request uses <strong><code>context-type=application/x-java-serialized-object</code></strong>.</p><p>When <strong><code>true</code></strong>, be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>enableJmx</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.3:</strong> If this option is true, Jetty JMX support will be enabled for this endpoint. See <a shape="rect" href="#Jetty-JettyJMXsupport">Jetty JMX support</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>errorHandler</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.15</strong>: This option is used to set the <strong><code>ErrorHandler</code></strong> that Jetty server uses.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated:</strong> <strong>Producer only</strong>: To use a custom <strong><code>HttpClient</code></strong> with the jetty producer.</p><p><strong>Note</strong>: from <strong>Camel 2.11</strong> this option has been removed. Set the option on the endpoint instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMaxThreads</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>Producer only</strong>: To set a value for maximum number of threads in <strong><code>HttpClient</code></strong> thread pool. Notice that both a min and max size must be configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientMinThreads</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>Producer only</strong>: To set a value for minimum number of threads in <strong><code>HttpClient</code></strong> thread pool. Notice that both a min and max size must be confi gured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientThreadPool</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated:</strong> <strong>Producer only</strong>: To use a custom thread pool for the client.</p><p><strong>Note</strong>: this option has been removed from <strong>Camel 2.11</strong>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxThreads</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <strong>Consumer only</strong>: To set a value for maximum number of threads in server thread pool. Notice that both a min and max size must be configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>minThreads</code></p></td><td colspan="1" rowspan="1" class="co nfluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <strong>Consumer only</strong>: To set a value for minimum number of threads in server thread pool. Notice that both a min and max size must be configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.2/2.11.3</strong> To use an HTTP proxy.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.12.2/2.11.3:</strong> To use an HTTP proxy.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>socketConnectors</code></p></td><td colspan="1" rowspan="1" class=" confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <strong>Consumer only:</strong> A map which contains per port number specific HTTP connectors. Uses the same principle as <strong><code>sslSocketConnectors</code></strong> and therefore see section <em>SSL support</em> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>socketConnectorProperties</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <strong>Consumer only</strong>. A map which contains general HTTP connector properties. Uses the same principle as <strong><code>sslSocketConnectorProperties</code></strong> and therefore see section <em>SSL support</em> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> To configure a custom SSL/TLS configuration options at the component level. </p><p>See  <a shape="rect" class="external-link" href="http://camel.apache.org/camel-configuration-utilities.html";>Using the JSSE Configuration Utility</a> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslKeyPassword</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>: The password for the keystore when using SSL.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslKeystore</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>: The path to the keystore.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslPassword</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>: The password when using SSL.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslSocketConnectors</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.3</strong> <strong>Consumer only:</strong> A map which contains per port number specific SSL connectors. See section <em>SSL support</em> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslSocketConnectorProperties</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <stron g>Consumer only</strong>. A map which contains general SSL connector properties. See section <em>SSL support</em> for more details.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>requestBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2:</strong> Allows to configure a custom value of the request buffer size on the Jetty connectors.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>requestHeaderSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2:</strong> Allows to configure a custom value of the request header size on the Jetty connectors.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>responseBufferSize</code></p></td><td colspan="1" rowspan="1" class="confluenc eTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2:</strong> Allows to configure a custom value of the response buffer size on the Jetty connectors.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>responseHeaderSize</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2:</strong> Allows to configure a custom value of the response header size on the Jetty connectors.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>threadPool</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.5</strong> <strong>Consumer only</strong>: To use a custom thread pool for the server. This option should only be used in special circumstances.</p></td></tr></tbody></table> </div></div><h3 id="Jetty-ProducerExample">Producer Example</h3><p>The following is a basic example of how to send an HTTP request to an existing HTTP endpoint.</p><p><strong>Java DSL</strong>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
Modified: websites/production/camel/content/netty4-http.html ============================================================================== --- websites/production/camel/content/netty4-http.html (original) +++ websites/production/camel/content/netty4-http.html Fri Oct 21 11:21:26 2016 @@ -97,7 +97,7 @@ <script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[netty4-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><a shape="rect" class="external-link" href="http://netty-httphttp"; rel="nofollow">netty4-http:http//example.com?myParam=myValue&compression=true</a></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 discuss ed example, the HTTP request sent by Netty HTTP producer to the endpoint will look as follows - <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="Netty4HTTP-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 class="confluence-link"><strong>Important:</strong> This component inherits all the options from <a shape="rect" href="netty4.html">Netty4</a>. So make sure t o look at the <a shape="rect" href="netty4.html">Netty4</a> documentation as well.<br clear="none"> Notice that some options from <a shape="rect" href="netty4.html">Netty4</a> is not applicable when using this Netty4 HTTP 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="confluenceTd"><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.netty4.http.NettyHttpMessage</code> message with the method <code>getHttpRequest()</code> that returns the Netty HTTP request <code>io.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. See 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.netty4.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.</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 se rver. 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>Http OperationFailedException</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 be a space character. Notice this option is used by the default <code>org.apache.camel.component.netty4.http.NettyHttpBinding</code> and therefore if you implement a custom <code>org.apache.camel.component.netty4.http.NettyHttpBinding</code> then you would need to decode the headers accordingly to this option. <strong>Notice:</strong> This option is default <code>false</code>.</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 Netty4 HTTP 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 persisten t 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 http 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.netty4.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 colsp an="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 io.netty.handler.codec.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" r owspan="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)," rel="nofollow">http://0.0.0.0:8080/myapp),</a> which is default.</td></tr></tbody></table> + <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="confluenceTd"><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.netty4.http.NettyHttpMessage</code> message with the method <code>getHttpRequest()</code> that returns the Netty HTTP request <code>io.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. See 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.netty4.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.</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 se rver. 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>Http OperationFailedException</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 be a space character. Notice this option is used by the default <code>org.apache.camel.component.netty4.http.NettyHttpBinding</code> and therefore if you implement a custom <code>org.apache.camel.component.netty4.http.NettyHttpBinding</code> then you would need to decode the headers accordingly to this option. <strong>Notice:</strong> This option is default <code>false</code>.</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 Netty4 HTTP 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 persisten t 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 http 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.netty4.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 colsp an="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 io.netty.handler.codec.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" r owspan="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"><code><span class="hl_identifier">useRelativePath</span></code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>false</code></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)," rel="nofollow">http://0.0.0.0:8080/myapp),</a> which is default.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>cookieHandler</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.19: Producer only:</strong> Configure a cookie handler to maintain a HTTP session</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><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 authentication. If none has been configured then the <code>org.apache.camel.component.netty4.http.JAASSecurityAuthenticator</code> is used by default.</p></td></tr><tr><td colspan="1" rowspan="1" class="conflue nceTd"><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 Netty4 HTTP 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="Netty4HTTP-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">
