Modified: websites/production/camel/content/jetty.html
==============================================================================
--- websites/production/camel/content/jetty.html (original)
+++ websites/production/camel/content/jetty.html Tue Oct 18 16:21:20 2016
@@ -86,7 +86,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2 id="Jetty-JettyComponent">Jetty
Component</h2><p>The <strong>jetty</strong> component provides HTTP-based <a
shape="rect" href="endpoint.html">endpoints</a> for consuming and producing
HTTP requests. That is, the Jetty component behaves as a simple Web server.<br
clear="none"> Jetty can also be used as a http client which mean you can also
use it with Camel as a producer.</p><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="confluence-information-macro-body"><p><span style="color:
rgb(0,0,0);">The </span><code>assert</code><span style="color:
rgb(0,0,0);"> call appears in this example, because the code is part of an
unit test.</span>Jetty 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 th
e 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
Exchange.HTTP_RESPONSE_CODE data multiple times (e.g.: doing multicasting, or
redelivery error handling), 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="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><h2 id="Jetty-JettyComponent">Jetty
Component</h2><p>The <strong><code>jetty</code></strong> component provides
HTTP-based <a shape="rect" href="endpoint.html">endpoints</a> for consuming and
producing HTTP requests. That is, the Jetty component behaves as a simple Web
server. Jetty can also be used as an HTTP client which mean you can also use it
with Camel as a producer.</p><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="confluence-information-macro-body"><p><span style="color:
rgb(0,0,0);">The </span><strong><code>assert</code></strong><span
style="color: rgb(0,0,0);"> call appears in this example, because the code
is part of an unit test.</span> Jetty 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>.</p><p>If you
find a situation where the message body appears to be empty or you need to
access the <strong><code>Exchange.HTTP_RESPONSE_CODE</code></strong> data
multiple times, e.g., doing multicasting, or redelivery error handling, you
should use <a shape="rect" href="stream-caching.html">Stream caching</a> or
convert the message body to a <strong><code>String</code></strong> which is
safe to be re-read multiple times.</p></div></div><p>Maven users should add the
following dependency to their <strong><code>pom.xml</code></strong> to use 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-jetty</artifactId>
@@ -94,17 +94,18 @@
<!-- use the same version as your Camel core version -->
</dependency>
]]></script>
-</div></div><h3 id="Jetty-URIformat">URI format</h3><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Jetty-URIFormat">URI Format</h3><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[jetty:http://hostname[:port][/resourceUri][?options]
]]></script>
-</div></div><p>You can append query options to the URI in the following
format, <code>?option=value&option=value&...</code></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>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>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>httpClient.XXX</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://wiki.eclipse.org/Jetty/Tutorial/HttpClient"
rel="nofollow">HttpClient</a>. For example, setting
<code>httpClient.idleTimeout=30
000</code> sets the idle timeout to 30 seconds. And
<code>httpClient.timeout=30000</code> sets the request timeout to 30 seconds,
in case you want 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
<code>org.eclipse.jetty.client.HttpClient</code> 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
<code>HttpClient</code> 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 min 8
threads used in Jettys 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
<code>HttpClient</code> 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 16 threads used in Jettys thread
pool.</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="confluenceTd"
><p>Reference to an <code>org.apache.camel.component.http.HttpBinding</code>
>in the <a shape="rect" href="registry.html">Registry</a>.
><code>HttpBinding</code> 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>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
><code>org.apache.camel.component.jetty.JettyHttpBinding</code> in the <a
>shape="rect" href="registry.html">Registry</a>. <code>JettyHttpBinding</code>
>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>false</code></p></td><td
>colspan="1" rowspan="1" class="confluenceTd"><p>Whether o
r not the <code>CamelServlet</code> should try to find a target consumer by
matching the URI prefix if no exact match is found. 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>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
<code>org.mortbay.jetty.Handler</code> instances in your <a shape="rect"
href="registry.html">Registry</a> (such as your Spring
<code>ApplicationContext</code>). These handlers are added to the Jetty servlet
context (for example, to add security). <strong>Important:</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></t
r><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 false Jetty servlet will disable the HTTP streaming and set the
content-length header on the response</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>disableStreamCache</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1"
ro
wspan="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. DefaultHttpBinding
will copy the request input stream into a stream cache and put it into message
body if this option is <code>false</code> 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>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>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 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>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 true , HttpProducer will ignore the Exchange.HTTP_URI header, and use the
endpoint's URI for request. You may also set the
<strong>throwExceptionOnFailure</strong> to be false to let the HttpProducer
send all the fault response back. <br clear="none" class="atl-forced-newline">
<strong>Camel 2.3:</strong> If the option is true, HttpProducer and
CamelServlet will skip the gzip processing if the content-encoding is "gzip".
Also consider setting <strong>disableStreamCache</strong> to true to optimize
when bridging.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><c
ode>enableMultipartFilter</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
<code>org.eclipse.jetty.servlets.MultiPartFilter</code> is enabled or not. You
should set this value to <code>false</code> when bridging endpoints, to ensure
multipart requests is proxied/bridged as well.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>multipartFilterRef</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 multipart filter. Note: setting
<code>multipartFilterRef</code> forces the value of
<code>enableMultipartFilter</code> to <code>true</code>.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><pre>filterInit.xxx</pre></td><td
colspan="1" rowspan="1" class="confluenceTd"><pre
>null</pre></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel
>2.17</strong>: Configuration for the InitParameters of filter. <span> For
>example, setting filterInit</span><code>.parameter=value</code><span> ,
>the parameter could be used when calling the filter init
>method.</span></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>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 millis when us
ing <a shape="rect" href="jetty.html">Jetty</a> as consumer (server). By
default Jetty uses 30000. You can use a value of <code><= 0</code> to never
expire. If a timeout occurs then the request will be expired and Jetty will
return back a http error 503 to the client. 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>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"><p><code>sslContextParametersRef</c
ode></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 <code>org.apache.camel.util.jsse.SSLContextParameters</code> in
the <a shape="rect" href="registry.html">Registry</a>.  This reference
overrides any configured SSLContextParameters at the component level.  See
<a shape="rect" href="#Jetty-UsingtheJSSEConfigurationUtility">Using the JSSE
Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>sslContextParameters</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>null</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> <span> Reference
to a </span><code>org.apache.camel.util.jsse.SSLContextParameters</code><span>
in the </span><a shape="rect" href="registry.html">Registry</a><span>. 
This reference overrides any con
figured SSLContextParameters at the component level.  See </span><a
shape="rect" href="#Jetty-UsingtheJSSEConfigurationUtility">Using the JSSE
Configuration Utility</a><span>.</span></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 Jetty consumer. By default TRACE is turned
off.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>optionsEnabled</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.17:</strong> Specifies whether
to enable HTTP OPTIONS for this Jetty consumer. By default OPTIONS is turned
off.</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
<code>org.apache.camel.spi.HeaderFilterStrategy</code> in the <a shape="rect"
href="registry.html">Registry</a>. It will be used to apply the custom
headerFilterStrategy on the new create HttpJettyEndpoint.</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 only</strong>: Used to only allow consuming if the HttpMethod
matches, such as GET/POST/PUT etc. <span>From </span><strong>Camel
2.15</strong><span> onwards multiple methods can be specified separated by
comma.</span></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
<code>org.apache.camel.component.http.UrlRewrite</code> which allows you to
rewrite urls when you bridge/proxy endpoints. 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 client and server</a>.</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
<code>javax.servlet.ServletResponse</code>.</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:</strong>
<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>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. <strong>NOTE</str
ong> please make sure there is no any other camel-jetty endpoint is 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>sendDateHeader</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.14:</strong> if the option
is true, jetty server will send the date header to the client which sends the
request. <strong>NOTE</strong> please make sure there is no any other
camel-jetty endpoint is 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><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"><strong>Camel 2.15:</strong> if
the option is true, Jetty server will setup the <span style="line-
height: 1.4285715;">CrossOriginFilter 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></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><pre>okStatusCodeRange</pre></td><td
colspan="1" rowspan="1"
class="confluenceTd"><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></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.<br clear="none"> From Camel 2.2, it also uses
(Exchange.HTTP_CHUNKED,CamelHttpChunked) header to turn on or turn off the
chuched encoding on the camel-jetty consumer.</p><p>Camel also populates
<strong>all</strong> request.parameter and request.headers. 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 <code>orderid</code> with the value
123.</p><p>Starting with Camel 2.2.0, you can get the request.parameter from
the message header not only from Get 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 endpoi
nts, is to use the <a shape="rect" href="http.html">HTTP Component</a></p><h3
id="Jetty-ComponentOptions">Component Options</h3><p>The
<code>JettyHttpComponent</code> 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>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>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>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>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>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>minThreads</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 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>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>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><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>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 <code>sslSocketConnectors</code> and therefore 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>
<strong>Consumer only</stron
g>. 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>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
<code>sslSocketConnectorProperties</code> and therefore see section <em>SSL
support</em> for more details.</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 <code>HttpClient</code> with
the jetty producer. This option is removed from Camel 2
.11 onwards, instead you can set the option on the endpoint
instead.</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 <code>HttpClient</code> 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>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 <code>HttpClient</code> 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>httpClientThreadPool</cod
e></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. This option is
removed from Camel 2.11 onwards.</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. 
See  <a shape="rect" href="#Jetty-UsingtheJSSEConfigurationUtility">Using
the JSSE Configuration Utility</a> 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="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 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="con
fluenceTd"><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>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
a 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 a http proxy.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>errorHandler</code></td><td colspan="1" rowspan="1"
class="confluenceTd"><code>null</code></td><td colspan="1" rowspan="1"
class="conflue
nceTd"><strong>Camel 2.15</strong>: This option is used to set the
ErrorHandler that Jetty server uses.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><pre>allowJavaSerializedObject</pre></td><td colspan="1"
rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1"
rowspan="1" class="confluenceTd"><strong>Camel 2.16.1/2.15.5:</strong> Whether
to allow java serialization when a request uses
context-type=application/x-java-serialized-object. This is by default turned
off. If you enable this then be aware that Java will deserialize the incoming
data from the request to Java and that can be a potential security
risk.</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>in Java DSL</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[from("direct:start").to("jetty://http://www.google.com");
+</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>
+</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">
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .to("jetty://http://www.google.com");
]]></script>
-</div></div><p>or in Spring XML</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p><strong>XML DSL</strong>:</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[<route>
<from uri="direct:start"/>
<to uri="jetty://http://www.google.com"/>
@@ -114,7 +115,7 @@
<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
from("jetty:http://localhost:{{port}}/myapp/myservice").process(new
MyBookService());
]]></script>
-</div></div><div class="confluence-information-macro
confluence-information-macro-note"><p class="title">Usage of localhost</p><span
class="aui-icon aui-icon-small aui-iconfont-warning
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When you specify
<code>localhost</code> in a URL, Camel exposes the endpoint only on the local
TCP/IP network interface, so it cannot be accessed from outside the machine it
operates on.</p><p>If you need to expose a Jetty endpoint on a specific network
interface, the numerical IP address of this interface should be used as the
host. If you need to expose a Jetty endpoint on all network interfaces, the
<code>0.0.0.0</code> address should be used.</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>To listen across an entire UR
I prefix, see <a shape="rect"
href="how-do-i-let-jetty-match-wildcards.html">How do I let Jetty match
wildcards</a>.</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>If you actually want to expose
routes by HTTP and already have a Servlet, you should instead refer to the <a
shape="rect"
href="https://cwiki.apache.org/confluence/display/CXF20DOC/Servlet+Transport">Servlet
Transport</a>.</p></div></div><p> </p><p>Our business logic is
implemented in the <code>MyBookService</code> class, which accesses the HTTP
request contents and then returns a response.<br clear="none">
<strong>Note:</strong> The <code>assert</code> call appears in this example,
because the code is part of an unit test.</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><div class="confluence-information-macro
confluence-information-macro-note"><p class="title">Usage of localhost</p><span
class="aui-icon aui-icon-small aui-iconfont-warning
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>When you specify
<strong><code>localhost</code></strong> in a URL, Camel exposes the endpoint
only on the local TCP/IP network interface, so it cannot be accessed from
outside the machine it operates on.</p><p>If you need to expose a Jetty
endpoint on a specific network interface, the numerical IP address of this
interface should be used as the host. If you need to expose a Jetty endpoint on
all network interfaces, the <strong><code>0.0.0.0</code></strong> address
should be used.</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>To listen across an entire URI prefix, see <a shape="rect"
href="how-do-i-let-jetty-match-wildcards.html">How do I let Jetty match
wildcards</a>.</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>If you actually want to expose
routes by HTTP and already have a Servlet, you should instead refer to the <a
shape="rect"
href="https://cwiki.apache.org/confluence/display/CXF20DOC/Servlet+Transport">Servlet
Transport</a>.</p></div></div><p> </p><p>Our business logic is
implemented in the <strong><code>MyBookService</code></strong> class, which
accesses the HTTP request contents and then returns a response.<br
clear="none"> <strong>Note:</strong> The <strong><code>assert</code></strong>
call appears in this example, because the code is part of an unit test.</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[
public class MyBookService implements Processor {
public void process(Exchange exchange) throws Exception {
@@ -133,7 +134,7 @@ public class MyBookService implements Pr
}
}
]]></script>
-</div></div>The following sample shows a content-based route that routes all
requests containing the URI parameter, <code>one</code>, to the endpoint,
<code>mock:one</code>, and all others to <code>mock:other</code>.<div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div>The following sample shows a content-based route that routes all
requests containing the URI parameter, <strong><code>one</code></strong>, to
the endpoint, <strong><code>mock:one</code></strong>, and all others to
<strong><code>mock:other</code></strong>.<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[
from("jetty:" + serverUri)
.choice()
@@ -141,22 +142,22 @@ from("jetty:" + serverUri)
.otherwise()
.to("mock:other");
]]></script>
-</div></div>So if a client sends the HTTP request, <code><a shape="rect"
class="external-link" href="http://serverUri?one=hello"
rel="nofollow">http://serverUri?one=hello</a></code>, the Jetty component will
copy the HTTP request parameter, <code>one</code> to the exchange's
<code>in.header</code>. We can then use the <code>simple</code> language to
route exchanges that contain this header to a specific endpoint and all others
to another. If we used a language more powerful than <a shape="rect"
href="simple.html">Simple</a> (such as <a shape="rect"
href="el.html">EL</a> or <a shape="rect" href="ognl.html">OGNL</a>) we
could also test for the parameter value and do routing based on the header
value as well.<h3 id="Jetty-SessionSupport">Session Support</h3><p>The session
support option, <code>sessionSupport</code>, can be used to enable a
<code>HttpSession</code> object and access the session object while processing
the exchange. For example, the following route enables sess
ions:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div>If a client sends an HTTP request, <code><a shape="rect"
class="external-link" href="http://serverUri?one=hello"
rel="nofollow">http://serverUri?one=hello</a></code>, the Jetty component will
copy the HTTP request parameter, <strong><code>one</code></strong> to the
exchange's <strong><code>in.header</code></strong>. We can then use the
<strong><code>simple</code></strong> language to route exchanges that contain
this header to a specific endpoint and all others to another. If we used a
language more powerful than <a shape="rect" href="simple.html">Simple,</a>
e.g., <a shape="rect" href="el.html">EL</a> or <a shape="rect"
href="ognl.html">OGNL</a>, then we can also test for the parameter value and
route based on the header value as well.<h3 id="Jetty-SessionSupport">Session
Support</h3><p>The session support option,
<strong><code>sessionSupport</code></strong>, can be used to enable a
<strong><code>HttpSession</code></strong> object and access the session object
while pro
cessing the exchange.</p><p>For example, the following route enables
sessions:</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[<route>
<from
uri="jetty:http://0.0.0.0/myapp/myservice/?sessionSupport=true"/>
<processRef ref="myCode"/>
<route>
]]></script>
-</div></div><p>The <code>myCode</code> <a shape="rect"
href="processor.html">Processor</a> can be instantiated by a Spring
<code>bean</code> element:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><p>The <strong><code>myCode</code></strong> <a shape="rect"
href="processor.html">Processor</a> can be instantiated by a Spring
<strong><code>bean</code></strong> element:</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[<bean
id="myCode"class="com.mycompany.MyCodeProcessor"/>
]]></script>
-</div></div><p>Where the processor implementation can access the
<code>HttpSession</code> as follows:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Where the processor implementation can access the
<strong><code>HttpSession</code></strong> 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[public void process(Exchange exchange) throws
Exception {
HttpSession session =
exchange.getIn(HttpMessage.class).getRequest().getSession();
...
}
]]></script>
-</div></div><h3 id="Jetty-SSLSupport(HTTPS)">SSL Support (HTTPS)</h3><h5
id="Jetty-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration
Utility</h5><p>As of Camel 2.8, the Jetty component supports SSL/TLS
configuration through the <a shape="rect"
href="camel-configuration-utilities.html">Camel JSSE Configuration
Utility</a>.  This utility greatly decreases the amount of component
specific code you need to write and is configurable at the endpoint and
component levels.  The following examples demonstrate how to use the
utility with the Jetty component.</p><h6
id="Jetty-Programmaticconfigurationofthecomponent">Programmatic configuration
of the component</h6><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Jetty-SSLSupport(HTTPS)">SSL Support (HTTPS)</h3><h5
id="Jetty-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration
Utility</h5><p>From <strong>Camel 2.8</strong>:
the <strong><code>camel-jetty</code></strong> component supports SSL/TLS
configuration through the <a shape="rect"
href="camel-configuration-utilities.html">Camel JSSE Configuration
Utility</a>.  This utility greatly decreases the amount of component
specific code you need to write and is configurable at the endpoint and
component levels.  The following examples demonstrate how to use the
utility with the Jetty component.</p><h6
id="Jetty-Programmaticconfigurationofthecomponent">Programmatic configuration
of the component</h6><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[KeyStoreParameters ksp = new
KeyStoreParameters();
ksp.setResource("/users/home/server/keystore.jks");
ksp.setPassword("keystorePassword");
@@ -186,10 +187,10 @@ jettyComponent.setSslContextParameters(s
<to
uri="jetty:https://127.0.0.1/mail/?sslContextParametersRef=sslContextParameters"/>
...
]]></script>
-</div></div><h5 id="Jetty-ConfiguringJettyDirectly">Configuring Jetty
Directly</h5><p>Jetty provides SSL support out of the box. To enable Jetty to
run in SSL mode, simply format the URI with the <code>https://</code>
prefix---for example:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
+</div></div><h5 id="Jetty-ConfiguringJettyDirectly">Configuring Jetty
Directly</h5><p>Jetty provides SSL support out of the box. To enable Jetty to
run in SSL mode, simply format the URI using the
<strong><code>https://</code></strong>
prefix.</p><p><strong>Example</strong>:</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[<from
uri="jetty:https://0.0.0.0/myapp/myservice/"/>
]]></script>
-</div></div><p>Jetty also needs to know where to load your keystore from and
what passwords to use in order to load the correct SSL certificate. Set the
following JVM System Properties:</p><p><strong>until Camel
2.2</strong></p><ul><li><code>jetty.ssl.keystore</code> specifies the location
of the Java keystore file, which contains the Jetty server's own X.509
certificate in a <em>key entry</em>. A key entry stores the X.509 certificate
(effectively, the <em>public key</em>) and also its associated private
key.</li><li><code>jetty.ssl.password</code> the store password, which is
required to access the keystore file (this is the same password that is
supplied to the <code>keystore</code> command's <code>-storepass</code>
option).</li><li><code>jetty.ssl.keypassword</code> the key password, which is
used to access the certificate's key entry in the keystore (this is the same
password that is supplied to the <code>keystore</code> command's
<code>-keypass</code> option).</li></ul><p><str
ong>from Camel 2.3
onwards</strong></p><ul><li><code>org.eclipse.jetty.ssl.keystore</code>
specifies the location of the Java keystore file, which contains the Jetty
server's own X.509 certificate in a <em>key entry</em>. A key entry stores the
X.509 certificate (effectively, the <em>public key</em>) and also its
associated private key.</li><li><code>org.eclipse.jetty.ssl.password</code> the
store password, which is required to access the keystore file (this is the same
password that is supplied to the <code>keystore</code> command's
<code>-storepass</code>
option).</li><li><code>org.eclipse.jetty.ssl.keypassword</code> the key
password, which is used to access the certificate's key entry in the keystore
(this is the same password that is supplied to the <code>keystore</code>
command's <code>-keypass</code> option).</li></ul><p>For details of how to
configure SSL on a Jetty endpoint, read the following documentation at the
Jetty Site: <a shape="rect" class="external-link" href="http
://docs.codehaus.org/display/JETTY/How+to+configure+SSL"
rel="nofollow">http://docs.codehaus.org/display/JETTY/How+to+configure+SSL</a></p><p>Some
SSL properties aren't exposed directly by Camel, however Camel does expose the
underlying SslSocketConnector, which will allow you to set properties like
needClientAuth for mutual authentication requiring a client certificate or
wantClientAuth for mutual authentication where a client doesn't need a
certificate but can have one. There's a slight difference between the various
Camel versions:</p><p><strong>Up to Camel 2.2</strong></p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>Jetty also needs to know where to load your keystore from and
what passwords to use in order to load the correct SSL certificate. Set the
following JVM System Properties:</p><p><strong>Before Camel
2.3</strong>:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Property</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>jetty.ssl.keystore</code></td><td colspan="1"
rowspan="1" class="confluenceTd">Specifies the location of the
Java <strong><code>keystore</code></strong> file, which contains the Jetty
server's own <strong><code>X.509</code></strong> certificate in a <em>key
entry</em>. A key entry stores the <strong><code>X.509</code></strong>
certificate (effectively, the <em>public key</em>) and also its associated
private key.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>jetty.ssl.
password</code></td><td colspan="1" rowspan="1" class="confluenceTd">The store
password, which is required to access
the <strong><code>keystore</code></strong> file (this is the same password
that is supplied to the <strong><code>keystore</code></strong> command's
<strong><code>-storepass</code></strong> option).</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><code>jetty.ssl.keypassword</code></td><td
colspan="1" rowspan="1" class="confluenceTd">The key password, which is used to
access the certificate's key entry in
the <strong><code>keystore</code></strong> (this is the same password that
is supplied to the <strong><code>keystore</code></strong> command's
<strong><code>-keypass</code></strong>
option).</td></tr></tbody></table></div><p> </p><p><strong>From Camel
2.3</strong>:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh"> </th><th colspan="1" rowspan="1"
class="confluenceTh">
 </th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>org.eclipse.jetty.ssl.keystore</code></td><td
colspan="1" rowspan="1" class="confluenceTd">Specifies the location of the
Java <strong><code>keystore</code></strong> file, which contains the Jetty
server's own <strong><code>X.509</code></strong> certificate in a <em>key
entry</em>. A key entry stores the <strong><code>X.509</code></strong>
certificate (effectively, the <em>public key</em>) and also its associated
private key.</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><code>org.eclipse.jetty.ssl.password</code></td><td
colspan="1" rowspan="1" class="confluenceTd">The store password, which is
required to access the <strong><code>keystore</code></strong> file (this
is the same password that is supplied to
the <strong><code>keystore</code></strong>
command's <strong><code>keystore</code></strong> option).</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd
"><code>org.eclipse.jetty.ssl.keypassword</code></td><td colspan="1"
rowspan="1" class="confluenceTd">The key password, which is used to access the
certificate's key entry in the <strong><code>keystore</code></strong>
(this is the same password that is supplied to
the <strong><code>keystore</code></strong>
command's <strong><code>keystore</code></strong>
option).</td></tr></tbody></table></div><p>For details of how to configure SSL
on a Jetty endpoint, read the following <a shape="rect" class="external-link"
href="http://www.eclipse.org/jetty/documentation/current/configuring-ssl.html"
rel="nofollow">Jetty documentation</a>.</p><p>Some SSL properties aren't
exposed directly by Camel, however Camel does expose the underlying
<strong><code>SslSocketConnector</code></strong>, which will allow you to set
properties like <strong><code>needClientAuth</code></strong> for mutual
authentication requiring a client certificate
or <strong><code>wantClientAuth</code></st
rong> for mutual authentication where a client doesn't need a certificate but
can have one.</p><p>There's a slight difference between the various Camel
versions:</p><p><strong>Up to Camel 2.2</strong></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[<bean id="jetty"
class="org.apache.camel.component.jetty.JettyHttpComponent">
<property name="sslSocketConnectors">
<map>
@@ -223,7 +224,7 @@ jettyComponent.setSslContextParameters(s
</property>
</bean>
]]></script>
-</div></div><p>*From Camel 2.5 we switch to use SslSelectChannelConnector
*</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+</div></div><p>From <strong>Camel 2.5</strong>: we switch to
use <strong><code>SslSelectChannelConnector *</code></strong></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[<bean id="jetty"
class="org.apache.camel.component.jetty.JettyHttpComponent">
<property name="sslSocketConnectors">
<map>
@@ -240,7 +241,7 @@ jettyComponent.setSslContextParameters(s
</property>
</bean>
]]></script>
-</div></div><p>The value you use as keys in the above map is the port you
configure Jetty to listen on.</p><h4
id="Jetty-ConfiguringgeneralSSLproperties">Configuring general SSL
properties</h4><p><strong>Available as of Camel 2.5</strong></p><p>Instead of a
per port number specific SSL socket connector (as shown above) you can now
configure general properties which applies for all SSL socket connectors (which
is not explicit configured as above with the port number as entry).</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+</div></div><p>The value you use as keys in the above map is the port you
configure Jetty to listen on.</p><h4
id="Jetty-ConfiguringGeneralSSLProperties">Configuring General SSL
Properties</h4><p>From<strong> Camel 2.5</strong>: instead of a per port number
specific SSL socket connector (as shown above) you can now configure general
properties which applies for all SSL socket connectors (which is not explicit
configured as above with the port number as entry).</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[<bean id="jetty"
class="org.apache.camel.component.jetty.JettyHttpComponent">
<property name="sslSocketConnectorProperties">
<map>
[... 114 lines stripped ...]