You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2017/01/25 16:19:49 UTC
svn commit: r1005583 [2/2] - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
jetty.html
Modified: websites/production/camel/content/jetty.html
==============================================================================
--- websites/production/camel/content/jetty.html (original)
+++ websites/production/camel/content/jetty.html Wed Jan 25 16:19:48 2017
@@ -107,8 +107,8 @@
]]></script>
</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"/>
+ <from uri="direct:start"/>
+ <to uri="jetty://http://www.google.com"/>
<route>
]]></script>
</div></div><h3 id="Jetty-ConsumerExample">Consumer Example</h3><p>In this sample we define a route that exposes a HTTP service at <code><a shape="rect" class="external-link" href="http://localhost:8080/myapp/myservice" rel="nofollow">http://localhost:8080/myapp/myservice</a></code>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
@@ -144,8 +144,8 @@ from("jetty:" + serverUri)
]]></script>
</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"/>
+ <from uri="jetty:http://0.0.0.0/myapp/myservice/?sessionSupport=true"/>
+ <processRef ref="myCode"/>
<route>
]]></script>
</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">
@@ -154,7 +154,7 @@ from("jetty:" + serverUri)
</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>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">
@@ -173,112 +173,105 @@ JettyComponent jettyComponent = getConte
jettyComponent.setSslContextParameters(scp);
]]></script>
</div></div><h6 id="Jetty-SpringDSLbasedconfigurationofendpoint">Spring DSL based configuration of endpoint</h6><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[...
- <camel:sslContextParameters
- id="sslContextParameters">
- <camel:keyManagers
- keyPassword="keyPassword">
- <camel:keyStore
- resource="/users/home/server/keystore.jks"
- password="keystorePassword"/>
- </camel:keyManagers>
- </camel:sslContextParameters>...
-...
- <to uri="jetty:https://127.0.0.1/mail/?sslContextParametersRef=sslContextParameters"/>
-...
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<camel:sslContextParameters id="sslContextParameters">
+ <camel:keyManagers keyPassword="keyPassword">
+ <camel:keyStore resource="/users/home/server/keystore.jks" password="keystorePassword"/>
+ </camel:keyManagers>
+</camel:sslContextParameters>
+
+<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 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>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">Property</th><th colspan="1" rowspan="1" class="confluenceTh
">Description</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="confl
uenceTd"><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</c
ode></strong> 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">
+</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="confluenceTableSmall"><div class="table-wrap">
+ <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>jetty.ssl.keystore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>jetty.ssl.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The store password, which is required to access the <strong><code>keystore</code></strong> file (this is the same password that is supplied t
o the <strong><code>keystore</code></strong> command's <strong><code>-storepass</code></strong> option).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>jetty.ssl.keypassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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).</p></td></tr></tbody></table>
+</div></div><p> </p><p><strong>From Camel 2.3</strong>:</p><div class="confluenceTableSmall"><div class="table-wrap">
+ <table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Property</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>org.eclipse.jetty.ssl.keystore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>org.eclipse.jetty.ssl.password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The store password, which is required to access the <strong><code>keystore</code></strong> file (this is the same pas
sword that is supplied to the <strong><code>keystore</code></strong> command's <strong><code>keystore</code></strong> option).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>org.eclipse.jetty.ssl.keypassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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).</p></td></tr></tbody></table>
+</div></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>. 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></strong> 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>
- <entry key="8043">
- <bean class="org.mortbay.jetty.security.SslSocketConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
- </bean>
- </entry>
- </map>
- </property>
-</bean>
-]]></script>
+ <property name="sslSocketConnectors">
+ <map>
+ <entry key="8043">
+ <bean class="org.mortbay.jetty.security.SslSocketConnector">
+ <property name="password"value="..."/>
+ <property name="keyPassword"value="..."/>
+ <property name="keystore"value="..."/>
+ <property name="needClientAuth"value="..."/>
+ <property name="truststore"value="..."/>
+ </bean>
+ </entry>
+ </map>
+ </property>
+</bean>]]></script>
</div></div><p><strong>Camel 2.3, 2.4</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>
- <entry key="8043">
- <bean class="org.eclipse.jetty.server.ssl.SslSocketConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
- </bean>
- </entry>
- </map>
- </property>
-</bean>
-]]></script>
+ <property name="sslSocketConnectors">
+ <map>
+ <entry key="8043">
+ <bean class="org.eclipse.jetty.server.ssl.SslSocketConnector">
+ <property name="password"value="..."/>
+ <property name="keyPassword"value="..."/>
+ <property name="keystore"value="..."/>
+ <property name="needClientAuth"value="..."/>
+ <property name="truststore"value="..."/>
+ </bean>
+ </entry>
+ </map>
+ </property>
+</bean>]]></script>
</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>
- <entry key="8043">
- <bean class="org.eclipse.jetty.server.ssl.SslSelectChannelConnector">
- <property name="password"value="..."/>
- <property name="keyPassword"value="..."/>
- <property name="keystore"value="..."/>
- <property name="needClientAuth"value="..."/>
- <property name="truststore"value="..."/>
- </bean>
- </entry>
- </map>
- </property>
-</bean>
-]]></script>
+ <property name="sslSocketConnectors">
+ <map>
+ <entry key="8043">
+ <bean class="org.eclipse.jetty.server.ssl.SslSelectChannelConnector">
+ <property name="password"value="..."/>
+ <property name="keyPassword"value="..."/>
+ <property name="keystore"value="..."/>
+ <property name="needClientAuth"value="..."/>
+ <property name="truststore"value="..."/>
+ </bean>
+ </entry>
+ </map>
+ </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>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>
- <entry key="password"value="..."/>
- <entry key="keyPassword"value="..."/>
- <entry key="keystore"value="..."/>
- <entry key="needClientAuth"value="..."/>
- <entry key="truststore"value="..."/>
- </map>
- </property>
-</bean>
-]]></script>
+ <property name="sslSocketConnectorProperties">
+ <map>
+ <entry key="password"value="..."/>
+ <entry key="keyPassword"value="..."/>
+ <entry key="keystore"value="..."/>
+ <entry key="needClientAuth"value="..."/>
+ <entry key="truststore"value="..."/>
+ </map>
+ </property>
+</bean>]]></script>
</div></div><h4 id="Jetty-HowtoObtainAReferencetotheX509Certificate">How to Obtain A Reference to the <code>X509Certificate</code></h4><p>Jetty stores a reference to the certificate in the <strong><code>HttpServletRequest</code></strong> which you can access from code 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[HttpServletRequest req = exchange.getIn().getBody(HttpServletRequest.class);
X509Certificate cert = (X509Certificate) req.getAttribute("javax.servlet.request.X509Certificate")
]]></script>
</div></div><h4 id="Jetty-ConfiguringGeneralHTTPProperties">Configuring General HTTP Properties</h4><p>From<strong> Camel 2.5</strong>: instead of a per port number specific HTTP socket connector (as shown above) you can now configure general properties which applies for all HTTP 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="socketConnectorProperties">
- <map>
- <entry key="acceptors" value="4"/>
- <entry key="maxIdleTime" value="300000"/>
- </map>
- </property>
-</bean>
-]]></script>
+ <property name="socketConnectorProperties">
+ <map>
+ <entry key="acceptors" value="4"/>
+ <entry key="maxIdleTime" value="300000"/>
+ </map>
+ </property>
+</bean>]]></script>
</div></div><h4 id="Jetty-HowtoGettheValueofTheX-Forwarded-ForHTTPHeaderUsingHttpServletRequest.getRemoteAddr()">How to Get the Value of The <code>X-Forwarded-For</code> HTTP Header Using <code>HttpServletRequest.getRemoteAddr()</code></h4><p>If the HTTP requests are handled by an Apache server and forwarded to Jetty with <strong><code>mod_proxy</code></strong>, the original client IP address is in the <strong><code>X-Forwarded-For</code></strong> header and the <strong><code>HttpServletRequest.getRemoteAddr()</code></strong> will return the address of the Apache proxy.</p><p>Jetty has a forwarded property which takes the value from <strong><code>X-Forwarded-For</code></strong> and places it in the <strong><code>HttpServletRequest remoteAddr</code></strong> property.  This property is not available directly through the endpoint configuration but it can be easily added using the <strong><code>socketConnectors</code></strong> property:</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="socketConnectors">
- <map>
- <entry key="8080">
- <bean class="org.eclipse.jetty.server.nio.SelectChannelConnector">
- <property name="forwarded" value="true"/>
- </bean>
- </entry>
- </map>
- </property>
+ <property name="socketConnectors">
+ <map>
+ <entry key="8080">
+ <bean class="org.eclipse.jetty.server.nio.SelectChannelConnector">
+ <property name="forwarded" value="true"/>
+ </bean>
+ </entry>
+ </map>
+ </property>
</bean>]]></script>
</div></div><p>This is particularly useful when an existing Apache server handles TLS connections for a domain and proxies them to application servers internally.</p><h3 id="Jetty-DefaultBehaviorforReturningHTTPStatusCodes">Default Behavior for Returning HTTP Status Codes</h3><p>The default behavior of HTTP status codes is defined by the <strong><code>org.apache.camel.component.http.DefaultHttpBinding</code></strong> class, which handles how a response is written and also sets the HTTP status code. If the exchange was processed successfully, the <strong><code>200</code></strong> HTTP status code is returned. If the exchange failed with an exception, the <strong><code>500</code></strong> HTTP status code is returned, and the stacktrace is returned in the body. If you want to specify which HTTP status code to return, set the code in the <strong><code>Exchange.HTTP_RESPONSE_CODE</code></strong> header of the <strong><code>OUT</code></strong> message.</p><h3 id="Jetty-Cus
tomizingHttpBinding">Customizing <code>HttpBinding</code></h3><p>By default, Camel uses the <strong><code>org.apache.camel.component.http.DefaultHttpBinding</code></strong> to handle how a response is written. If you like, you can customize this behavior either by implementing your own <strong><code>HttpBinding</code></strong> class or by extending <strong><code>DefaultHttpBinding</code></strong> and overriding the appropriate methods.</p><p>The following example shows how to customize the <strong><code>DefaultHttpBinding</code></strong> in order to change how exceptions are returned:</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[
@@ -300,59 +293,62 @@ public class MyHttpBinding extends Defau
<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="mybinding"class="com.mycompany.MyHttpBinding"/>
]]></script>
</div></div><p>And then we can reference this binding when we define the route:</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:8080/myapp/myservice?httpBindingRef=mybinding"/><to uri="bean:doSomething"/></route>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<route>
+ <from uri="jetty:http://0.0.0.0:8080/myapp/myservice?httpBindingRef=mybinding"/>
+ <to uri="bean:doSomething"/>
+</route>
]]></script>
</div></div><h3 id="Jetty-JettyHandlersandSecurityConfiguration">Jetty Handlers and Security Configuration</h3><p>You can configure a list of Jetty handlers on the endpoint, which can be useful for enabling advanced Jetty security features. These handlers are configured in Spring XML as follows:</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[<-- Jetty Security handling -->
<bean id="userRealm" class="org.mortbay.jetty.plus.jaas.JAASUserRealm">
- <property name="name" value="tracker-users"/>
- <property name="loginModuleName" value="ldaploginmodule"/>
+ <property name="name" value="tracker-users"/>
+ <property name="loginModuleName" value="ldaploginmodule"/>
</bean>
<bean id="constraint" class="org.mortbay.jetty.security.Constraint">
- <property name="name" value="BASIC"/>
- <property name="roles" value="tracker-users"/>
- <property name="authenticate" value="true"/>
+ <property name="name" value="BASIC"/>
+ <property name="roles" value="tracker-users"/>
+ <property name="authenticate" value="true"/>
</bean>
<bean id="constraintMapping" class="org.mortbay.jetty.security.ConstraintMapping">
- <property name="constraint" ref="constraint"/>
- <property name="pathSpec" value="/*"/>
+ <property name="constraint" ref="constraint"/>
+ <property name="pathSpec" value="/*"/>
</bean>
<bean id="securityHandler" class="org.mortbay.jetty.security.SecurityHandler">
- <property name="userRealm" ref="userRealm"/>
- <property name="constraintMappings" ref="constraintMapping"/>
+ <property name="userRealm" ref="userRealm"/>
+ <property name="constraintMappings" ref="constraintMapping"/>
</bean>
]]></script>
</div></div><p>From<strong> Camel 2.3</strong>: you can configure a list of Jetty handlers as follows:</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[<-- Jetty Security handling -->
<bean id="constraint" class="org.eclipse.jetty.http.security.Constraint">
- <property name="name" value="BASIC"/>
- <property name="roles" value="tracker-users"/>
- <property name="authenticate" value="true"/>
+ <property name="name" value="BASIC"/>
+ <property name="roles" value="tracker-users"/>
+ <property name="authenticate" value="true"/>
</bean>
<bean id="constraintMapping" class="org.eclipse.jetty.security.ConstraintMapping">
- <property name="constraint" ref="constraint"/>
- <property name="pathSpec" value="/*"/>
+ <property name="constraint" ref="constraint"/>
+ <property name="pathSpec" value="/*"/>
</bean>
<bean id="securityHandler" class="org.eclipse.jetty.security.ConstraintSecurityHandler">
- <property name="authenticator">
- <bean class="org.eclipse.jetty.security.authentication.BasicAuthenticator"/>
- </property>
- <property name="constraintMappings">
- <list>
- <ref bean="constraintMapping"/>
- </list>
- </property>
+ <property name="authenticator">
+ <bean class="org.eclipse.jetty.security.authentication.BasicAuthenticator"/>
+ </property>
+ <property name="constraintMappings">
+ <list>
+ <ref bean="constraintMapping"/>
+ </list>
+ </property>
</bean>
]]></script>
</div></div><p>You can then define the endpoint as:</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("jetty:http://0.0.0.0:9080/myservice?handlers=securityHandler")
]]></script>
-</div></div><p>If you need more handlers, set the <strong><code>handlers</code></strong> option equal to a comma-separated list of bean IDs.</p><h3 id="Jetty-HowtoReturnaCustomHTTP500ReplyMessage">How to Return a Custom HTTP 500 Reply Message</h3><p>You may want to return a custom reply message when something goes wrong, instead of the default reply message Camel <a shape="rect" href="jetty.html">Jetty</a> replies with. You could use a custom <strong><code>HttpBinding</code></strong> to be in control of the message mapping, but often it may be easier to use Camel's <a shape="rect" href="exception-clause.html">Exception Clause</a> to construct the custom reply message.</p><p>Example: return the message: <strong><code>Dude something went wrong</code></strong> for the HTTP error code <strong><code>500</code></strong>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><p>If you need more handlers, set the <strong><code>handlers</code></strong> option equal to a comma-separated list of bean IDs.</p><h3 id="Jetty-HowtoCustomizetheResponseonanHTTP500ServerError">How to Customize the Response on an <code>HTTP 500</code> Server Error</h3><p>You may want to return a custom reply message when something goes wrong, instead of the default reply message Camel <a shape="rect" href="jetty.html">Jetty</a> replies with. You could use a custom <strong><code>HttpBinding</code></strong> to be in control of the message mapping, but often it may be easier to use Camel's <a shape="rect" href="exception-clause.html">Exception Clause</a> to construct the custom reply message.</p><p>Example: return the message: <strong><code>Dude something went wrong</code></strong> for the HTTP error code <strong><code>500</code></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("jetty://http://localhost:{{port}}/myserver")
// use onException to catch all exceptions and return a custom reply message
@@ -367,7 +363,51 @@ from("jetty://http://localhost:{{po
// now just force an exception immediately
.throwException(new IllegalArgumentException("I cannot do this"));
]]></script>
-</div></div><h3 id="Jetty-Multi-PartFormsupport">Multi-Part Form support</h3><p>From <strong>Camel 2.3.0</strong>: <strong><code>camel-jetty</code></strong> support to multi-part form post out of box. The submitted form-data are mapped into the message header. <strong><code>camel-jetty</code></strong> creates an attachment for each uploaded file. The file name is mapped to the name of the attachment. The content type is set as the content type of the attachment file name. You can find the example here.</p><div class="error"><span class="error">Error formatting macro: snippet: java.lang.IndexOutOfBoundsException: Index: 20, Size: 20</span> </div><h3 id="Jetty-JettyJMXSupport">Jetty JMX Support</h3><p>From <strong>Camel 2.3.0</strong>: <strong><code>camel-jetty</code></strong> supports the enabling of Jetty's JMX capabilities at the component and endpoint level with the endpoint configuration taking priority.</p><p><strong>Note</strong>: JMX must be enabled within the Camel
context in order to enable JMX support in this component as the component provides Jetty with a reference to the <strong><code>MBeanServer</code></strong> registered with the Camel context.</p><p>As the <strong><code>camel-jetty</code></strong> component caches and reuses Jetty resources for a given protocol/host/port pairing, this configuration option will only be evaluated during the creation of the first endpoint to use a protocol/host/port pairing.</p><p><strong>Example</strong>: given two routes created from the following XML fragments, JMX support would remain enabled for all endpoints listening on: <strong><code>https://0.0.0.0</code></strong>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+</div></div><h3 id="Jetty-Multi-PartFormSupport">Multi-Part Form Support</h3><p>From <strong>Camel 2.3.0</strong>: <strong><code>camel-jetty</code></strong> support to multi-part form post out of box. The submitted form-data are mapped into the message header. <strong><code>camel-jetty</code></strong> creates an attachment for each uploaded file. The file name is mapped to the name of the attachment. The content type is set as the content type of the attachment file name. You can find the example here.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeHeader panelHeader pdl" style="border-bottom-width: 1px;"><b>Note: getName() functions as shown below in versions 2.5 and higher. In earlier versions you receive the temporary file name for the attachment instead</b></div><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[
+// Set the jetty temp directory which store the file for multi
+// part form
+// camel-jetty will clean up the file after it handled the
+// request.
+// The option works rightly from Camel 2.4.0
+getContext().getProperties().put("CamelJettyTempDir", "target");
+
+from("jetty://http://localhost:{{port}}/test").process(new Processor() {
+
+ public void process(Exchange exchange) throws Exception {
+ Message in = exchange.getIn();
+ assertEquals("Get a wrong attachement size", 2, in.getAttachments().size());
+ // The file name is attachment id
+ DataHandler data = in.getAttachment("NOTICE.txt");
+
+ assertNotNull("Should get the DataHandle NOTICE.txt", data);
+ // This assert is wrong, but the correct content-type
+ // (application/octet-stream)
+ // will not be returned until Jetty makes it available -
+ // currently the content-type
+ // returned is just the default for FileDataHandler (for
+ // the implentation being used)
+ // assertEquals("Get a wrong content type",
+ // "text/plain", data.getContentType());
+ assertEquals("Got the wrong name", "NOTICE.txt", data.getName());
+
+ assertTrue("We should get the data from the DataHandle", data.getDataSource()
+ .getInputStream().available() > 0);
+
+ // The other form date can be get from the message
+ // header
+
+ // For binary attachment, header should also be populated by DataHandler but not payload
+ Object header = in.getHeader("NOTICE.txt");
+ assertEquals(DataHandler.class, header.getClass());
+ assertEquals(data, header);
+
+ exchange.getOut().setBody(in.getHeader("comment"));
+ }
+
+});
+]]></script>
+</div></div><h3 id="Jetty-JettyJMXSupport">Jetty JMX Support</h3><p>From <strong>Camel 2.3.0</strong>: <strong><code>camel-jetty</code></strong> supports the enabling of Jetty's JMX capabilities at the component and endpoint level with the endpoint configuration taking priority.</p><p><strong>Note</strong>: JMX must be enabled within the Camel context in order to enable JMX support in this component as the component provides Jetty with a reference to the <strong><code>MBeanServer</code></strong> registered with the Camel context.</p><p>As the <strong><code>camel-jetty</code></strong> component caches and reuses Jetty resources for a given protocol/host/port pairing, this configuration option will only be evaluated during the creation of the first endpoint to use a protocol/host/port pairing.</p><p><strong>Example</strong>: given two routes created from the following XML fragments, JMX support would remain enabled for all endpoints listening on: <strong><code>https://0
.0.0.0</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[<from uri="jetty:https://0.0.0.0/myapp/myservice1/?enableJmx=true"/>
]]></script>
</div></div><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">