Apache Camel: HTTP
HTTP ComponentThe http: component provides HTTP based
for consuming external HTTP resources (as a client to call external servers using HTTP).Maven users will need to add the following dependency to their pom.xml for this component:
URI format
Will by default use port 80 for HTTP and 443 for HTTPS.ExamplesCall the url with the body using POST and return response as out message. If body is null call URL using GET and return response as out messageJava DSLSpring DSL
You can override the HTTP endpoint URI by adding a header. Camel will call the . This is very handy for e.g. REST urls.Java DSL
URI parameters can either be set directly on the endpoint URI or as a headerJava DSL
Set the HTTP request method to POSTJava DSLSpring DSL
HttpEndpoint Options
NameDefault ValueDescriptionthrowExceptionOnFailuretrueOption to disable throwing the HttpOperationFailedException in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.bridgeEndpointfalseIf 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 * throwExceptionOnFailure* to be false to let the HttpProducer send all the fault response back.
Camel 2.3: If the option is true, HttpProducer and CamelServlet will skip the gzip processing if the content-encoding is "gzip".disableStreamCachefalseDefaultHttpBinding 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. 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.httpBindingRefnullDeprecated and removed in Camel 2.17: Reference to a org.ponent.http.HttpBinding in the . Use the httpBinding option instead.httpBindingnullCamel 2.3: Reference to a org.ponent.http.HttpBinding in the .httpClientConfigurerRefnullDeprecated and removed in Camel 2.17: Reference to a org.ponent.http.HttpClientConfigurer in the . Use the httpClientConfigurer option instead.httpClientConfigurernullCamel 2.3: Reference to a org.ponent.http.HttpClientConfigurer in the .httpClient.XXXnullSetting options on the . For instance httpClient.soTimeout=5000 will set the SO_TIMEOUT to 5 seconds.clientConnectionManagernullTo use a custom org.apache.http.conn.ClientConnectionManager.transferExceptionfalseCamel 2.6: If enabled and an
failed processing on the consumer side, and if the caused Exception was send back serialized in the response as a application/x-java-serialized-object content type (for example using
Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the HttpOperationFailedException. The caused exception is required to be serialized.headerFilterStrategynullCamel 2.11: Reference to a instance of org.apache.camel.spi.HeaderFilterStrategy in the . It will be used to apply the custom headerFilterStrategy on the new create HttpEndpoint.urlRewritenullCamel 2.11: Producer only Refers to a custom org.ponent.http.UrlRewrite which allows you to rewrite urls when you bridge/proxy endpoints. See more details at
and .eagerCheckContentAvailablefalseCamel 2.15.3/2.16: Consumer only  Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present.  This can be turned on in case HTTP clients do not send streamed data.copyHeaderstrueCamel 2.16:  If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers).okStatusCodeRange200-299Camel 2.16: 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.ignoreResponseBodyfalseCamel 2.16: If this option is true, The http producer won't read response body and cache the input stream.cookieHandlernullCamel: 2.19: Configure a cookie handler to maintain a HTTP session
Authentication and ProxyThe following authentication options can also be set on the HttpEndpoint:
NameDefault ValueDescriptionauthMethodnullAuthentication method, either as Basic, Digest or NTLM.authMethodPrioritynullPriority of authentication methods. Is a list separated with comma. For example: Basic,Digest to exclude NTLM.authUsernamenullUsername for authenticationauthPasswordnullPassword for authenticationauthDomainnullDomain for NTML authenticationauthHostnullOptional host for NTML authenticationproxyHostnullThe proxy host nameproxyPortnullThe proxy port numberproxyAuthMethodnullAuthentication method for proxy, either as Basic, Digest or NTLM.proxyAuthUsernamenullUsername for proxy authenticationproxyAuthPasswordnullPassword for proxy authenticationproxyAuthDomainnullDomain for proxy NTML authenticationproxyAuthHostnullOptional 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
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
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
NameDefault ValueDescriptionhttpBindingnullTo use a custom org.ponent.http.HttpBinding.httpClientConfigurernullTo use a custom org.ponent.http.HttpClientConfigurer.httpConnectionManagernullTo use a custom mons.httpclient.HttpConnectionManager.httpConfigurationnullTo use a custom org.ponent.http.HttpConfigurationallowJavaSerializedObjectfalseCamel 2.16.1/2.15.5: 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.
HttpConfiguration contains all the options listed in the table above under the section HttpConfiguration - Setting Authentication and Proxy.
NameTypeDescriptionExchange.HTTP_URIStringURI 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.Exchange.HTTP_METHODStringHTTP Method / Verb to use (GET/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)Exchange.HTTP_PATHStringRequest 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();Exchange.HTTP_QUERYStringURI parameters. Will override existing URI parameters set directly on the endpoint.Exchange.HTTP_RESPONSE_CODEintThe HTTP response code from the external server. Is 200 for OK.Exchange.HTTP_CHARACTER_ENCODINGStringCharacter encoding.Exchange.CONTENT_TYPEStringThe HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html.Exchange.CONTENT_ENCODINGStringThe HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip.Exchange.HTTP_SERVLET_REQUESTHttpServletRequestThe HttpServletRequest object.Exchange.HTTP_SERVLET_RESPONSEHttpServletResponseThe HttpServletResponse object.Exchange.HTTP_PROTOCOL_VERSIONStringCamel 2.5: You can set the http protocol version with this header, eg. "HTTP/1.0". If you didn't specify the header, HttpProducer will use the default value "HTTP/1.1"
The header name above are constants. For the spring DSL you have to use the value of the constant instead of the name.Message BodyCamel 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 codeCamel 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.HttpOperationFailedExceptionThis exception contains the following information:The HTTP status codeThe HTTP status line (text of the status code)Redirect location, if server returned a redirectResponse body as a java.lang.String, if server provided a body as responseCalling using GET or POSTThe 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 HttpServletResponseYou can get access to these two using the Camel type converter system using
See the unit test in More ExamplesConfiguring a ProxyJava DSL
There is also support for proxy authentication via the proxyUsername and proxyPassword options.Java DSLSpring DSL
Options on Endpoint will override options on the context.Configuring charsetIf you are using POST to send data you can configure the charset
Sample with scheduled pollThe sample polls the Google homepage every 10 seconds and write the page to the file message.html:
Getting the Response CodeYou 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 get any response backIn the route below we want to route a message that we
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.
Disabling CookiesTo disable cookies you can set the HTTP Client to ignore cookies by adding this URI option: httpClient.cookiePolicy=ignoreCookiesAdvanced UsageIf 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 MaxConnectionsPerHostThe
Component has a mons.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.
And then we can just use it as we normally do in our routes:
Using preemptive authenticationAn 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=trueAccepting self signed certificates from remote serverSee this
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 ClientUsing the JSSE Configuration UtilityAs of Camel 2.8, the HTTP4 component supports SSL/TLS configuration through the .  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.ponent.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 DirectlyBasically camel-http component is built on the top of Apache HTTP client, and you can implement a custom org.ponent.http.HttpClientConfigurer to do some configuration on the http client if you need full control of it.However if you just want to specify the keystore 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 protocol providing a keystore or truststore per example above. Then, from your camel route builder 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 HttpClientConfigurer and configure your keystore and truststore as described above, it will work fine.See Also
The Apache Software Foundation.
Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are trademarks of The Apache Software Foundation.
All other marks mentioned may be trademarks or registered trademarks of their respective owners.