You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2015/07/17 13:19:53 UTC
svn commit: r958669 [4/4] - in /websites/production/camel/content:
book-component-appendix.html book-in-one-page.html cache/main.pageCache
http.html http4.html
Modified: websites/production/camel/content/http4.html
==============================================================================
--- websites/production/camel/content/http4.html (original)
+++ websites/production/camel/content/http4.html Fri Jul 17 11:19:53 2015
@@ -86,162 +86,162 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="HTTP4-HTTP4Component">HTTP4 Component</h2><p><strong>Available as of Camel 2.3</strong></p><p>The <strong>http4:</strong> component provides HTTP based <a shape="rect" href="endpoint.html">endpoints</a> for calling external HTTP resources (as a client to call external servers using HTTP).</p><p>Maven users will need to add the following dependency to their <code>pom.xml</code> for this component:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><dependency>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<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>
-</pre>
+]]></script>
</div></div><div class="confluence-information-macro confluence-information-macro-information"><p class="title">camel-http4 vs camel-http</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>Camel-http4 uses <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/">Apache HttpClient 4.x</a> while camel-http uses <a shape="rect" class="external-link" href="http://hc.apache.org/httpclient-3.x/">Apache HttpClient 3.x</a>.</p></div></div><h3 id="HTTP4-URIformat">URI format</h3><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">http4:hostname[:port][/resourceUri][?options]
-</pre>
-</div></div><p>Will by default use port 80 for HTTP and 443 for HTTPS.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">camel-http4 vs camel-jetty</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can only produce to endpoints generated by the HTTP4 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, use the <a shape="rect" href="jetty.html">Jetty Component</a> instead.</p></div></div><h3 id="HTTP4-HttpComponentOptions">HttpComponent Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" clas
s="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxTotalConnections</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>200</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of connections.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionsPerRoute</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>20</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of connections per route.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>cookieStore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0:</strong> To use a custom <code>org.apache.http.client.CookieStore</code>.
By default the <code>org.apache.http.impl.client.BasicCookieStore</code> is used which is an in-memory only cookie store. Notice if <code>bridgeEndpoint=true</code> 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).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a <code>org.apache.camel.component.http.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientConnectionManager</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.http.conn.ClientConnectionManager</co
de>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.http.HttpBinding</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContext</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.2:</strong> To use a custom <code>org.apache.http.protocol.HttpContext</code> when executing requests.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> To use a custom <code>org.apache.camel.util.jsse.SSLContextParam
eters</code>. See <a shape="rect" href="http4.html">Using the JSSE Configuration Utility</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>x509HostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>BrowserCompatHostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7:</strong> You can refer to a different <code>org.apache.http.conn.ssl.X509HostnameVerifier</code> instance in the <a shape="rect" href="registry.html">Registry</a> such as <code>org.apache.http.conn.ssl.StrictHostnameVerifier</code> or <code>org.apache.http.conn.ssl.AllowAllHostnameVerifier</code>.</p></td></tr><tr><td colspan=
"1" rowspan="1" class="confluenceTd"><p><code>connectionTimeToLive</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The time for connection to live, the time unit is millisecond, the default value is always keep alive.</p></td></tr></tbody></table></div><p> </p><h3 id="HTTP4-HttpEndpointOptions">HttpEndpoint Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnFailure</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Option to disable throwing the <
code>HttpOperationFailedException</code> in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bridgeEndpoint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the <strong>throwExcpetionOnFailure</strong> 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".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clearExpiredCookies</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong
>Camel 2.11.2/2.12.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>cookieStore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0:</strong> To use a custom <code>org.apache.http.client.CookieStore</code>. By default the <code>org.apache.http.impl.client.BasicCookieStore</code> is used which is an in-memory only cookie store. Notice if <code>bridgeEndpoint=true</code> 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).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disableStreamCache</code></p></td><td colspan="1" rowspan="1" class
="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.4:</strong> Reference to a instance of <code>org.apache.camel.spi.HeaderFilterStrategy</code> in the <a shape="rect" href="registry.html">Registry</a>. It will be used to apply the custom headerFilterStrategy on the new create HttpEndpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBindingRef</code></p></td><td colspan="1" rowspan="1" class="co
nfluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>org.apache.camel.component.http.HttpBinding</code> in the <a shape="rect" href="registry.html">Registry</a>. Use the <code>httpBinding</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.http.HttpBinding</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurerRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>org.apache.camel.component.htt
p.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>. Use the <code>httpClientConfigurer</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a <code>org.apache.camel.component.http.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContextRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> <strong>Camel 2.9.2:</strong> Reference to a custom <code>org.apache.http.protocol.HttpContext</code> in the <a shape="rect" href="registry.html">Registry</a>. Use the <code>
httpContext</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContext</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.2:</strong> To use a custom <code>org.apache.http.protocol.HttpContext</code> when executing requests.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient.XXX</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Setting options on the <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/BasicHttpParams.html">BasicHttpParams</a>. For instance <code>httpClient.soTimeout=5000</code> will set the <code>SO_TIMEOUT</code> to 5 seconds. Look on the setter methods of the following parameter beans for a complete re
ference: <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/auth/params/AuthParamBean.html">AuthParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/client/params/ClientParamBean.html">ClientParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnConnectionParamBean.html">ConnConnectionParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnRouteParamBean.html">ConnRouteParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/cookie/params/CookieSpecParamBean.html">CookieSpecParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apac
he.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpConnectionParamBean.html">HttpConnectionParamBean</a> and <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpProtocolParamBean.html">HttpProtocolParamBean</a></p><p><strong>Since Camel 2.13.0: </strong>httpClient is changed to configure the <span> </span><a shape="rect" class="external-link" href="https://hc.apache.org/httpcomponents-client-4.3.x/httpclient/apidocs/org/apache/http/impl/client/HttpClientBuilder.html">HttpClientBuilder</a><span> and </span><a shape="rect" class="external-link" href="https://hc.apache.org/httpcomponents-client-4.3.x/httpclient/apidocs/org/apache/http/client/config/RequestConfig.Builder.html">RequestConfig.Builder</a>, please check out API document for a complete reference.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientConnectionManager</code></p></td>
<td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.http.conn.ClientConnectionManager</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>transferException</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused <code>Exception</code> was send back serialized in the response as a <code>application/x-java-serialized-object</code> content type (for example using <a shape="rect" href="jetty.html">Jetty</a> or <a shape="rect" href="servlet.html">SERVLET</a> Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the <code>HttpOperationFailedException</code>. The caused exception is requir
ed to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParametersRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> <strong>Camel 2.8:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" href="registry.html">Registry</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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 <a shape="rect" href="http4.html">Using the JSSE Configuration Utility</a>. Use the <code>sslContextParameters</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslCo
ntextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" href="registry.html">Registry</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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 <a shape="rect" href="http4.html">Using the JSSE Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>x509HostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>BrowserCompatHostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7:</strong> You can
refer to a different <code>org.apache.http.conn.ssl.X509HostnameVerifier</code> instance in the <a shape="rect" href="registry.html">Registry</a> such as <code>org.apache.http.conn.ssl.StrictHostnameVerifier</code> or <code>org.apache.http.conn.ssl.AllowAllHostnameVerifier</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlRewrite</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> Refers to a custom <code>org.apache.camel.component.http4.UrlRewrite</code> which allows you to rewrite urls when you bridge/proxy endpoints. See more details at <a shape="rect" href="urlrewrite.html">UrlRewrite</a> and <a shape="rect" href="how-to-use-camel-as-a-http-proxy-between-a-client-and-server.html">How to use Camel as a HTTP proxy between a client and server</a>.</p></td></tr><tr><td colspan="1" rowspan="1" cla
ss="confluenceTd"><p><code>maxTotalConnections</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14</strong>: 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionsPerRoute</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14</strong>: The maximum number of connections per route. <span>If this option is not set, camel will use the component's setting instead.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authenticationPreemptive</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" clas
s="confluenceTd"><p><strong>Camel 2.11.3/2.12.2:</strong> If this option is true, camel-http4 sends preemptive basic authentication to the server.</p></td></tr></tbody></table></div><p>The following authentication options can also be set on the HttpEndpoint:</p><h4 id="HTTP4-SettingBasicAuthenticationandProxy">Setting Basic Authentication and Proxy</h4><p><strong>Before Camel 2.8.0</strong></p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><cod
e>password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>domain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The domain name for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The host name authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy host name</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><code>proxyPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy port number</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy domain name
</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyNtHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy Nt host name</p></td></tr></tbody></table></div><p><strong>Since Camel 2.8.0</strong></p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authPassword</code></p></td><td colspan="1" rowspan="1" clas
s="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The domain name for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The host name authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy host name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthPort</cod
e></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy port number</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthScheme</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy scheme, will fallback and use the scheme from the endpoint if not configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>
Password for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy domain name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthNtHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy Nt host name</p></td></tr></tbody></table></div><h3 id="HTTP4-MessageHeaders">Message Headers</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_URI</code></
p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>URI to call. Will override existing URI set directly on the endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_PATH</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Request URI's path, the header will be used to build the request URI with the HTTP_URI.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_QUERY</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>URI parameters. Will override existing URI parameters set directly on the endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_RESPONSE_CODE</code></p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP response code from the external server. Is 200 for OK.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_CHARACTER_ENCODING</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Character encoding.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.CONTENT_TYPE</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as <code>text/html</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.CONTENT_ENCODING</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String
</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as <code>gzip</code>.</p></td></tr></tbody></table></div><h3 id="HTTP4-MessageBody">Message Body</h3><p>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.</p><h3 id="HTTP4-Responsecode">Response code</h3><p>Camel will handle according to the HTTP response code:</p><ul class="alternate"><li>Response code is in the range 100..299, Camel regards it as a success response.</li><li>Response code is in the range 300..399, Camel regards it as a redirection response and will throw a <code>HttpOperationFailedException</code> with the information.</li><li><p>Response code is 400+, Camel regards it as an exte
rnal server failure and will throw a <code>HttpOperationFailedException</code> with the information.</p><div class="confluence-information-macro confluence-information-macro-tip"><p class="title">throwExceptionOnFailure</p><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>The option, <code>throwExceptionOnFailure</code>, can be set to <code>false</code> to prevent the <code>HttpOperationFailedException</code> from being thrown for failed response codes. This allows you to get any response from the remote server.<br clear="none"> There is a sample below demonstrating this.</p></div></div></li></ul><h3 id="HTTP4-HttpOperationFailedException">HttpOperationFailedException</h3><p>This exception contains the following information:</p><ul class="alternate"><li>The HTTP status code</li><li>The HTTP status line (text of the status code)</li><li>Redirect location, if server returned a redirect<
/li><li>Response body as a <code>java.lang.String</code>, if server provided a body as response</li></ul><h3 id="HTTP4-CallingusingGETorPOST">Calling using GET or POST</h3><p>The following algorithm is used to determine whether the <code>GET</code> or <code>POST</code> HTTP method should be used:<br clear="none"> 1. Use method provided in header.<br clear="none"> 2. <code>GET</code> if query string is provided in header.<br clear="none"> 3. <code>GET</code> if endpoint is configured with a query string.<br clear="none"> 4. <code>POST</code> if there is data to send (body is not null).<br clear="none"> 5. <code>GET</code> otherwise.</p><h3 id="HTTP4-HowtogetaccesstoHttpServletRequestandHttpServletResponse">How to get access to HttpServletRequest and HttpServletResponse</h3><p>You can get access to these two using the Camel type converter system using<br clear="none"> <strong>NOTE</strong> You can get the request and response not just from the processor after the camel-jetty or camel-
cxf endpoint.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class);
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[http4:hostname[:port][/resourceUri][?options]
+]]></script>
+</div></div><p>Will by default use port 80 for HTTP and 443 for HTTPS.</p><p>You can append query options to the URI in the following format, <code>?option=value&option=value&...</code></p><div class="confluence-information-macro confluence-information-macro-information"><p class="title">camel-http4 vs camel-jetty</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>You can only produce to endpoints generated by the HTTP4 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, use the <a shape="rect" href="jetty.html">Jetty Component</a> instead.</p></div></div><h3 id="HTTP4-HttpComponentOptions">HttpComponent Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" clas
s="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxTotalConnections</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>200</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of connections.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionsPerRoute</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>20</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The maximum number of connections per route.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>cookieStore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0:</strong> To use a custom <code>org.apache.http.client.CookieStore</code>.
By default the <code>org.apache.http.impl.client.BasicCookieStore</code> is used which is an in-memory only cookie store. Notice if <code>bridgeEndpoint=true</code> 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).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a <code>org.apache.camel.component.http.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientConnectionManager</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.http.conn.ClientConnectionManager</co
de>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.http.HttpBinding</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContext</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.2:</strong> To use a custom <code>org.apache.http.protocol.HttpContext</code> when executing requests.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.8:</strong> To use a custom <code>org.apache.camel.util.jsse.SSLContextParam
eters</code>. See <a shape="rect" href="#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>x509HostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>BrowserCompatHostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7:</strong> You can refer to a different <code>org.apache.http.conn.ssl.X509HostnameVerifier</code> instance in the <a shape="rect" href="registry.html">Registry</a> such as <code>org.apache.http.conn.ssl.StrictHostnameVerifier</code> or <code>org.apache.http.conn.ssl.AllowAllHostnameVerifier</code>.<
/p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionTimeToLive</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>-1</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.0:</strong> The time for connection to live, the time unit is millisecond, the default value is always keep alive.</p></td></tr></tbody></table></div><p> </p><h3 id="HTTP4-HttpEndpointOptions">HttpEndpoint Options</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>throwExceptionOnFailure</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Opt
ion to disable throwing the <code>HttpOperationFailedException</code> in case of failed responses from the remote server. This allows you to get all responses regardless of the HTTP status code.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>bridgeEndpoint</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the <strong>throwExcpetionOnFailure</strong> 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".</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clearExpiredCookies</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>true</code></p></td><td colspan="1" rowspan="1" cl
ass="confluenceTd"><p><strong>Camel 2.11.2/2.12.0:</strong> 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>cookieStore</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.2/2.12.0:</strong> To use a custom <code>org.apache.http.client.CookieStore</code>. By default the <code>org.apache.http.impl.client.BasicCookieStore</code> is used which is an in-memory only cookie store. Notice if <code>bridgeEndpoint=true</code> 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).</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>disableStreamCache</code></p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>headerFilterStrategy</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.10.4:</strong> Reference to a instance of <code>org.apache.camel.spi.HeaderFilterStrategy</code> in the <a shape="rect" href="registry.html">Registry</a>. It will be used to apply the custom headerFilterStrategy on the new create HttpEndpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBindingRef</code></p></td><td cols
pan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>org.apache.camel.component.http.HttpBinding</code> in the <a shape="rect" href="registry.html">Registry</a>. Use the <code>httpBinding</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpBinding</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.camel.component.http.HttpBinding</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurerRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> Reference to a <code>o
rg.apache.camel.component.http.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>. Use the <code>httpClientConfigurer</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClientConfigurer</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Reference to a <code>org.apache.camel.component.http.HttpClientConfigurer</code> in the <a shape="rect" href="registry.html">Registry</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContextRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> <strong>Camel 2.9.2:</strong> Reference to a custom <code>org.apache.http.protocol.HttpContext</code> in the <a shape="rect" href="registry.html"
>Registry</a>. Use the <code>httpContext</code> option instead.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpContext</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.9.2:</strong> To use a custom <code>org.apache.http.protocol.HttpContext</code> when executing requests.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>httpClient.XXX</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Setting options on the <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/BasicHttpParams.html">BasicHttpParams</a>. For instance <code>httpClient.soTimeout=5000</code> will set the <code>SO_TIMEOUT</code> to 5 seconds. Look on the setter methods of the following para
meter beans for a complete reference: <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/auth/params/AuthParamBean.html">AuthParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/client/params/ClientParamBean.html">ClientParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnConnectionParamBean.html">ConnConnectionParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/conn/params/ConnRouteParamBean.html">ConnRouteParamBean</a>, <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache/http/cookie/params/CookieSpecParamBean.html">CookieSpecParamBean</a>, <a shape="rect" class="extern
al-link" href="http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpConnectionParamBean.html">HttpConnectionParamBean</a> and <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-core-ga/httpcore/apidocs/org/apache/http/params/HttpProtocolParamBean.html">HttpProtocolParamBean</a></p><p><strong>Since Camel 2.13.0: </strong>httpClient is changed to configure the <span> </span><a shape="rect" class="external-link" href="https://hc.apache.org/httpcomponents-client-4.3.x/httpclient/apidocs/org/apache/http/impl/client/HttpClientBuilder.html">HttpClientBuilder</a><span> and </span><a shape="rect" class="external-link" href="https://hc.apache.org/httpcomponents-client-4.3.x/httpclient/apidocs/org/apache/http/client/config/RequestConfig.Builder.html">RequestConfig.Builder</a>, please check out API document for a complete reference.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>clientConn
ectionManager</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>To use a custom <code>org.apache.http.conn.ClientConnectionManager</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>transferException</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>If enabled and an <a shape="rect" href="exchange.html">Exchange</a> failed processing on the consumer side, and if the caused <code>Exception</code> was send back serialized in the response as a <code>application/x-java-serialized-object</code> content type (for example using <a shape="rect" href="jetty.html">Jetty</a> or <a shape="rect" href="servlet.html">SERVLET</a> Camel components). On the producer side the exception will be deserialized and thrown as is, instead of the <code>HttpOperationFailedException</code>. T
he caused exception is required to be serialized.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParametersRef</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Deprecated and will be removed in Camel 3.0:</strong> <strong>Camel 2.8:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" href="registry.html">Registry</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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 <a shape="rect" href="#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>. Use the <code>sslContextParameters</code> option instead.</p></td></tr><tr><td c
olspan="1" rowspan="1" class="confluenceTd"><p><code>sslContextParameters</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.1:</strong> Reference to a <code>org.apache.camel.util.jsse.SSLContextParameters</code> in the <a shape="rect" href="registry.html">Registry</a>. <strong>Important:</strong> Only one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> 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 <a shape="rect" href="#HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>x509HostnameVerifier</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>BrowserCompatHostnameVerifier</code></p></td>
<td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.7:</strong> You can refer to a different <code>org.apache.http.conn.ssl.X509HostnameVerifier</code> instance in the <a shape="rect" href="registry.html">Registry</a> such as <code>org.apache.http.conn.ssl.StrictHostnameVerifier</code> or <code>org.apache.http.conn.ssl.AllowAllHostnameVerifier</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>urlRewrite</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11:</strong> <strong>Producer only</strong> Refers to a custom <code>org.apache.camel.component.http4.UrlRewrite</code> which allows you to rewrite urls when you bridge/proxy endpoints. See more details at <a shape="rect" href="urlrewrite.html">UrlRewrite</a> and <a shape="rect" href="how-to-use-camel-as-a-http-proxy-between-a-client-and-server.html">How to use Camel as a HTTP
proxy between a client and server</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>maxTotalConnections</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14</strong>: 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.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>connectionsPerRoute</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.14</strong>: The maximum number of connections per route. <span>If this option is not set, camel will use the component's setting instead.</span></p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authenticationPreemptive</code></p></td><td colspan="1" rowspan=
"1" class="confluenceTd"><p><code>false</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><strong>Camel 2.11.3/2.12.2:</strong> If this option is true, camel-http4 sends preemptive basic authentication to the server.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><code>eagerCheckContentAvailable</code></td><td colspan="1" rowspan="1" class="confluenceTd"><code>false</code></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Camel 2.16:</strong><span> </span><strong>Consumer only</strong><span> </span><span> Whether to eager check whether the HTTP requests has content if the content-length header is 0 or not present. </span><span> This can be turned on in case HTTP clients do not send streamed data.</span></td></tr></tbody></table></div><p>The following authentication options can also be set on the HttpEndpoint:</p><h4 id="HTTP4-SettingBasicAuthenticationandProxy">Setting Basic Authentication and Proxy</h4><p><strong>Be
fore Camel 2.8.0</strong></p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>username</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>password</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>domain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td cols
pan="1" rowspan="1" class="confluenceTd"><p>The domain name for authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>host</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The host name authentication.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy host name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy port number</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><cod
e>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy domain name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyNtHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy Nt host name</p></td></tr></tbody></table></div><p><strong>Since Camel 2.8.0</strong></p><div class="table-wrap"><table class
="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Default Value</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The domain
name for authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>authHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The host name authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy host name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthPort</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy port number</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthScheme</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowsp
an="1" class="confluenceTd"><p>The proxy scheme, will fallback and use the scheme from the endpoint if not configured.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthUsername</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Username for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthPassword</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Password for proxy authentication</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>proxyAuthDomain</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy domain name</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>p
roxyAuthNtHost</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>null</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The proxy Nt host name</p></td></tr></tbody></table></div><h3 id="HTTP4-MessageHeaders">Message Headers</h3><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh"><p>Name</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1" rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_URI</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>URI to call. Will override existing URI set directly on the endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_PATH</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><
p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Request URI's path, the header will be used to build the request URI with the HTTP_URI.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_QUERY</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>URI parameters. Will override existing URI parameters set directly on the endpoint.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_RESPONSE_CODE</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>int</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP response code from the external server. Is 200 for OK.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.HTTP_CHARACTER_ENCODING</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</c
ode></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Character encoding.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.CONTENT_TYPE</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as <code>text/html</code>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code>Exchange.CONTENT_ENCODING</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p><code>String</code></p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as <code>gzip</code>.</p></td></tr></tbody></table></div><h3 id="HTTP4-MessageBody">Message Body</h3><p>Camel will store the HTTP response from the external server on the OUT body. All headers from t
he 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.</p><h3 id="HTTP4-Responsecode">Response code</h3><p>Camel will handle according to the HTTP response code:</p><ul class="alternate"><li>Response code is in the range 100..299, Camel regards it as a success response.</li><li>Response code is in the range 300..399, Camel regards it as a redirection response and will throw a <code>HttpOperationFailedException</code> with the information.</li><li><p>Response code is 400+, Camel regards it as an external server failure and will throw a <code>HttpOperationFailedException</code> with the information.</p><div class="confluence-information-macro confluence-information-macro-tip"><p class="title">throwExceptionOnFailure</p><span class="aui-icon aui-icon-small aui-iconfont-approve confluence-information-macro-icon"></span><div class="confluence-information-macro-body
"><p>The option, <code>throwExceptionOnFailure</code>, can be set to <code>false</code> to prevent the <code>HttpOperationFailedException</code> from being thrown for failed response codes. This allows you to get any response from the remote server.<br clear="none"> There is a sample below demonstrating this.</p></div></div></li></ul><h3 id="HTTP4-HttpOperationFailedException">HttpOperationFailedException</h3><p>This exception contains the following information:</p><ul class="alternate"><li>The HTTP status code</li><li>The HTTP status line (text of the status code)</li><li>Redirect location, if server returned a redirect</li><li>Response body as a <code>java.lang.String</code>, if server provided a body as response</li></ul><h3 id="HTTP4-CallingusingGETorPOST">Calling using GET or POST</h3><p>The following algorithm is used to determine whether the <code>GET</code> or <code>POST</code> HTTP method should be used:<br clear="none"> 1. Use method provided in header.<br clear="none"> 2.
<code>GET</code> if query string is provided in header.<br clear="none"> 3. <code>GET</code> if endpoint is configured with a query string.<br clear="none"> 4. <code>POST</code> if there is data to send (body is not null).<br clear="none"> 5. <code>GET</code> otherwise.</p><h3 id="HTTP4-HowtogetaccesstoHttpServletRequestandHttpServletResponse">How to get access to HttpServletRequest and HttpServletResponse</h3><p>You can get access to these two using the Camel type converter system using<br clear="none"> <strong>NOTE</strong> You can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class);
HttpServletRequest response = exchange.getIn().getBody(HttpServletResponse.class);
-</pre>
+]]></script>
</div></div><h3 id="HTTP4-ConfiguringURItocall">Configuring URI to call</h3><p>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, <code>oldhost</code>, using HTTP.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
- .to("http4://oldhost");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .to("http4://oldhost");
+]]></script>
</div></div><p>And the equivalent Spring sample:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
<route>
- <from uri="direct:start"/>
- <to uri="http4://oldhost"/>
+ <from uri="direct:start"/>
+ <to uri="http4://oldhost"/>
</route>
</camelContext>
-</pre>
+]]></script>
</div></div><p>You can override the HTTP endpoint URI by adding a header with the key, <code>Exchange.HTTP_URI</code>, on the message.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
- .setHeader(Exchange.HTTP_URI, constant("http://newhost"))
- .to("http4://oldhost");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .setHeader(Exchange.HTTP_URI, constant("http://newhost"))
+ .to("http4://oldhost");
+]]></script>
</div></div><p>In the sample above Camel will call the <span class="nolink">http://newhost</span> despite the endpoint is configured with http4://oldhost.<br clear="none">If the http4 endpoint is working in bridge mode, it will ignore the message header of <code>Exchange.HTTP_URI</code>.</p><h3 id="HTTP4-ConfiguringURIParameters">Configuring URI Parameters</h3><p>The <strong>http</strong> 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 <code>Exchange.HTTP_QUERY</code> on the message.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
- .to("http4://oldhost?order=123&detail=short");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .to("http4://oldhost?order=123&detail=short");
+]]></script>
</div></div><p>Or options provided in a header:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
- .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short"))
- .to("http4://oldhost");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short"))
+ .to("http4://oldhost");
+]]></script>
</div></div><h3 id="HTTP4-Howtosetthehttpmethod(GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE)totheHTTPproducer">How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer</h3><div class="confluence-information-macro confluence-information-macro-information"><p class="title">Using the http PATCH method</p><span class="aui-icon aui-icon-small aui-iconfont-info confluence-information-macro-icon"></span><div class="confluence-information-macro-body"><p>The http PATCH method is supported starting with Camel 2.11.3 / 2.12.1.</p></div></div><p>The HTTP4 component provides a way to set the HTTP request method by setting the message header. Here is an example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
.setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http4.HttpMethods.POST))
- .to("http4://www.google.com")
- .to("mock:results");
-</pre>
+ .to("http4://www.google.com")
+ .to("mock:results");
+]]></script>
</div></div><p>The method can be written a bit shorter using the string constants:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">.setHeader("CamelHttpMethod", constant("POST"))
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[.setHeader("CamelHttpMethod", constant("POST"))
+]]></script>
</div></div><p>And the equivalent Spring sample:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<camelContext xmlns="http://activemq.apache.org/camel/schema/spring">
<route>
- <from uri="direct:start"/>
- <setHeader headerName="CamelHttpMethod">
+ <from uri="direct:start"/>
+ <setHeader headerName="CamelHttpMethod">
<constant>POST</constant>
</setHeader>
- <to uri="http4://www.google.com"/>
- <to uri="mock:results"/>
+ <to uri="http4://www.google.com"/>
+ <to uri="mock:results"/>
</route>
</camelContext>
-</pre>
+]]></script>
</div></div><h3 id="HTTP4-Usingclienttimeout-SO_TIMEOUT">Using client timeout - SO_TIMEOUT</h3><p>See the <a shape="rect" class="external-link" href="https://svn.apache.org/repos/asf/camel/trunk/components/camel-http4/src/test/java/org/apache/camel/component/http4/HttpSOTimeoutTest.java">HttpSOTimeoutTest</a> unit test.</p><h3 id="HTTP4-ConfiguringaProxy">Configuring a Proxy</h3><p>The HTTP4 component provides a way to configure a proxy.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">from("direct:start")
- .to("http4://oldhost?proxyAuthHost=www.myproxy.com&proxyAuthPort=80");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[from("direct:start")
+ .to("http4://oldhost?proxyAuthHost=www.myproxy.com&proxyAuthPort=80");
+]]></script>
</div></div><p>There is also support for proxy authentication via the <code>proxyAuthUsername</code> and <code>proxyAuthPassword</code> options.</p><h4 id="HTTP4-UsingproxysettingsoutsideofURI">Using proxy settings outside of URI</h4><p>To avoid System properties conflicts, you can set proxy configuration only from the CamelContext or URI.<br clear="none"> Java DSL :</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;"> context.getProperties().put("http.proxyHost", "172.168.18.9");
- context.getProperties().put("http.proxyPort" "8080");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ context.getProperties().put("http.proxyHost", "172.168.18.9");
+ context.getProperties().put("http.proxyPort" "8080");
+]]></script>
</div></div><p>Spring XML</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"> <camelContext>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ <camelContext>
<properties>
- <property key="http.proxyHost" value="172.168.18.9"/>
- <property key="http.proxyPort" value="8080"/>
+ <property key="http.proxyHost" value="172.168.18.9"/>
+ <property key="http.proxyPort" value="8080"/>
</properties>
</camelContext>
-</pre>
+]]></script>
</div></div><p>Camel will first set the settings from Java System or CamelContext Properties and then the endpoint proxy options if provided.<br clear="none"> So you can override the system properties with the endpoint options.</p><p>Notice in <strong>Camel 2.8</strong> there is also a <code>http.proxyScheme</code> property you can set to explicit configure the scheme to use.</p><h3 id="HTTP4-Configuringcharset">Configuring charset</h3><p>If you are using <code>POST</code> to send data you can configure the <code>charset</code> using the <code>Exchange</code> property:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1");
+]]></script>
</div></div><h4 id="HTTP4-Samplewithscheduledpoll">Sample with scheduled poll</h4><p>This sample polls the Google homepage every 10 seconds and write the page to the file <code>message.html</code>:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">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");
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[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");
+]]></script>
</div></div><h4 id="HTTP4-URIParametersfromtheendpointURI">URI Parameters from the endpoint URI</h4><p>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 <code>&</code> character as separator, just as you would in the web browser. Camel does no tricks here.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">// we query for Camel at the Google page
-template.sendBody("http4://www.google.com/search?q=Camel", null);
-</pre>
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[// we query for Camel at the Google page
+template.sendBody("http4://www.google.com/search?q=Camel", null);
+]]></script>
</div></div><h4 id="HTTP4-URIParametersfromtheMessage">URI Parameters from the Message</h4><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">Map headers = new HashMap();
-headers.put(Exchange.HTTP_QUERY, "q=Camel&lr=lang_en");
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Map headers = new HashMap();
+headers.put(Exchange.HTTP_QUERY, "q=Camel&lr=lang_en");
// we query for Camel and English language at Google
-template.sendBody("http4://www.google.com/search", null, headers);
-</pre>
+template.sendBody("http4://www.google.com/search", null, headers);
+]]></script>
</div></div><p>In the header value above notice that it should <strong>not</strong> be prefixed with <code>?</code> and you can separate parameters as usual with the <code>&</code> char.</p><h4 id="HTTP4-GettingtheResponseCode">Getting the Response Code</h4><p>You can get the HTTP response code from the HTTP4 component by getting the value from the Out message header with <code>Exchange.HTTP_RESPONSE_CODE</code>.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">Exchange exchange = template.send("http4://www.google.com/search", new Processor() {
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[Exchange exchange = template.send("http4://www.google.com/search", new Processor() {
public void process(Exchange exchange) throws Exception {
- exchange.getIn().setHeader(Exchange.HTTP_QUERY, constant("hl=en&q=activemq"));
+ exchange.getIn().setHeader(Exchange.HTTP_QUERY, constant("hl=en&q=activemq"));
}
});
Message out = exchange.getOut();
int responseCode = out.getHeader(Exchange.HTTP_RESPONSE_CODE, Integer.class);
-</pre>
+]]></script>
</div></div><h3 id="HTTP4-DisablingCookies">Disabling Cookies</h3><p>To disable cookies you can set the HTTP Client to ignore cookies by adding this URI option:<br clear="none"> <code>httpClient.cookiePolicy=ignoreCookies</code></p><h3 id="HTTP4-AdvancedUsage">Advanced Usage</h3><p>If you need more control over the HTTP producer you should use the <code>HttpComponent</code> where you can set various classes to give you custom behavior.</p><h4 id="HTTP4-SettingupSSLforHTTPClient">Setting up SSL for HTTP Client</h4><h5 id="HTTP4-UsingtheJSSEConfigurationUtility">Using the JSSE Configuration Utility</h5><p>As of Camel 2.8, the HTTP4 component supports SSL/TLS configuration through the <a shape="rect" href="camel-configuration-utilities.html">Camel JSSE Configuration Utility</a>.  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 uti
lity with the HTTP4 component.</p><h6 id="HTTP4-Programmaticconfigurationofthecomponent">Programmatic configuration of the component</h6><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">KeyStoreParameters ksp = new KeyStoreParameters();
-ksp.setResource("/users/home/server/keystore.jks");
-ksp.setPassword("keystorePassword");
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[KeyStoreParameters ksp = new KeyStoreParameters();
+ksp.setResource("/users/home/server/keystore.jks");
+ksp.setPassword("keystorePassword");
KeyManagersParameters kmp = new KeyManagersParameters();
kmp.setKeyStore(ksp);
-kmp.setKeyPassword("keyPassword");
+kmp.setKeyPassword("keyPassword");
SSLContextParameters scp = new SSLContextParameters();
scp.setKeyManagers(kmp);
-HttpComponent httpComponent = getContext().getComponent("https4", HttpComponent.class);
+HttpComponent httpComponent = getContext().getComponent("https4", HttpComponent.class);
httpComponent.setSslContextParameters(scp);
-</pre>
+]]></script>
</div></div><h6 id="HTTP4-SpringDSLbasedconfigurationofendpoint">Spring DSL based configuration of endpoint</h6><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;">...
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[...
<camel:sslContextParameters
- id="sslContextParameters">
+ id="sslContextParameters">
<camel:keyManagers
- keyPassword="keyPassword">
+ keyPassword="keyPassword">
<camel:keyStore
- resource="/users/home/server/keystore.jks"
- password="keystorePassword"/>
+ resource="/users/home/server/keystore.jks"
+ password="keystorePassword"/>
</camel:keyManagers>
</camel:sslContextParameters>...
...
- <to uri="https4://127.0.0.1/mail/?sslContextParametersRef=sslContextParameters"/>...
-</pre>
+ <to uri="https4://127.0.0.1/mail/?sslContextParametersRef=sslContextParameters"/>...
+]]></script>
</div></div><h5 id="HTTP4-ConfiguringApacheHTTPClientDirectly">Configuring Apache HTTP Client Directly</h5><p>Basically camel-http4 component is built on the top of <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/">Apache HttpClient</a>. Please refer to <a shape="rect" class="external-link" href="http://hc.apache.org/httpcomponents-client-ga/tutorial/html/connmgmt.html#d4e537">SSL/TLS customization</a> for details or have a look into the <code>org.apache.camel.component.http4.HttpsServerTestSupport</code> unit test base class.<br clear="none"> You can also implement a custom <code>org.apache.camel.component.http4.HttpClientConfigurer</code> to do some configuration on the http client if you need full control of it.</p><p>However if you <em>just</em> want to specify the keystore and truststore you can do this with Apache HTTP <code>HttpClientConfigurer</code>, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="
codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">KeyStore keystore = ...;
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[KeyStore keystore = ...;
KeyStore truststore = ...;
SchemeRegistry registry = new SchemeRegistry();
-registry.register(new Scheme("https", 443, new SSLSocketFactory(keystore, "mypassword", truststore)));
-</pre>
+registry.register(new Scheme("https", 443, new SSLSocketFactory(keystore, "mypassword", truststore)));
+]]></script>
</div></div><p>And then you need to create a class that implements <code>HttpClientConfigurer</code>, 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:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">HttpComponent httpComponent = getContext().getComponent("http4", HttpComponent.class);
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[HttpComponent httpComponent = getContext().getComponent("http4", HttpComponent.class);
httpComponent.setHttpClientConfigurer(new MyHttpClientConfigurer());
-</pre>
+]]></script>
</div></div><p>If you are doing this using the Spring DSL, you can specify your <code>HttpClientConfigurer</code> using the URI. For example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><bean id="myHttpClientConfigurer"
- class="my.https.HttpClientConfigurer">
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="myHttpClientConfigurer"
+ class="my.https.HttpClientConfigurer">
</bean>
-<to uri="https4://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/>
-</pre>
+<to uri="https4://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/>
+]]></script>
</div></div><p>As long as you implement the HttpClientConfigurer and configure your keystore and truststore as described above, it will work fine.</p><h5 id="HTTP4-UsingHTTPStoauthenticategotchas">Using HTTPS to authenticate gotchas</h5><p>An end user reported that he had problem with authenticating with HTTPS. The problem was eventually resolved by providing a custom configured <code>org.apache.http.protocol.HttpContext</code>:</p><p>1. Create a (Spring) factory for HttpContexts:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default" style="font-size:12px;">public class HttpContextFactory {
+<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[public class HttpContextFactory {
- private String httpHost = "localhost";
+ private String httpHost = "localhost";
private String httpPort = 9001;
private BasicHttpContext httpContext = new BasicHttpContext();
@@ -258,31 +258,31 @@ httpComponent.setHttpClientConfigurer(ne
// getter and setter
}
-</pre>
+]]></script>
</div></div><p>2. Declare an HttpContext in the Spring application context file:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><bean id="myHttpContext" factory-bean="httpContextFactory" factory-method="getObject"/>
-</pre>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<bean id="myHttpContext" factory-bean="httpContextFactory" factory-method="getObject"/>
+]]></script>
</div></div><p>3. Reference the context in the http4 URL:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><to uri="https4://myhostname.com:443/myURL?httpContext=myHttpContext"/>
-</pre>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<to uri="https4://myhostname.com:443/myURL?httpContext=myHttpContext"/>
+]]></script>
</div></div><h5 id="HTTP4-UsingdifferentSSLContextParameters">Using different SSLContextParameters</h5><p>The <a shape="rect" href="http4.html">HTTP4</a> component only support one instance of <code>org.apache.camel.util.jsse.SSLContextParameters</code> per component. If you need to use 2 or more different instances, then you need to setup multiple <a shape="rect" href="http4.html">HTTP4</a> components as shown below. Where we have 2 components, each using their own instance of <code>sslContextParameters</code> property.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default" style="font-size:12px;"><bean id="http4-foo" class="org.apache.camel.component.http4.HttpComponent">
- <property name="sslContextParameters" ref="sslContextParams1"/>
- <property name="x509HostnameVerifier" ref="hostnameVerifier"/>
+<script class="brush: xml; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[<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"/>
[... 28 lines stripped ...]