...
Maven users will need to add the following dependency to their pom.xml
for this component:
...
URI
...
Format
...
Will by default use port port 80
for HTTP and and 443
for HTTPS.
You can append query options to the URI in the following format, ?option=value&option=value&...
...
title | camel-http vs camel-jetty |
---|
...
You can only
...
produce to endpoints generated by the HTTP component. Therefore it should never be used as input into your camel Routes. To bind/expose an HTTP endpoint via a HTTP server as input to a camel route, you can use the Jetty Component
...
or the Servlet Component
Examples
Call the URL with the body using POST
and return response as the OUT
message. If body is null
call URL using GET
and return response as OUT
message:
Java DSL | Spring DSL |
---|---|
xml |
You can override the HTTP endpoint URI by adding a header. Camel will call the http://newhost. This is very handy for e.g. REST URLs:
Java DSL |
---|
java |
URI parameters can either be set directly on the endpoint URI or as a header:
Java DSL |
---|
java |
Set the HTTP request method to POST
:
Java DSL | Spring DSL |
---|---|
xml |
HttpEndpoint
Options
...
HttpEndpoint Options
Name | Default Value | Description |
---|---|---|
| | Camel 2.0: Option to disable throwing the |
| | Camel 2.1: 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 throwExcpetionOnFailure to be false to let the HttpProducer send all the fault response back. |
| | Camel 2.3: DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support read it twice, otherwise DefaultHttpBinding will set the request input stream direct into the message body. |
| | Reference to a |
| | Camel 2.3: Reference to a |
| | Reference to a |
| | Camel 2.3: Reference to a |
| | Setting options on the HttpClientParams. For instance |
| | Camel 2.3: To use a custom |
The following authentication options can also be set on the HttpEndpoint:
Camel 2.2 or older: Setting Authentication and Proxy
Name | Default Value | Description |
---|---|---|
| | Username for authentication. |
| | Password for authentication. |
| | Camel 2.1: Domain for NTML Authentication. This option must be used to force NTML authentication. |
| | Camel 1.6.2: The proxy host name |
| | Camel 1.6.2: The proxy port number |
| | Camel 1.6.2: Username for proxy authentication |
| | Camel 1.6.2: Password for proxy authentication |
Camel 2.3 or newer: HttpConfiguration - Setting Authentication and Proxy
Name | Default Value | Description |
---|---|---|
| | Authentication method, either as |
| | Priority of authentication methods. Is a list separated with comma. For example: |
| | Username for authentication |
| | Password for authentication |
| | Domain for NTML authentication |
| | Optional host for NTML authentication |
| | The proxy host name |
| | The proxy port number |
| | Authentication method for proxy, either as |
| | Username for proxy authentication |
| | Password for proxy authentication |
| | Domain for proxy NTML authentication |
| | Optional host for proxy NTML authentication |
When using authentication you must provide the choice of method for the authMethod
or authProxyMethod
options.
You can configure the proxy and authentication details on either the HttpComponent
or the HttpEndoint
. Values provided on the HttpEndpoint
will take precedence over HttpComponent
. Its most likely best to configure this on the HttpComponent
which allows you to do this once.
The Http component uses convention over configuration which means that if you have not explicit set a authMethodPriority
then it will fallback and use the select(ed) authMethod
as priority as well. So if you use authMethod.Basic
then the auhtMethodPriority
will be Basic
only.
HttpComponent Options
...
Name
...
Default Value
...
Description
...
httpBinding
...
null
...
Name | Default Value | Description |
---|---|---|
|
| Option to disable throwing the |
|
| If the option is From Camel 2.3: when |
|
| When When From Camel 2.17: this options is now also support by the producer to allow using the response stream directly instead of stream caching as by default. |
|
|
|
|
| From Camel 2.3: reference to a |
|
|
|
|
| From Camel 2.3: reference to a |
|
| Use this to option to configure the underlying HttpClientParams. Example: |
|
| To use a custom |
|
| From Camel 2.6: If enabled and an Exchange failed processing on the consumer side, and if the caused On the producer side the exception will be deserialized and thrown as is, instead of the |
|
| From Camel 2.11: reference to a instance of |
|
| From Camel 2.11: Producer only! Refers to a custom |
...
|
...
httpClientConfigurer
...
null
...
To use a custom org.apache.camel.component.http.HttpClientConfigurer
.
...
httpConnectionManager
...
null
...
To use a custom org.apache.commons.httpclient.HttpConnectionManager
.
...
httpConfiguration
...
null
...
Camel 2.3: To use a custom org.apache.camel.component.http.HttpConfiguration
...
See more details at UrlRewrite and How to use Camel as a HTTP proxy between a client and server. | ||
|
| From Camel 2.15.3/2.16: Consumer only! Whether to eager check whether the HTTP requests has content when This option should be set to |
|
| From Camel 2.16: if this option is true then Setting this to |
|
| From Camel 2.16: the range of HTTP status codes for which a response is considered a success. The values are inclusive. The range must be in the form |
|
| From Camel 2.16: when |
|
| From Camel: 2.19: configure a cookie handler to maintain a HTTP session |
Authentication and Proxy
The following authentication options can also be set on the HttpEndpoint
:
...
Name | Default Value | Description |
---|---|---|
|
| Authentication method, either as |
|
| Priority of authentication methods. Is a list separated with comma. For example: |
|
| Username for authentication. |
|
| Password for authentication. |
|
| Domain for |
|
| Optional host for |
|
| The proxy host name. |
|
| The proxy port number. |
|
| Authentication method for proxy, either as |
|
| Username for proxy authentication. |
|
| Password for proxy authentication. |
|
| Domain for proxy |
|
| Optional host for proxy |
When using authentication you must provide the choice of method for the authMethod
or authProxyMethod
options. You can configure the proxy and authentication details on either the HttpComponent
or the HttpEndoint
. Values provided on the HttpEndpoint
will take precedence over HttpComponent
. Its most likely best to configure this on the HttpComponent
which allows you to do this once.
The HTTP component uses convention over configuration which means that if you have not explicit set a authMethodPriority
then it will fallback and use the select(ed) authMethod
as priority as well. So if you use authMethod.Basic
then the auhtMethodPriority
will be Basic
only.
...
Note: camel-http
is based on HttpClient v3.x and as such has only limited support for what is known as NTLMv1, the early version of the NTLM protocol. It does not support NTLMv2 at all. camel-http4
has support for NTLMv2.
HttpComponent
Options
...
Name | Default Value | Description |
---|---|---|
|
| To use a custom |
|
| To use a custom |
|
| To use a custom |
|
| To use a custom |
|
| Camel 2.16.1/2.15.5: Whether to allow java serialization when a request uses 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. |
HttpConfiguration
contains all the options listed in the table above under the section HttpConfiguration - Setting Authentication and Proxy.
Message Headers
...
Name | Type | Description |
---|---|---|
|
| URI to call. Will override existing URI set directly on the endpoint. This URI is the URI of the HTTP server to call. Its not the same as the Camel endpoint URI, where you can configure endpoint options such as security etc. This header does not support that, its only the URI of the HTTP server. |
|
| HTTP method/verb to use. Can be one of:
|
|
| The request URI's path. The header will be used to build the request URI with the From Camel 2.3.0: if the path starts with a |
|
| URI parameters. Will override existing URI parameters set directly on the endpoint. |
|
| The HTTP response code from the external server. Is |
|
| Character encoding. |
|
| The HTTP content type. Is set on both the |
|
| The HTTP content encoding. Is set on both the |
|
| The |
|
| The |
|
| From Camel 2.5: You can set the HTTP protocol version with this header, e.g., |
...
Note: The header names above are constants. For the spring DSL you have to use the value of the constant instead of the name.
Message Body
Camel will store the HTTP response from the external server on the OUT
body. All headers from the IN
message will be copied to the OUT
message, so headers are preserved during routing. Additionally Camel will add the HTTP response headers as well to the OUT
message headers.
Response Code
Camel will handle according to the HTTP response code:
- Response code is in the range
100..299
, Camel regards it as a success response. - Response code is in the range
300..399
, Camel regards it as a redirection response and will throw aHttpOperationFailedException
with the information. Response code is
throwExceptionOnFailure400+
, Camel regards it as an external server failure and will throw aHttpOperationFailedException
with the information.The option,
throwExceptionOnFailure
, can be set tofalse
to prevent theHttpOperationFailedException
from being thrown for failed response codes. This allows you to get any response from the remote server.
There is a sample below demonstrating this.
HttpOperationFailedException
This exception contains the following information:
- The HTTP status code.
- The HTTP status line (text of the status code).
- Redirect location, if server returned a redirect.
- Response body as a
java.lang.String
, if server provided a body as response.
Calling Using GET
or POST
The following algorithm is used to determine if either GET
or POST
HTTP method should be used:
- Use method provided in header.
GET
if query string is provided in header.GET
if endpoint is configured with a query string.POST
if there is data to send (body is not null).GET
otherwise.
How To Access The HttpServletRequest
and HttpServletResponse
You can get access to these two using the Camel type converter system using:
...
Using Client Timeout - SO_TIMEOUT
See the unit test in this link
More Examples
Configuring a Proxy
Java DSL |
---|
There is also support for proxy authentication via the proxyUsername
and proxyPassword
options.
Using Proxy Settings Outside of the URI
Java DSL | Spring DSL |
---|---|
Options on Endpoint
will override options on the context.
Configuring charset
If you are using POST
to send data you can configure the charset
:
...
Sample with Scheduled Poll
The sample polls the Google homepage every 10 seconds and write the page to the file message.html
:
...
Getting the Response Code
You can get the HTTP response code from the HTTP component by getting the value from the OUT
message header with Exchange.HTTP_RESPONSE_CODE
:
...
Using throwExceptionOnFailure=false
To Obtain All Server Responses
In the route below we want to route a message that we enrich with data returned from a remote HTTP call. As we want all responses from the remote server, we set the throwExceptionOnFailure=false
so we get any response in the AggregationStrategy
. As the code is based on a unit test that simulates a HTTP status code 404, there is some assertion code etc.
Disabling Cookies
To disable cookies you can set the HTTP Client to ignore cookies by adding this URI option: httpClient.cookiePolicy=ignoreCookies
Advanced Usage
If you need more control over the HTTP producer you should use the HttpComponent
where you can set various classes to give you custom behavior.
Setting MaxConnectionsPerHost
The HTTP Component has a org.apache.commons.httpclient.HttpConnectionManager
where you can configure various global configuration for the given component. By global, we mean that any endpoint the component creates has the same shared HttpConnectionManager
. So, if we want to set a different value for the max connection per host, we need to define it on the HTTP component and not on the endpoint URI that we usually use. So here comes:
First, we define the http
component in Spring XML. Yes, we use the same scheme name, http
, because otherwise Camel will auto-discover and create the component with default settings. What we need is to overrule this so we can set our options. In the sample below we set the max connection to 5 instead of the default of 2.
Using Pre-Emptive Authentication
If an HTTP server should fail to respond correctly with an expected 401 Authorization Required
response for a failed authentication attempt a client can instead use preemptive authentication by specifying the URI option: httpClient.authenticationPreemptive=true
.
Accepting Self-Signed Certificates From Remote Server
See this link from a mailing list discussion with some code to outline how to do this with the Apache Commons HTTP API.
Setting up SSL for HTTP Client
Using the JSSE Configuration Utility
From Camel 2.8: the HTTP4
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 HTTP4
component.
The version of the Apache HTTP client used in this component resolves SSL/TLS information from a global "protocol" registry. This component provides an implementation, org.apache.camel.component.http.SSLContextParametersSecureProtocolSocketFactory
, of the HTTP client's protocol socket factory in order to support the use of the Camel JSSE Configuration utility. The following example demonstrates how to configure the protocol registry and use the registered protocol information in a route.
...
Configuring Apache HTTP Client Directly
Basically
HttpConfiguration
contains all the options listed in the table above under the section HttpConfiguration - Setting Authentication and Proxy.
Message Headers
Camel 1.x
Name | Type | Description |
---|---|---|
| | Camel 1.6.0: URI to call. Will override existing URI set directly on the endpoint. Is set on the In message. |
| | The HTTP response code from the external server. Is 200 for OK. Is set on the Out message. |
| | URI parameters. Will override existing URI parameters set directly on the endpoint. Is set on the In message. |
Camel 2.x
Name | Type | Description |
---|---|---|
| | URI to call. Will override existing URI set directly on the endpoint. |
| | Request URI's path, the header will be used to build the request URI with the HTTP_URI. Camel 2.3.0: If the path is start with "/", http producer will try to find the relative path based on the Exchange.HTTP_BASE_URI header or the exchange.getFromEndpoint().getEndpointUri(); |
| | URI parameters. Will override existing URI parameters set directly on the endpoint. |
| | The HTTP response code from the external server. Is 200 for OK. |
| | Character encoding. |
| | The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as |
| | The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as |
| | Camel 2.3: The |
| | Camel 2.3: The |
Message Body
Camel will store the HTTP response from the external server on the OUT body. All headers from the IN message will be copied to the OUT message, so headers are preserved during routing. Additionally Camel will add the HTTP response headers as well to the OUT message headers.
Response code
Camel will handle according to the HTTP response code:
- Response code is in the range 100..299, Camel regards it as a success response.
- Response code is in the range 300..399, Camel regards it as a redirection response and will throw a
HttpOperationFailedException
with the information. - Response code is 400+, Camel regards it as an external server failure and will throw a
HttpOperationFailedException
with the information.Tip title throwExceptionOnFailure The option,
throwExceptionOnFailure
, can be set tofalse
to prevent theHttpOperationFailedException
from being thrown for failed response codes. This allows you to get any response from the remote server.
There is a sample below demonstrating this.
HttpOperationFailedException
This exception contains the following information:
- The HTTP status code
- The HTTP status line (text of the status code)
- Redirect location, if server returned a redirect
- Response body as a
java.io.InputStream
, if server provided a body as response
Calling using GET or POST
In Camel 1.5 the following algorithm is used to determine if either GET
or POST
HTTP method should be used:
1. Use method provided in header.
2. GET
if query string is provided in header.
3. GET
if endpoint is configured with a query string.
4. POST
if there is data to send (body is not null).
5. GET
otherwise.
How to get access to HttpServletRequest and HttpServletResponse
Available as of Camel 2.0
You can get access to these two using the Camel type converter system using
NOTE from Camel 2.3.0 you can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint.
Code Block |
---|
HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class);
HttpServletRequest response = exchange.getIn().getBody(HttpServletResponse.class);
|
Configuring URI to call
You can set the HTTP producer's URI directly form the endpoint URI. In the route below, Camel will call out to the external server, oldhost
, using HTTP.
Code Block |
---|
from("direct:start")
.to("http://oldhost");
|
And the equivalent Spring sample:
...
<camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
<route>
<from uri="direct:start"/>
<to uri="http://oldhost"/>
</route>
</camelContext>
In Camel 1.5.1 you can override the HTTP endpoint URI by adding a header with the key, HttpProducer.HTTP_URI
, on the message.
Code Block |
---|
from("direct:start")
.setHeader(org.apache.camel.component.http.HttpProducer.HTTP_URI, constant("http://newhost"))
.to("http://oldhost");
|
In the sample above Camel will call the http://newhost despite the endpoint is configured with http://oldhost.
And the same code in Camel 2.0:
Code Block |
---|
from("direct:start")
.setHeader(HttpConstants.HTTP_URI, constant("http://newhost"))
.to("http://oldhost");
|
Where Constants is the class, org.apache.camel.component.http.Constants
.
Configuring URI Parameters
The http producer supports URI parameters to be sent to the HTTP server. The URI parameters can either be set directly on the endpoint URI or as a header with the key HttpProducer.QUERY
on the message.
Code Block |
---|
from("direct:start")
.to("http://oldhost?order=123&detail=short");
|
Or options provided in a header:
Code Block |
---|
from("direct:start")
.setHeader(HttpConstants.HTTP_QUERY, constant("order=123&detail=short"))
.to("http://oldhost");
|
How to set the http method (GET/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer
The HTTP component provides a way to set the HTTP request method by setting the message header. Here is an example;
Camel 1.x
Code Block |
---|
from("direct:start")
.setHeader(HttpConstants.HTTP_METHOD, constant(org.apache.camel.component.http.HttpMethods.POST))
.to("http://www.google.com")
.to("mock:results");
|
Camel 2.x
Code Block |
---|
from("direct:start")
.setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http.HttpMethods.POST))
.to("http://www.google.com")
.to("mock:results");
|
The method can be written a bit shorter using the string constants:
Code Block |
---|
.setHeader("CamelHttpMethod", constant("POST"))
|
And the equivalent Spring sample:
...
<camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
<route>
<from uri="direct:start"/>
<setHeader headerName="CamelHttpMethod">
<constant>POST</constant>
</setHeader>
<to uri="http://www.google.com"/>
<to uri="mock:results"/>
</route>
</camelContext>
Using client tineout - SO_TIMEOUT
See the unit test in this link
Configuring a Proxy
Only for >= Camel 1.6.2
The HTTP component provides a way to configure a proxy.
Code Block |
---|
from("direct:start")
.to("http://oldhost?proxyHost=www.myproxy.com&proxyPort=80");
|
There is also support for proxy authentication via the proxyUsername
and proxyPassword
options.
Using proxy settings outside of URI
*Only for >= Camel 1.6.2 and < Camel 2.2.0 *
The HTTP component will detect Java System Properties for http.proxyHost
and http.proxyPort
and use them if provided.
See more at SUN http proxy documentation.
To avoid the System properties conflicts, from Camel 2.2.0 you can only set the proxy configure from CameContext or URI.
Java DSL :
Code Block |
---|
context.getProperties().put("http.proxyHost", "172.168.18.9");
context.getProperties().put("http.proxyPort" "8080");
|
Spring XML
Code Block |
---|
<camelContext>
<properties>
<property key="http.proxyHost" value="172.168.18.9"/>
<property key="http.proxyPort" value="8080"/>
</properties>
</camelContext>
|
Camel will first set the settings from Java System or CamelContext Properties and then the endpoint proxy options if provided.
So you can override the system properties with the endpoint options.
Configuring charset
If you are using POST
to send data you can configure the charset
using the Exchange
property:
Code Block |
---|
exchange.setProperty(Exchange.CHARSET_NAME, "iso-8859-1");
|
Sample with scheduled poll
The sample polls the Google homepage every 10 seconds and write the page to the file message.html
:
Code Block |
---|
from("timer://foo?fixedRate=true&delay=0&period=10000")
.to("http://www.google.com")
.setHeader(FileComponent.HEADER_FILE_NAME, "message.html").to("file:target/google");
|
URI Parameters from the endpoint URI
In this sample we have the complete URI endpoint that is just what you would have typed in a web browser. Multiple URI parameters can of course be set using the &
character as separator, just as you would in the web browser. Camel does no tricks here.
...
// we query for Camel at the Google page
template.sendBody("http://www.google.com/search?q=Camel", null);
URI Parameters from the Message
...
Map headers = new HashMap();
headers.put(HttpProducer.QUERY, "q=Camel&lr=lang_en");
// we query for Camel and English language at Google
template.sendBody("http://www.google.com/search", null, headers);
In the header value above notice that it should not be prefixed with ?
and you can separate parameters as usual with the &
char.
Getting the Response Code
You can get the HTTP response code from the HTTP component by getting the value from the Out message header with HttpProducer.HTTP_RESPONSE_CODE
.
...
Exchange exchange = template.send("http://www.google.com/search", new Processor() {
public void process(Exchange exchange) throws Exception {
exchange.getIn().setHeader(HttpProducer.QUERY, constant("hl=en&q=activemq"));
}
});
Message out = exchange.getOut();
int responseCode = out.getHeader(HttpProducer.HTTP_RESPONSE_CODE, Integer.class);
Using throwExceptionOnFailure=false
to get any response back
Available as of Camel 2.0
In the route below we want to route a message that we enrich with data returned from a remote HTTP call. As we want any response from the remote server, we set the throwExceptionOnFailure
option to false
so we get any response in the AggregationStrategy
. As the code is based on a unit test that simulates a HTTP status code 404, there is some assertion code etc.
Wiki Markup |
---|
{snippet:id=e1|lang=java|url=camel/trunk/components/camel-jetty/src/test/java/org/apache/camel/component/jetty/JettySimplifiedHandle404Test.java} |
Disabling Cookies
To disable cookies you can set the HTTP Client to ignore cookies by adding this URI option:
httpClient.cookiePolicy=ignoreCookies
Advanced Usage
If you need more control over the HTTP producer you should use the HttpComponent
where you can set various classes to give you custom behavior.
Setting MaxConnectionsPerHost
The Http Component has a org.apache.commons.httpclient.HttpConnectionManager
where you can configure various global configuration for the given component.
By global, we mean that any endpoint the component creates has the same shared HttpConnectionManager
. So, if we want to set a different value for the max connection per host, we need to define it on the HTTP component and not on the endpoint URI that we usually use. So here comes:
First, we define the http
component in Spring XML. Yes, we use the same scheme name, http
, because otherwise Camel will auto-discover and create the component with default settings. What we need is to overrule this so we can set our options. In the sample below we set the max connection to 5 instead of the default of 2.
Wiki Markup |
---|
{snippet:id=e1|lang=xml|url=camel/tags/camel-2.2.0/tests/camel-itest/src/test/resources/org/apache/camel/itest/http/HttpMaxConnectionPerHostTest-context.xml} |
And then we can just use it as we normally do in our routes:
Wiki Markup |
---|
{snippet:id=e2|lang=xml|url=camel/tags/camel-2.2.0/tests/camel-itest/src/test/resources/org/apache/camel/itest/http/HttpMaxConnectionPerHostTest-context.xml} |
Using HTTPS to authenticate gotchas
An end user reported that he had problem with authenticating with HTTPS. The problem was eventually resolved when he discovered the HTTPS server did not return a HTTP code 401 Authorization Required. The solution was to set the following URI option: httpClient.authenticationPreemptive=true
Accepting self signed certifications from remote server
See this link from a mailing list discussion with some code to outline how to do this with the Apache Commons HTTP API.
Setting up SSL for HTTP Client
Basically camel-http
component is built on the top of Apache HTTP client, and you can implement a custom org.apache.camel.component.http.HttpClientConfigurer
to do some configuration on the http HTTP client if you need full control of it.
However, if you just want to specify the the keystore
and and truststore
you can do this with Apache HTTP HttpClientConfigurer
, for example:
...
And then you need to create a class that implements HttpClientConfigurer
, and registers https HTTPS protocol providing a a keystore
or or truststore
per example above. Then, from your camel route builder Camel RouteBuilder class you can hook it up like so:
...
If you are doing this using the Spring DSL, you can specify your HttpClientConfigurer
using the URI. For example:
...
As long as you implement the the HttpClientConfigurer
and configure your your keystore
and and truststore
as described above, it will work fine.
...
...