Page History

...

Maven users will need to add the following dependency to their pom.xml for this component:

Code Block

	xml
	xml


<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-http4</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

Info

title	camel-http4 vs camel-http

Camel-http4 uses HttpClient 4.x while camel-http uses HttpClient 3.x.

URI format

Code Block

language	java


http4:hostname[:port][/resourceUri][?options]

...

HttpComponent Options

Wiki Markup

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{maxTotalConnections}} | {{200}} | The maximum number of connections. |
| {{connectionsPerRoute}} | {{20}} | The maximum number of connections per route. |
| {{cookieStore}} | {{null}} | *Camel 2.11.2/2.12.0:* To use a custom {{org.apache.http.client.CookieStore}}. By default the {{org.apache.http.impl.client.BasicCookieStore}} is used which is an in-memory only cookie store. Notice if {{bridgeEndpoint=true}} then the cookie store is forced to be a noop cookie store as cookies shouldn't be stored as we are just bridging (eg acting as a proxy). |
| {{httpClientConfigurer}} | {{null}} | Reference to a {{org.apache.camel.component.http.HttpClientConfigurer}} in the [Registry]. |
| {{clientConnectionManager}} | {{null}} | To use a custom {{org.apache.http.conn.ClientConnectionManager}}. |
| {{httpBinding}} | {{null}} | To use a custom {{org.apache.camel.component.http.HttpBinding}}. |
| {{httpContext}} | {{null}} | *Camel 2.9.2:* To use a custom {{org.apache.http.protocol.HttpContext}} when executing requests. |
| {{sslContextParameters}} | {{null}} | *Camel 2.8:* To use a custom {{org.apache.camel.util.jsse.SSLContextParameters}}. See [Using the JSSE Configuration Utility|#Using the JSSE Configuration Utility]. *Important:* Only one instance of {{org.apache.camel.util.jsse.SSLContextParameters}} is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. See further below for more details. |
| {{x509HostnameVerifier}} | {{BrowserCompatHostnameVerifier}} | *Camel 2.7:* You can refer to a different {{org.apache.http.conn.ssl.X509HostnameVerifier}} instance in the [Registry] such as {{org.apache.http.conn.ssl.StrictHostnameVerifier}} or {{org.apache.http.conn.ssl.AllowAllHostnameVerifier}}. |
| {{connectionTimeToLive}} | {{-1}} | *Camel 2.11.0:* The time for connection to live, the time unit is millisecond, the default value is always keep alive. |
| {{authenticationPreemptive}} | {{false}} | *Camel 2.11.3/2.12.2:* If this option is true, camel-http4 sends preemptive basic authentication to the server. |
{div}

HttpEndpoint Options

Wiki Markup

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{throwExceptionOnFailure}} | {{true}} | Option 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. |
| {{bridgeEndpoint}} | {{false}} | If 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 fault responses back. Also if set to true HttpProducer and CamelServlet will skip the gzip processing if the content-encoding is "gzip". |
| {{clearExpiredCookies}} | {{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. |
| {{cookieStore}} | {{null}} | *Camel 2.11.2/2.12.0:* To use a custom {{org.apache.http.client.CookieStore}}. By default the {{org.apache.http.impl.client.BasicCookieStore}} is used which is an in-memory only cookie store. Notice if {{bridgeEndpoint=true}} then the cookie store is forced to be a noop cookie store as cookies shouldn't be stored as we are just bridging (eg acting as a proxy). |
| {{disableStreamCache}} | {{false}} | DefaultHttpBinding will copy the request input stream into a stream cache and put it into the message body if this option is false to support multiple reads, otherwise DefaultHttpBinding will set the request input stream directly in the message body. |
| {{headerFilterStrategy}} | {{null}} | *Camel 2.10.4:* Reference to a instance of {{org.apache.camel.spi.HeaderFilterStrategy}} in the [Registry].&nbsp;It will be used to apply the custom headerFilterStrategy on the new create HttpEndpoint. |
| {{httpBindingRef}} | {{null}} | *Deprecated and will be removed in Camel 3.0:* Reference to a {{org.apache.camel.component.http.HttpBinding}} in the [Registry]. Use the {{httpBinding}} option instead. |
| {{httpBinding}} | {{null}} | To use a custom {{org.apache.camel.component.http.HttpBinding}}. |
| {{httpClientConfigurerRef}} | {{null}} | *Deprecated and will be removed in Camel 3.0:* Reference to a {{org.apache.camel.component.http.HttpClientConfigurer}} in the [Registry]. Use the {{httpClientConfigurer}} option instead. |
| {{httpClientConfigurer}} | {{null}} | Reference to a {{org.apache.camel.component.http.HttpClientConfigurer}} in the [Registry]. |
| {{httpContextRef}} | {{null}} | *Deprecated and will be removed in Camel 3.0:* *Camel 2.9.2:* Reference to a custom {{org.apache.http.protocol.HttpContext}} in the [Registry]. Use the {{httpContext}} option instead. |
| {{httpContext}} | {{null}} | *Camel 2.9.2:* To use a custom {{org.apache.http.protocol.HttpContext}} when executing requests. |
| {{httpClient.XXX}} | {{null}} | Setting options on the [BasicHttpParams|http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/BasicHttpParams.html]. For instance {{httpClient.soTimeout=5000}} will set the {{SO_TIMEOUT}} to 5 seconds. Look on the setter methods of the following parameter beans for a complete reference: [AuthParamBean|http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/auth/params/AuthParamBean.html], [ClientParamBean|http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/client/params/ClientParamBean.html], [ConnConnectionParamBean|http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnConnectionParamBean.html], [ConnRouteParamBean|http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnRouteParamBean.html], [CookieSpecParamBean|http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/cookie/params/CookieSpecParamBean.html], [HttpConnectionParamBean|http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpConnectionParamBean.html] and [HttpProtocolParamBean|http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpProtocolParamBean.html] |
| {{clientConnectionManager}} | {{null}} | To use a custom {{org.apache.http.conn.ClientConnectionManager}}. |
| {{transferException}} | {{false}} | If enabled and an [Exchange] 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 [Jetty] or [Servlet] 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. |
| {{sslContextParametersRef}} | {{null}} | *Deprecated and will be removed in Camel 3.0:* *Camel 2.8:* Reference to a {{org.apache.camel.util.jsse.SSLContextParameters}} in the [Registry].  *Important:* Only one instance of {{org.apache.camel.util.jsse.SSLContextParameters}} is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. See further below for more details. See [Using the JSSE Configuration Utility|#Using the JSSE Configuration Utility]. Use the {{sslContextParameters}} option instead. |
| {{sslContextParameters}} | {{null}} | *Camel 2.11.1:* Reference to a {{org.apache.camel.util.jsse.SSLContextParameters}} in the [Registry].  *Important:* Only one instance of {{org.apache.camel.util.jsse.SSLContextParameters}} is supported per HttpComponent. If you need to use 2 or more different instances, you need to define a new HttpComponent per instance you need. See further below for more details. See [Using the JSSE Configuration Utility|#Using the JSSE Configuration Utility]. |
| {{x509HostnameVerifier}} | {{BrowserCompatHostnameVerifier}} | *Camel 2.7:* You can refer to a different {{org.apache.http.conn.ssl.X509HostnameVerifier}} instance in the [Registry] such as {{org.apache.http.conn.ssl.StrictHostnameVerifier}} or {{org.apache.http.conn.ssl.AllowAllHostnameVerifier}}. |
| {{urlRewrite}} | {{null}} | *Camel 2.11:* *Producer only* Refers to a custom {{org.apache.camel.component.http4.UrlRewrite}} which allows you to rewrite urls when you bridge/proxy endpoints. See more details at [UrlRewrite] and [How to use Camel as a HTTP proxy between a client and server]. |
{div}

The following authentication options can also be set on the HttpEndpoint:

...

Before Camel 2.8.0

Wiki Markup

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{username}} | {{null}} | Username for authentication. |
| {{password}} | {{null}} | Password for authentication. |
| {{domain}} | {{null}} | The domain name for authentication. |
| {{host}} | {{null}} | The host name authentication. |
| {{proxyHost}} | {{null}} | The proxy host name |
| {{proxyPort}} | {{null}} | The proxy port number |
| {{proxyUsername}} | {{null}} | Username for proxy authentication |
| {{proxyPassword}} | {{null}} | Password for proxy authentication |
| {{proxyDomain}} | {{null}} | The proxy domain name |
| {{proxyNtHost}} | {{null}} | The proxy Nt host name |
{div}

Since Camel 2.8.0

Wiki Markup

{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{authUsername}} | {{null}} | Username for authentication |
| {{authPassword}} | {{null}} | Password for authentication |
| {{authDomain}} | {{null}} | The domain name for authentication |
| {{authHost}} | {{null}} | The host name authentication |
| {{proxyAuthHost}} | {{null}} | The proxy host name |
| {{proxyAuthPort}} | {{null}} | The proxy port number |
| {{proxyAuthScheme}} | {{null}} | The proxy scheme, will fallback and use the scheme from the endpoint if not configured. |
| {{proxyAuthUsername}} | {{null}} | Username for proxy authentication |
| {{proxyAuthPassword}} | {{null}} | Password for proxy authentication |
| {{proxyAuthDomain}} | {{null}} | The proxy domain name |
| {{proxyAuthNtHost}} | {{null}} | The proxy Nt host name |
{div}

Message Headers

Wiki Markup

{div:class=confluenceTableSmall}
|| Name || Type || Description ||
| {{Exchange.HTTP_URI}} | {{String}} | URI to call. Will override existing URI set directly on the endpoint. |
| {{Exchange.HTTP_PATH}} | {{String}} | Request URI's path, the header will be used to build the request URI with the HTTP_URI. |
| {{Exchange.HTTP_QUERY}} | {{String}} | URI parameters. Will override existing URI parameters set directly on the endpoint. |
| {{Exchange.HTTP_RESPONSE_CODE}} | {{int}} | The HTTP response code from the external server. Is 200 for OK. |
| {{Exchange.HTTP_CHARACTER_ENCODING}} | {{String}} | Character encoding. |
| {{Exchange.CONTENT_TYPE}} | {{String}} | The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as {{text/html}}. |
| {{Exchange.CONTENT_ENCODING}} | {{String}} | The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as {{gzip}}. |
{div}

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 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 to false to prevent the HttpOperationFailedException 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.

...

You can get access to these two using the Camel type converter system using
NOTE You can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint.

Code Block

language	java


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.

Code Block

language	java


from("direct:start")
	    .to("http4://oldhost");

And the equivalent Spring sample:

Code Block

	xml
	xml


<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

language	java


from("direct:start")
  .setHeader(Exchange.HTTP_URI, constant("http://newhost"))
  .to("http4://oldhost");

...

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 Exchange.HTTP_QUERY on the message.

Code Block

language	java


from("direct:start")
  .to("http4://oldhost?order=123&detail=short");

Or options provided in a header:

Code Block

language	java


from("direct:start")
  .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short"))
  .to("http4://oldhost");

...

The HTTP4 component provides a way to set the HTTP request method by setting the message header. Here is an example:

Code Block

language	java


from("direct:start")
  .setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http4.HttpMethods.POST))
  .to("http4://www.google.com")
  .to("mock:results");

The method can be written a bit shorter using the string constants:

Code Block

language	java


.setHeader("CamelHttpMethod", constant("POST"))

And the equivalent Spring sample:

Code Block

	xml
	xml


<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>

...

The HTTP4 component provides a way to configure a proxy.

Code Block

language	java


from("direct:start")
  .to("http4://oldhost?proxyAuthHost=www.myproxy.com&proxyAuthPort=80");

...

To avoid System properties conflicts, you can set proxy configuration only from the CamelContext or URI.
Java DSL :

Code Block

language	java


 context.getProperties().put("http.proxyHost", "172.168.18.9");
 context.getProperties().put("http.proxyPort" "8080");

Spring XML

Code Block

language	xml


   <camelContext>
       <properties>
           <property key="http.proxyHost" value="172.168.18.9"/>
           <property key="http.proxyPort" value="8080"/>
      </properties>
   </camelContext>

...

If you are using POST to send data you can configure the charset using the Exchange property:

Code Block

language	java


exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1");

...

This sample polls the Google homepage every 10 seconds and write the page to the file message.html:

Code Block

language	java


from("timer://foo?fixedRate=true&delay=0&period=10000")
  .to("http4://www.google.com")
  .setHeader(FileComponent.HEADER_FILE_NAME, "message.html")
  .to("file:target/google");

...

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.

Code Block

	java
	java


// we query for Camel at the Google page
template.sendBody("http4://www.google.com/search?q=Camel", null);

URI Parameters from the Message

Code Block

	java
	java


Map headers = new HashMap();
headers.put(HttpProducer.QUERY, "q=Camel&lr=lang_en");
// we query for Camel and English language at Google
template.sendBody("http4://www.google.com/search", null, headers);

...

You can get the HTTP response code from the HTTP4 component by getting the value from the Out message header with HttpProducer.HTTP_RESPONSE_CODE.

Code Block

	java
	java


Exchange exchange = template.send("http4://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);

...

Programmatic configuration of the component

Code Block

language	java


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);

HttpComponent httpComponent = getContext().getComponent("http4", HttpComponent.class);
httpComponent.setSslContextParameters(scp);

Spring DSL based configuration of endpoint

Code Block

	xml
	xml


...
  <camel:sslContextParameters
      id="sslContextParameters">
    <camel:keyManagers
        keyPassword="keyPassword">
      <camel:keyStore
          resource="/users/home/server/keystore.jks"
          password="keystorePassword"/>
    </camel:keyManagers>
  </camel:sslContextParameters>...
...
  <to uri="https4://127.0.0.1/mail/?sslContextParametersRef=sslContextParameters"/>...

...

However if you just want to specify the keystore and truststore you can do this with Apache HTTP HttpClientConfigurer, for example:

Code Block

language	java


KeyStore keystore = ...;
KeyStore truststore = ...;

SchemeRegistry registry = new SchemeRegistry();
registry.register(new Scheme("https", 443, new SSLSocketFactory(keystore, "mypassword", truststore)));

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:

Code Block

language	java


HttpComponent httpComponent = getContext().getComponent("http4", HttpComponent.class);
httpComponent.setHttpClientConfigurer(new MyHttpClientConfigurer());

If you are doing this using the Spring DSL, you can specify your HttpClientConfigurer using the URI. For example:

Code Block

language	xml


<bean id="myHttpClientConfigurer"
 class="my.https.HttpClientConfigurer">
</bean>

<to uri="https4://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/>

...

1. Create a (Spring) factory for HttpContexts:

Code Block

language	java


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
}

2. Declare an HttpContext in the Spring application context file:

Code Block

language	xml


<bean id="myHttpContext" factory-bean="httpContextFactory" factory-method="getObject"/>

3. Reference the context in the http4 URL:

Code Block

language	xml


<to uri="https4://myhostname.com:443/myURL?httpContext=myHttpContext"/>

...

The HTTP4 component only support one instance of org.apache.camel.util.jsse.SSLContextParameters per component. If you need to use 2 or more different instances, then you need to setup multiple HTTP4 components as shown below. Where we have 2 components, each using their own instance of sslContextParameters property.

Code Block

	xml
	xml


<bean id="http4-foo" class="org.apache.camel.component.http4.HttpComponent">
   <property name="sslContextParameters" ref="sslContextParams1"/>
   <property name="x509HostnameVerifier" ref="hostnameVerifier"/>
</bean>

<bean id="http4-bar" class="org.apache.camel.component.http4.HttpComponent">
   <property name="sslContextParameters" ref="sslContextParams2"/>
   <property name="x509HostnameVerifier" ref="hostnameVerifier"/>
</bean>

Child pages

Versions Compared

Old Version 27

New Version 28

Key

URI format

HttpComponent Options

HttpEndpoint Options

Message Headers

Message Body

URI Parameters from the Message

Programmatic configuration of the component

Spring DSL based configuration of endpoint