...
Info | ||
---|---|---|
| ||
Camel |
URI
...
Format
Code Block | ||
---|---|---|
| ||
http4:hostname[:port][/resourceUri][?options] |
...
Default Ports
80
forHTTP
...
443
forHTTPS
.
Specifying Options
Options should be passed on the URI's query string using You can append query options to the URI in the following format, : ?option=value&option=value&...
Info | ||
---|---|---|
| ||
You can only produce to endpoints generated by the HTTP4 the |
HttpComponent
Options
Name | Default Value | Description |
---|---|---|
|
| The maximum number of connections. |
|
| The maximum number of connections per route. |
|
| Camel 2.11.2/2.12.0: To use a custom Note: if |
|
| Reference to a |
|
| To use a custom |
|
| To use a custom |
|
| Camel 2.9.2: To use a custom |
|
| Camel 2.8: To use a custom NoteImportant: Only only one instance of See further below for more details. |
|
| Camel 2.7: You can refer to a different |
|
| Camel 2.11.0: The time for connection to live, the time unit is millisecond, the default value is always keep alive. |
|
| Camel 2.16.1/2.15.5: Whether to allow java serialization when a request uses |
HttpEndpoint
Options
Name | Default Value | Description |
---|---|---|
|
| Option to disable throwing the |
|
| If If Also, if set to true |
|
| Camel 2.11.2/2.12.0: Whether to clear expired cookies before sending the HTTP request. This ensures the cookies store does not keep growing by adding new cookies which is newer removed when they are expired. |
|
| Camel 2.11.2/2.12.0: To use a custom Note: if |
|
|
From Camel 2.17: this options option is now also support supported by the producer to allow using the use of a response stream directly instead of stream caching as by default. |
|
| Camel 2.10.4: Reference to a instance of |
|
| Deprecated and will be removed in Camel 3.0: Reference to a |
|
| To use a custom |
|
|
|
|
| Reference to a |
|
|
|
|
| Camel 2.9.2: To use a custom |
|
| Setting options on the BasicHttpParams. For instance Since From Camel 2.13.0: |
|
| To use a custom |
|
| If enabled If On the producer side the exception will be deserialized and thrown as is, instead of the |
|
|
|
|
| Camel 2.11.1: Reference to a NoteImportant: Only only one instance of See further below for more details. |
|
| Camel 2.7: You can refer to a different |
|
| Camel 2.11: Producer only Refers to a custom For more details at see UrlRewrite and How to use Camel as a HTTP proxy between a client and server. |
|
| Camel 2.14: The maximum number of total connections that the connection manager has. If this option is not set, camel will use the component's setting instead. |
|
| Camel 2.14: The maximum number of connections per route. If this option is not set, camel will use the component's setting instead. |
|
| Camel 2.11.3/2.12.2: If this option is true, |
|
| Camel 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. |
|
| Camel 2.16: If this option is true then |
|
| Camel 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. |
|
| Camel 2.16: If this option is true, The HTTP producer won't read response body and cache the input stream. |
|
| Camel 2.18: If this option is true, The HTTP client will use System Properties to set some parameters of his configuration |
mapHttpMessageBody |
| Camel 2.18: If this option is true then |
|
| Camel 2.18: If this option is true then |
|
| Camel 2.18: If this option is true then |
|
| Camel 2.18: If this option is true, the producer will add a Connection Close header to HTTP Request |
|
| Camel 2.19: Configure a cookie handler to maintain a HTTP session |
Setting Basic Authentication and Proxy
The following authentication options can also be set on the HttpEndpoint
:
Setting Basic Authentication and Proxy
Before Before Camel 2.8.0:
Name | Default Value | Description |
---|---|---|
|
| Username The domain name for authentication. |
|
| Password for The host name authentication. |
|
| The domain name Password for authentication. |
|
| The host name Username for authentication. |
|
| The proxy host name |
|
| The proxy port number |
|
| Username for proxy authentication |
|
| Password for proxy authentication |
|
| The proxy domain name |
|
| The proxy Nt host name |
Since From Camel 2.8.0:
Name | Default Value | Description |
---|---|---|
|
| Username The domain name for authentication |
|
| Password for The host name authentication |
|
| The domain name Password for authentication |
|
| The host name Username for authentication |
|
| The proxy host name |
|
| The proxy port number |
|
| The proxy scheme, will fallback and use the scheme from the endpoint if not configured. |
|
| Username for proxy authentication |
|
| Password for proxy authentication |
|
| The proxy domain name |
|
| The proxy Nt host name |
...
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
|
| The HTTP content encoding. Is set on both the | ||||||
|
| The HTTP content type. Is set on both the | ||||||
|
| Character encodingURI 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. | ||||||
|
| Request URI's path, the . The header will be used to build the request URI with the | ||||||
|
| URI parameters. Will override existing URI parameters set directly on the endpoint. | ||||||
|
| The HTTP response code from the external server. Is | ||||||
|
| The HTTP response text from the external server. | ||||||
|
| Character encoding. |
|
| The HTTP content type. Is set on both the |
|
| The HTTP content encoding. Is set on both the |
Before setting the above, you may wish to read How to avoid sending some or all message headers to prevent inadvertent data "leaks" from your application.
...
Info | ||
---|---|---|
| ||
When setting
|
...
- 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
400+
, Camel regards it as an external server failure and will throw aHttpOperationFailedException
with the information.Tip title throwExceptionOnFailure The option,
throwExceptionOnFailure
, can be set tofalse
to prevent theHttpOperationFailedException
from being IfthrowExceptionOnFailure=false
theHttpOperationFailedException
will not be 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 following algorithm is used to determine whether the GET
or POST
HTTP method should be used: 1.
- Use the method provided in the header.
...
GET
if query string is provided in the 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
Info |
---|
Note: 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); |
...
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.
Java DSL:
Code Block | ||
---|---|---|
| ||
from("direct:start") .to("http4://oldhost"); |
And the equivalent Spring sampleDSL:
Code Block | ||||
---|---|---|---|---|
| ||||
<camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <to uri="http4://oldhost"/> </route> </camelContext> |
You can override the HTTP endpoint URI by adding a header with the key, Exchange.HTTP_URI
, on the message.:
Code Block | ||
---|---|---|
| ||
from("direct:start") .setHeader(Exchange.HTTP_URI, constant("http://newhost")) .to("http4://oldhost"); |
In the sample above Camel will call the the http://newhost
despite the endpoint is configured with http4://oldhost
.
If the the camel-http4
endpoint is working in bridge mode, it will ignore the message header of Exchange.HTTP_URI
.
Configuring URI Parameters
The http The camel-http4
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 Exchange.HTTP_QUERY
on the message.:
Code Block | ||
---|---|---|
| ||
from("direct:start") .to("http4://oldhost?order=123&detail=short"); |
Or options provided in via a header:
Code Block | ||
---|---|---|
| ||
from("direct:start") .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short")) .to("http4://oldhost"); |
...
Info | ||
---|---|---|
| ||
The HTTP |
The HTTP4 component provides a way to set the The camel-http4
specifies the particular HTTP request method by setting the message header. Here is an examplevia a header:
Example:
Code Block | ||
---|---|---|
| ||
from("direct:start") .setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http4.HttpMethods.POST)) .to("http4://www.google.com") .to("mock:results"); |
...
Code Block | ||
---|---|---|
| ||
.setHeader("CamelHttpMethod", constant("POST")) |
And the equivalent Spring exampleDSL:
Code Block | ||||
---|---|---|---|---|
| ||||
<camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <setHeader headerName="CamelHttpMethod"> <constant>POST</constant> </setHeader> <to uri="http4://www.google.com"/> <to uri="mock:results"/> </route> </camelContext> |
...
See the HttpSOTimeoutTest unit test. Since From Camel 2.13.0: See the updated HttpSOTimeoutTest unit test.
Configuring a Proxy
The HTTP4 The camel-http4
component provides a way to configure a proxy.
...
There is also support for proxy authentication via the proxyAuthUsername
and proxyAuthPassword
options.
Using Proxy Settings Outside
...
of the URI
To avoid System properties conflicts, you can set proxy configuration only from the CamelContext
or URI.
Java DSL:
Code Block | ||
---|---|---|
| ||
context.getProperties().put("http.proxyHost", "172.168.18.9"); context.getProperties().put("http.proxyPort" "8080"); |
Spring XMLDSL:
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.Notice
Info |
---|
Note: in Camel 2.8 there is also a http.proxyScheme property you can set to explicit configure the scheme to use. |
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"); |
...
Example: Using a Scheduled Poll
This sample polls the Google homepage every 10 seconds and write the page to the file message.html
:
...
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.
...
You can get the HTTP response code from the HTTP4 the camel-http4
component by getting the value from the Out the OUT
message header with Exchange.HTTP_RESPONSE_CODE
.
...
Using the JSSE Configuration Utility
As of From Camel 2.8, the HTTP4 : the camel-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 the camel-http4
component.
Programmatic Configuration of the Component
...
If you are doing this using the Spring DSL, you can specify your HttpClientConfigurer
using the URI. For example
Example:
Code Block | ||
---|---|---|
| ||
<bean id="myHttpClientConfigurer" class="my.https.HttpClientConfigurer"> </bean> <to uri="https4://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/> |
...
1. Create a (Spring) factory for HttpContexts HttpContext
's:
Code Block | ||
---|---|---|
| ||
public class HttpContextFactory { private String httpHost = "localhost"; private String httpPort = 9001; private BasicHttpContext httpContext = new BasicHttpContext(); private BasicAuthCache authCache = new BasicAuthCache(); private BasicScheme basicAuth = new BasicScheme(); public HttpContext getObject() { authCache.put(new HttpHost(httpHost, httpPort), basicAuth); httpContext.setAttribute(ClientContext.AUTH_CACHE, authCache); return httpContext; } // getter and setter } |
...