Jetty Component
The jetty
component provides HTTP-based endpoints for consuming and producing HTTP requests. That is, the Jetty component behaves as a simple Web server.
Jetty can also be used as a http an HTTP client which mean you can also use it with Camel as a producer.
Info | ||
---|---|---|
| ||
The If you find a situation where the message body appears to be empty or you need to access the the |
Maven users will need to should add the following dependency to their pom.xml
for this component:
Code Block | ||||
---|---|---|---|---|
| ||||
<dependency> <groupId>org.apache.camel</groupId> <artifactId>camel-jetty</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency> |
URI
...
Format
Code Block |
---|
jetty:http://hostname[:port][/resourceUri][?options] |
You can append query options to the URI in the following format, : ?option=value&option=value&...
Options
Div | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
...
Camel uses the same message headers as the HTTP component.
From Camel 2.2, it also uses (Exchange.HTTP_CHUNKED
, CamelHttpChunked
) header to turn on or turn off the chuched toggle chunked encoding on the the camel-jetty
consumer. Camel also populates all request.parameter
and request.headers
. For example, given a client request with the URL, http://myserver/myserver?orderid=123
, the exchange will contain a header named orderid
with the value 123
.
Starting with From Camel 2.2.0, : you can get the request.parameter from the message header not only from Get from GET
HTTP Method, but also other HTTP method.
...
The Jetty component supports both consumer and producer endpoints. Another option for producing to other HTTP endpoints, is to use the HTTP Component
Component Options
The JettyHttpComponent
provides the following options:
Div | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Producer Example
The following is a basic example of how to send an HTTP request to an existing HTTP endpoint.
in Java DSL:
Code Block | ||||
---|---|---|---|---|
| ||||
from("direct:start")
.to("jetty://http://www.google.com");
|
or in Spring XMLXML DSL:
Code Block | ||||
---|---|---|---|---|
| ||||
<route> <from uri="direct:start"/> <to uri="jetty://http://www.google.com"/> <route> |
...
Note | ||
---|---|---|
| ||
When you specify 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 |
Tip |
---|
To listen across an entire URI prefix, see How do I let Jetty match wildcards. |
...
Our business logic is implemented in the MyBookService
class, which accesses the HTTP request contents and then returns a response.
Note: The assert
call appears in this example, because the code is part of an unit test.
Wiki Markup |
---|
{snippet:id=e2|lang=java|url=camel/trunk/components/camel-jetty9/src/test/java/org/apache/camel/component/jetty/JettyRouteTest.java} |
one
, to the endpoint, mock:one
, and all others to mock:other
.Wiki Markup |
---|
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-jetty9/src/test/java/org/apache/camel/component/jetty/JettyContentBasedRouteTest.java} |
http://serverUri?one=hello
, the Jetty component will copy the HTTP request parameter, one
to the exchange's in.header
. We can then use the simple
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 Simple (such as EL or OGNL) we could also test for the parameter value and do routing based on the header value as well....
The session support option, sessionSupport
, can be used to enable a HttpSession
object and access the session object while processing the exchange. For example, the following route enables sessions:
Code Block | ||||
---|---|---|---|---|
| ||||
<route> <from uri="jetty:http://0.0.0.0/myapp/myservice/?sessionSupport=true"/> <processRef ref="myCode"/> <route> |
The myCode
Processor can be instantiated by a Spring bean
element:
Code Block | ||||
---|---|---|---|---|
| ||||
<bean id="myCode"class="com.mycompany.MyCodeProcessor"/> |
Where the processor implementation can access the HttpSession
as follows:
Code Block | ||||
---|---|---|---|---|
| ||||
public void process(Exchange exchange) throws Exception { HttpSession session = exchange.getIn(HttpMessage.class).getRequest().getSession(); ... } |
...
Using the JSSE Configuration Utility
As of From Camel 2.8, the Jetty : the camel-jetty
component supports SSL/TLS configuration through the Camel JSSE Configuration Utility. 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.
Programmatic configuration of the component
Code Block | ||
---|---|---|
| ||
KeyStoreParameters ksp = new KeyStoreParameters(); ksp.setResource("/users/home/server/keystore.jks"); ksp.setPassword("keystorePassword"); KeyManagersParameters kmp = new KeyManagersParameters(); kmp.setKeyStore(ksp); kmp.setKeyPassword("keyPassword"); SSLContextParameters scp = new SSLContextParameters(); scp.setKeyManagers(kmp); JettyComponent jettyComponent = getContext().getComponent("jetty", JettyComponent.class); jettyComponent.setSslContextParameters(scp); |
...
Jetty provides SSL support out of the box. To enable Jetty to run in SSL mode, simply format the URI with using the https://
prefix---for example.
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
<from uri="jetty:https://0.0.0.0/myapp/myservice/"/> |
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:
until Before Camel 2.23:
Property | Description |
---|---|
jetty.ssl.keystore |
...
Specifies the location of the |
...
Java keystore file, which contains the Jetty server's |
...
own X.509 certificate in a key entry. A key entry stores |
...
the X.509 certificate (effectively, the public key) and also its associated private key. |
jetty.ssl.password |
...
The store password, which is required to access |
...
the keystore file (this is the same password that is supplied to the keystore command's -storepass option). |
jetty.ssl.keypassword |
...
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 keystore command's -keypass option). |
from From Camel 2.3 onwards:
org.eclipse.jetty.ssl.keystore |
...
Specifies the location of the |
...
Java keystore file, which contains the Jetty server's |
...
own X.509 certificate in a key entry. A key entry stores |
...
the X.509 certificate (effectively, the public key) and also its associated private key. |
org.eclipse.jetty.ssl.password |
...
The store password, which is required to access |
...
the keystore file (this is the same password that is supplied to |
...
the keystore command' |
...
s keystore option). |
org.eclipse.jetty.ssl.keypassword |
...
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 keystore command' |
...
s keystore option). |
For details of how to configure SSL on a Jetty endpoint, read the following documentation at the Jetty Site: http://docs.codehaus.org/display/JETTY/How+to+configure+SSL Jetty documentation.
Some SSL properties aren't exposed directly by Camel, however Camel does expose the underlying SslSocketConnector
, which will allow you to set properties like like needClientAuth
for mutual authentication requiring a client certificate or 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:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
*From Camel 2.5: we switch to use use SslSelectChannelConnector *
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
The value you use as keys in the above map is the port you configure Jetty to listen on.
Configuring
...
General SSL
...
Properties
Available as of From Camel 2.5Instead : 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).
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
How to
...
Obtain A Reference to the X509Certificate
Jetty stores a reference to the certificate in the the HttpServletRequest
which you can access from code as follows:
Code Block | ||
---|---|---|
| ||
HttpServletRequest req = exchange.getIn().getBody(HttpServletRequest.class); X509Certificate cert = (X509Certificate) req.getAttribute("javax.servlet.request.X509Certificate") |
Configuring
...
General HTTP
...
Properties
Available as of From Camel 2.5Instead : 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).
Code Block | ||||
---|---|---|---|---|
| ||||
<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> |
Obtaining X-Forwarded-For
...
Header With HttpServletRequest.getRemoteAddr()
If the HTTP requests are handled by an Apache server and forwarded to jetty with mod_proxy
, the original client IP address is in the the X-Forwarded-For
header and the the HttpServletRequest.getRemoteAddr()
will return the address of the Apache proxy.
Jetty has a forwarded property which takes the value from from X-Forwarded-For
and places it in the the HttpServletRequest remoteAddr
property. This property is not available directly through the endpoint configuration but it can be easily added using the the socketConnectors
property:
Code Block | ||
---|---|---|
| ||
<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> </bean> |
This is particularly useful when an existing Apache server handles TLS connections for a domain and proxies them to application servers internally.
Default
...
Behavior for
...
Returning HTTP
...
Status Codes
The default behavior of HTTP status codes is defined by the org.apache.camel.component.http.DefaultHttpBinding
class, which handles how a response is written and also sets the HTTP status code.
If the exchange was processed successfully, the the 200
HTTP status code is returned.
If the exchange failed with an exception, the the 500
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 Exchange.HTTP_RESPONSE_CODE
header of the the OUT
message.
Customizing Customizing HttpBinding
By default, Camel uses the org.apache.camel.component.http.DefaultHttpBinding
to handle how a response is written. If you like, you can customize this behavior either by implementing your own HttpBinding
class or by extending DefaultHttpBinding
and overriding the appropriate methods.
The following example shows how to customize the DefaultHttpBinding
in order to change how exceptions are returned:
Wiki Markup |
---|
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-jetty9/src/test/java/org/apache/camel/component/jetty/HttpBindingRefTest.java} |
...
Code Block | ||||
---|---|---|---|---|
| ||||
<route><from uri="jetty:http://0.0.0.0:8080/myapp/myservice?httpBindingRef=mybinding"/><to uri="bean:doSomething"/></route> |
Jetty
...
Handlers and
...
Security Configuration
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:
Code Block | ||||
---|---|---|---|---|
| ||||
<-- Jetty Security handling --> <bean id="userRealm" class="org.mortbay.jetty.plus.jaas.JAASUserRealm"> <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"/> </bean> <bean id="constraintMapping" class="org.mortbay.jetty.security.ConstraintMapping"> <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"/> </bean> |
And from From Camel 2.3 onwards: you can configure a list of Jetty handlers as follows:
...
You can then define the endpoint as:
Code Block | ||
---|---|---|
| ||
from("jetty:http://0.0.0.0:9080/myservice?handlers=securityHandler") |
If you need more handlers, set the handlers
option equal to a comma-separated list of bean IDs.
How to
...
Return a
...
Custom HTTP 500
...
Reply Message
You may want to return a custom reply message when something goes wrong, instead of the default reply message Camel Jetty replies with.
You could use a custom HttpBinding
to be in control of the message mapping, but often it may be easier to use Camel's Exception Clause to construct the custom reply message. For example as show here, where we return
Example: return the message: Dude something went wrong
with for the HTTP error code 500
:
Wiki Markup |
---|
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-jetty9/src/test/java/org/apache/camel/component/jetty/JettyOnExceptionHandledTest.java} |
Multi-
...
Part Form support
From Camel 2.3.0, : camel-jetty
support to multipart multi-part form post out of box. The submitted form-data are mapped into the message header. Camel camel-jetty
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.
Wiki Markup |
---|
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-jetty9/src/test/java/org/apache/camel/component/jetty/MultiPartFormTestmulti-partFormTest.java|title=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} |
Jetty JMX
...
Support
From Camel 2.3.0, : camel-jetty
supports the enabling of Jetty's JMX capabilities at the component and endpoint level with the endpoint configuration taking priority. Note that 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 the MBeanServer
registered with the Camel context. Because the the camel-jetty
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. For example, given two routes created from the following XML fragments, JMX support would remain enabled for all endpoints listening on ": https://0.0.0.0
".
Code Block | ||||
---|---|---|---|---|
| ||||
<from uri="jetty:https://0.0.0.0/myapp/myservice1/?enableJmx=true"/> |
Code Block | ||||
---|---|---|---|---|
| ||||
<from uri="jetty:https://0.0.0.0/myapp/myservice2/?enableJmx=false"/> |
The The camel-jetty
component also provides for direct configuration of the Jetty MBeanContainer
. Jetty creates MBean names dynamically. If you are running another instance of Jetty outside of the Camel context and sharing the same MBeanServer same MBeanContainer
between the instances, you can provide both instances with a reference to the same same MBeanContainer
in order to avoid name collisions when registering Jetty MBeans.
...