Chapter 48. HTTP
Chapter 48. HTTP Only producer is supported The HTTP component provides HTTP based endpoints for calling external HTTP resources (as a client to call external servers using HTTP). 48.1. Dependencies When using http with Red Hat build of Camel Spring Boot make sure to use the following Maven dependency to have support for auto configuration: <dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-http-starter</artifactId> </dependency> 48.2. URI format Will by default use port 80 for HTTP and 443 for HTTPS. 48.3. Configuring Options Camel components are configured on two separate levels: component level endpoint level 48.3.1. Configuring Component Options At the component level, you set general and shared configurations that are, then, inherited by the endpoints. It is the highest configuration level. For example, a component may have security settings, credentials for authentication, urls for network connection and so forth. Some components only have a few options, and others may have many. Because components typically have pre-configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all. You can configure components using: the Component DSL . in a configuration file (application.properties, *.yaml files, etc). directly in the Java code. 48.3.2. Configuring Endpoint Options You usually spend more time setting up endpoints because they have many options. These options help you customize what you want the endpoint to do. The options are also categorized into whether the endpoint is used as a consumer (from), as a producer (to), or both. Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL and DataFormat DSL as a type safe way of configuring endpoints and data formats in Java. A good practice when configuring options is to use Property Placeholders . Property placeholders provide a few benefits: They help prevent using hardcoded urls, port numbers, sensitive information, and other settings. They allow externalizing the configuration from the code. They help the code to become more flexible and reusable. The following two sections list all the options, firstly for the component followed by the endpoint. 48.4. Component Options The HTTP component supports 40 options, which are listed below. Name Description Default Type cookieStore (producer) 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 cookie shouldn't be stored as we are just bridging (eg acting as a proxy). CookieStore copyHeaders (producer) If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). true boolean lazyStartProducer (producer) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean responsePayloadStreamingThreshold (producer) This threshold in bytes controls whether the response payload should be stored in memory as a byte array or be streaming based. Set this to -1 to always use streaming mode. 8192 int skipRequestHeaders (producer (advanced)) Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false boolean skipResponseHeaders (producer (advanced)) Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false boolean followRedirects (producer (advanced)) Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects. false boolean allowJavaSerializedObject (advanced) Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. false boolean authCachingDisabled (advanced) Disables authentication scheme caching. false boolean automaticRetriesDisabled (advanced) Disables automatic request recovery and re-execution. false boolean autowiredEnabled (advanced) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true boolean clientConnectionManager (advanced) To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. HttpClientConnectionManager connectionsPerRoute (advanced) The maximum number of connections per route. 20 int connectionStateDisabled (advanced) Disables connection state tracking. false boolean connectionTimeToLive (advanced) The time for connection to live, the time unit is millisecond, the default value is always keep alive. long contentCompressionDisabled (advanced) Disables automatic content decompression. false boolean cookieManagementDisabled (advanced) Disables state (cookie) management. false boolean defaultUserAgentDisabled (advanced) Disables the default user agent set by this builder if none has been provided by the user. false boolean httpBinding (advanced) To use a custom HttpBinding to control the mapping between Camel message and HttpClient. HttpBinding httpClientConfigurer (advanced) To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. HttpClientConfigurer httpConfiguration (advanced) To use the shared HttpConfiguration as base configuration. HttpConfiguration httpContext (advanced) To use a custom org.apache.http.protocol.HttpContext when executing requests. HttpContext maxTotalConnections (advanced) The maximum number of connections. 200 int redirectHandlingDisabled (advanced) Disables automatic redirect handling. false boolean headerFilterStrategy (filter) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. HeaderFilterStrategy proxyAuthDomain (proxy) Proxy authentication domain to use. String proxyAuthHost (proxy) Proxy authentication host. String proxyAuthMethod (proxy) Proxy authentication method to use. Enum values: Basic Digest NTLM String proxyAuthNtHost (proxy) Proxy authentication domain (workstation name) to use with NTML. String proxyAuthPassword (proxy) Proxy authentication password. String proxyAuthPort (proxy) Proxy authentication port. Integer proxyAuthUsername (proxy) Proxy authentication username. String sslContextParameters (security) To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.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. SSLContextParameters useGlobalSslContextParameters (security) Enable usage of global SSL context parameters. false boolean x509HostnameVerifier (security) To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. HostnameVerifier connectionRequestTimeout (timeout) The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). -1 int connectTimeout (timeout) Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). -1 int responseTimeout (timeout) Determines the timeout until arrival of a response from the opposite endpoint. A timeout value of zero is interpreted as an infinite timeout. Please note that response timeout may be unsupported by HTTP transports with message multiplexing. 0 Timeout soTimeout (timeout) Determines the default socket timeout value for blocking I/O operations. 3 minutes Timeout 48.5. Endpoint Options The HTTP endpoint is configured using URI syntax: with the following path and query parameters: 48.5.1. Path Parameters (1 parameters) Name Description Default Type httpUri (common) Required The url of the HTTP endpoint to call. URI 48.5.2. Query Parameters (54 parameters) Name Description Default Type disableStreamCache (common) Determines whether or not the raw input stream is cached or not. The Camel consumer (camel-servlet, camel-jetty etc.) will by default cache the input stream to support reading it multiple times to ensure it Camel can retrieve all data from the stream. However you can set this option to true when you for example need to access the raw stream, such as streaming it directly to a file or other persistent store. DefaultHttpBinding will copy the request input stream into a stream cache and put it into message body if this option is false to support reading the stream multiple times. If you use Servlet to bridge/proxy an endpoint then consider enabling this option to improve performance, in case you do not need to read the message payload multiple times. The producer (camel-http) will by default cache the response body stream. If setting this option to true, then the producers will not cache the response body stream but use the response stream as-is (the stream can only be read once) as the message body. false boolean headerFilterStrategy (common (advanced)) To use a custom HeaderFilterStrategy to filter header to and from Camel message. HeaderFilterStrategy bridgeEndpoint (producer) If the option is true, HttpProducer will ignore the Exchange.HTTP_URI header, and use the endpoint's URI for request. You may also set the option throwExceptionOnFailure to be false to let the HttpProducer send all the fault response back. false boolean connectionClose (producer) Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false. false boolean httpMethod (producer) Configure the HTTP method to use. The HttpMethod header cannot override this option if set. Enum values: GET POST PUT DELETE HEAD OPTIONS TRACE PATCH HttpMethods skipRequestHeaders (producer) Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false boolean skipResponseHeaders (producer) Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false boolean throwExceptionOnFailure (producer) 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. true boolean clearExpiredCookies (producer (advanced)) 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. If the component has disabled cookie management then this option is disabled too. true boolean cookieHandler (producer (advanced)) Configure a cookie handler to maintain a HTTP session. CookieHandler cookieStore (producer (advanced)) To use a custom CookieStore. By default the 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 cookie shouldn't be stored as we are just bridging (eg acting as a proxy). If a cookieHandler is set then the cookie store is also forced to be a noop cookie store as cookie handling is then performed by the cookieHandler. CookieStore copyHeaders (producer (advanced)) If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). true boolean customHostHeader (producer (advanced)) To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url. String deleteWithBody (producer (advanced)) Whether the HTTP DELETE should include the message body or not. By default HTTP DELETE do not include any HTTP body. However in some rare cases users may need to be able to include the message body. false boolean followRedirects (producer (advanced)) Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects. false boolean getWithBody (producer (advanced)) Whether the HTTP GET should include the message body or not. By default HTTP GET do not include any HTTP body. However in some rare cases users may need to be able to include the message body. false boolean ignoreResponseBody (producer (advanced)) If this option is true, The http producer won't read response body and cache the input stream. false boolean lazyStartProducer (producer (advanced)) Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false boolean okStatusCodeRange (producer (advanced)) The status codes which are considered a success response. The values are inclusive. Multiple ranges can be defined, separated by comma, e.g. 200-204,209,301-304. Each range must be a single number or from-to with the dash included. 200-299 String preserveHostHeader (producer (advanced)) If the option is true, HttpProducer will set the Host header to the value contained in the current exchange Host header, useful in reverse proxy applications where you want the Host header received by the downstream server to reflect the URL called by the upstream client, this allows applications which use the Host header to generate accurate URL's for a proxied service. false boolean userAgent (producer (advanced)) To set a custom HTTP User-Agent request header. String clientBuilder (advanced) Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint. HttpClientBuilder clientConnectionManager (advanced) To use a custom HttpClientConnectionManager to manage connections. HttpClientConnectionManager connectionsPerRoute (advanced) The maximum number of connections per route. 20 int httpClient (advanced) Sets a custom HttpClient to be used by the producer. HttpClient httpClientConfigurer (advanced) Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc. HttpClientConfigurer httpClientOptions (advanced) To configure the HttpClient using the key/values from the Map. Map httpConnectionOptions (advanced) To configure the connection and the socket using the key/values from the Map. Map httpContext (advanced) To use a custom HttpContext instance. HttpContext maxTotalConnections (advanced) The maximum number of connections. 200 int useSystemProperties (advanced) To use System Properties as fallback for configuration. false boolean proxyAuthDomain (proxy) Proxy authentication domain to use with NTML. String proxyAuthHost (proxy) Proxy authentication host. String proxyAuthMethod (proxy) Proxy authentication method to use. Enum values: Basic Digest NTLM String proxyAuthNtHost (proxy) Proxy authentication domain (workstation name) to use with NTML. String proxyAuthPassword (proxy) Proxy authentication password. String proxyAuthPort (proxy) Proxy authentication port. int proxyAuthScheme (proxy) Proxy authentication scheme to use. Enum values: http https String proxyAuthUsername (proxy) Proxy authentication username. String proxyHost (proxy) Proxy hostname to use. String proxyPort (proxy) Proxy port to use. int authDomain (security) Authentication domain to use with NTML. String authenticationPreemptive (security) If this option is true, camel-http sends preemptive basic authentication to the server. false boolean authHost (security) Authentication host to use with NTML. String authMethod (security) Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM. String authMethodPriority (security) Which authentication method to prioritize to use, either as Basic, Digest or NTLM. Enum values: Basic Digest NTLM String authPassword (security) Authentication password. String authUsername (security) Authentication username. String oauth2ClientId (security) OAuth2 client id. String oauth2ClientSecret (security) OAuth2 client secret. String oauth2Scope (security) OAuth2 scope. String oauth2TokenEndpoint (security) OAuth2 Token endpoint. String sslContextParameters (security) To configure security using SSLContextParameters. 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. SSLContextParameters x509HostnameVerifier (security) To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. HostnameVerifier 48.6. Message Headers Name Description Default Type Content-Encoding (producer) Constant: CONTENT_ENCODING The HTTP content encoding. Is set on both the IN and OUT message to provide a content encoding, such as gzip. String CamelHttpResponseCode (producer) Constant: HTTP_RESPONSE_CODE The HTTP response code from the external server. Is 200 for OK. int CamelHttpResponseText (producer) Constant: HTTP_RESPONSE_TEXT The HTTP response text from the external server. String CamelHttpQuery (producer) Constant: HTTP_QUERY URI parameters. Will override existing URI parameters set directly on the endpoint. String CamelHttpProtocolVersion (producer) Constant: HTTP_PROTOCOL_VERSION The version of the http protocol used. String Host (producer) Constant: HTTP_HEADER_HOST The target host. String CamelRestHttpUri (producer) Constant: REST_HTTP_URI The rest http URI. String CamelHttpUri (producer) Constant: HTTP_URI URI to call. Will override existing URI set directly on the endpoint. This uri is the uri of the http server to call. Its not the same as the Camel endpoint uri, where you can configure endpoint options such as security etc. This header does not support that, its only the uri of the http server. String CamelHttpPath (producer) Constant: HTTP_PATH Request URI's path, the header will be used to build the request URI with the HTTP_URI. String CamelRestHttpQuery (producer) Constant: REST_HTTP_QUERY The rest http query. String CamelHttpRawQuery (producer) Constant: HTTP_RAW_QUERY The http raw query. String CamelHttpMethod (producer) Constant: HTTP_METHOD The http method to use. Enum values: GET PATCH POST PUT DELETE HEAD OPTIONS TRACE HttpMethods CamelHttpCharacterEncoding (producer) Constant: HTTP_CHARACTER_ENCODING The character encoding. String Content-Type (producer) Constant: CONTENT_TYPE The HTTP content type. Is set on both the IN and OUT message to provide a content type, such as text/html. String Note Avoid creating your own HTTP server instances in a Camel Spring Boot application by using either of the cxf-rt-transports-jetty , cxf-rt-transports-netty-server , cxf-rt-transports-undertow libraries. It is recommended to use the Spring Boot embedded HTTP server stack which is created when you use the spring-boot-starter-web , cxf-spring-boot-starter-jaxrs , or cxf-spring-boot-starter-jaxws dependencies. 48.7. 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. 48.8. Using System Properties When setting useSystemProperties to true, the HTTP Client will look for the following System Properties and it will use it: ssl.TrustManagerFactory.algorithm javax.net .ssl.trustStoreType javax.net .ssl.trustStore javax.net .ssl.trustStoreProvider javax.net .ssl.trustStorePassword java.home ssl.KeyManagerFactory.algorithm javax.net .ssl.keyStoreType javax.net .ssl.keyStore javax.net .ssl.keyStoreProvider javax.net .ssl.keyStorePassword http.proxyHost http.proxyPort http.nonProxyHosts http.keepAlive http.maxConnections 48.9. Response code Camel will handle according to the HTTP response code: Response code is in the range 100..299, Camel regards it as a success response. Response code is in the range 300..399, Camel regards it as a redirection response and will throw a HttpOperationFailedException with the information. Response code is 400+, Camel regards it as an external server failure and will throw a HttpOperationFailedException with the information. 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. 48.10. Exceptions HttpOperationFailedException exception contains the following information: The HTTP status code The HTTP status line (text of the status code) Redirect location, if server returned a redirect Response body as a java.lang.String , if server provided a body as response 48.11. Which HTTP method will be used The following algorithm is used to determine what HTTP method should be used: 1. Use method provided as endpoint configuration ( httpMethod ). 2. Use method provided in header ( Exchange.HTTP_METHOD ). 3. GET if query string is provided in header. 4. GET if endpoint is configured with a query string. 5. POST if there is data to send (body is not null ). 6. GET otherwise. 48.12. How to get access to HttpServletRequest and HttpServletResponse You can get access to these two using the Camel type converter system using HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class); HttpServletResponse response = exchange.getIn().getBody(HttpServletResponse.class); Note You can get the request and response not just from the processor after the camel-jetty or camel-cxf endpoint. 48.13. Configuring URI to call You can set the HTTP producer's URI directly form the endpoint URI. In the route below, Camel will call out to the external server, oldhost , using HTTP. from("direct:start") .to("http://oldhost"); And the equivalent Spring sample: <camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <to uri="http://oldhost"/> </route> </camelContext> You can override the HTTP endpoint URI by adding a header with the key, Exchange.HTTP_URI , on the message. from("direct:start") .setHeader(Exchange.HTTP_URI, constant("http://newhost")) .to("http://oldhost"); In the sample above Camel will call the http://newhost/ despite the endpoint is configured with http://oldhost/ . If the http endpoint is working in bridge mode, it will ignore the message header of Exchange.HTTP_URI . 48.14. Configuring URI Parameters The http producer supports URI parameters to be sent to the HTTP server. The URI parameters can either be set directly on the endpoint URI or as a header with the key Exchange.HTTP_QUERY on the message. from("direct:start") .to("http://oldhost?order=123&detail=short"); Or options provided in a header: from("direct:start") .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short")) .to("http://oldhost"); 48.15. How to set the http method (GET/PATCH/POST/PUT/DELETE/HEAD/OPTIONS/TRACE) to the HTTP producer The HTTP component provides a way to set the HTTP request method by setting the message header. Here is an example: from("direct:start") .setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http.HttpMethods.POST)) .to("http://www.google.com") .to("mock:results"); The method can be written a bit shorter using the string constants: .setHeader("CamelHttpMethod", constant("POST")) And the equivalent Spring sample: <camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <setHeader name="CamelHttpMethod"> <constant>POST</constant> </setHeader> <to uri="http://www.google.com"/> <to uri="mock:results"/> </route> </camelContext> 48.16. Using client timeout - SO_TIMEOUT See the HttpSOTimeoutTest unit test. 48.17. Configuring a Proxy The HTTP component provides a way to configure a proxy. from("direct:start") .to("http://oldhost?proxyAuthHost=www.myproxy.com&proxyAuthPort=80"); There is also support for proxy authentication via the proxyAuthUsername and proxyAuthPassword options. 48.17.1. Using proxy settings outside of URI To avoid System properties conflicts, you can set proxy configuration only from the CamelContext or URI. Java DSL : context.getGlobalOptions().put("http.proxyHost", "172.168.18.9"); context.getGlobalOptions().put("http.proxyPort", "8080"); Spring XML <camelContext> <properties> <property key="http.proxyHost" value="172.168.18.9"/> <property key="http.proxyPort" value="8080"/> </properties> </camelContext> Camel will first set the settings from Java System or CamelContext Properties and then the endpoint proxy options if provided. So you can override the system properties with the endpoint options. There is also a http.proxyScheme property you can set to explicit configure the scheme to use. 48.18. Configuring charset If you are using POST to send data you can configure the charset using the Exchange property: exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1"); 48.18.1. Sample with scheduled poll This sample polls the Google homepage every 10 seconds and write the page to the file message.html : from("timer://foo?fixedRate=true&delay=0&period=10000") .to("http://www.google.com") .setHeader(FileComponent.HEADER_FILE_NAME, "message.html") .to("file:target/google"); 48.18.2. URI Parameters from the endpoint URI In this sample we have the complete URI endpoint that is just what you would have typed in a web browser. Multiple URI parameters can of course be set using the & character as separator, just as you would in the web browser. Camel does no tricks here. // we query for Camel at the Google page template.sendBody("http://www.google.com/search?q=Camel", null); 48.18.3. URI Parameters from the Message 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("http://www.google.com/search", null, headers); In the header value above notice that it should not be prefixed with ? and you can separate parameters as usual with the & char. 48.18.4. Getting the Response Code You can get the HTTP response code from the HTTP component by getting the value from the Out message header with Exchange.HTTP_RESPONSE_CODE . Exchange exchange = template.send("http://www.google.com/search", new Processor() { public void process(Exchange exchange) throws Exception { 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); 48.19. Disabling Cookies To disable cookies you can set the HTTP Client to ignore cookies by adding the following URI option: 48.20. Basic auth with the streaming message body In order to avoid the NonRepeatableRequestException , you need to do the Preemptive Basic Authentication by adding the option: authenticationPreemptive=true 48.21. Advanced Usage If you need more control over the HTTP producer you should use the HttpComponent where you can set various classes to give you custom behavior. 48.21.1. Setting up SSL for HTTP Client Using the JSSE Configuration Utility The HTTP component supports SSL/TLS configuration through the Camel JSSE Configuration Utility . This utility greatly decreases the amount of component specific code you need to write and is configurable at the endpoint and component levels. The following examples demonstrate how to use the utility with the HTTP component. Programmatic configuration of the component KeyStoreParameters ksp = new KeyStoreParameters(); ksp.setResource("file:/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("https", HttpComponent.class); httpComponent.setSslContextParameters(scp); Spring DSL based configuration of endpoint <camel:sslContextParameters id="sslContextParameters"> <camel:keyManagers keyPassword="keyPassword"> <camel:keyStore resource="file:/users/home/server/keystore.jks" password="keystorePassword"/> </camel:keyManagers> </camel:sslContextParameters> <to uri="https://127.0.0.1/mail/?sslContextParameters=#sslContextParameters"/> Configuring Apache HTTP Client Directly Basically camel-http component is built on the top of Apache HttpClient . Please refer to SSL/TLS customization for details or have a look into the org.apache.camel.component.http.HttpsServerTestSupport unit test base class. You can also implement a custom org.apache.camel.component.http.HttpClientConfigurer to do some configuration on the http client if you need full control of it. However if you just want to specify the keystore and truststore you can do this with Apache HTTP HttpClientConfigurer , for example: 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: HttpComponent httpComponent = getContext().getComponent("http", 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: <bean id="myHttpClientConfigurer" class="my.https.HttpClientConfigurer"> </bean> <to uri="https://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/> As long as you implement the HttpClientConfigurer and configure your keystore and truststore as described above, it will work fine. Using HTTPS to authenticate gotchas An end user reported that he had problem with authenticating with HTTPS. The problem was eventually resolved by providing a custom configured org.apache.http.protocol.HttpContext : Create a (Spring) factory for HttpContexts. 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 } Declare an HttpContext in the Spring application context file. <bean id="myHttpContext" factory-bean="httpContextFactory" factory-method="getObject"/> Reference the context in the http URL: <to uri="https://myhostname.com:443/myURL?httpContext=myHttpContext"/> Using different SSLContextParameters The HTTP component only support one instance of org.apache.camel.support.jsse.SSLContextParameters per component. If you need to use 2 or more different instances, then you need to setup multiple HTTP components as shown below. Where we have 2 components, each using their own instance of sslContextParameters property. <bean id="http-foo" class="org.apache.camel.component.http.HttpComponent"> <property name="sslContextParameters" ref="sslContextParams1"/> <property name="x509HostnameVerifier" ref="hostnameVerifier"/> </bean> <bean id="http-bar" class="org.apache.camel.component.http.HttpComponent"> <property name="sslContextParameters" ref="sslContextParams2"/> <property name="x509HostnameVerifier" ref="hostnameVerifier"/> </bean> For more information about how to configure SSL see http-ssl example. 48.22. Spring Boot Auto-Configuration The component supports 41 options, which are listed below. Name Description Default Type camel.component.http.allow-java-serialized-object Whether to allow java serialization when a request uses context-type=application/x-java-serialized-object. This is by default turned off. If you enable this then be aware that Java will deserialize the incoming data from the request to Java and that can be a potential security risk. false Boolean camel.component.http.auth-caching-disabled Disables authentication scheme caching. false Boolean camel.component.http.automatic-retries-disabled Disables automatic request recovery and re-execution. false Boolean camel.component.http.autowired-enabled Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. true Boolean camel.component.http.client-connection-manager To use a custom and shared HttpClientConnectionManager to manage connections. If this has been configured then this is always used for all endpoints created by this component. The option is a org.apache.http.conn.HttpClientConnectionManager type. HttpClientConnectionManager camel.component.http.connect-timeout Determines the timeout in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). -1 Integer camel.component.http.connection-request-timeout The timeout in milliseconds used when requesting a connection from the connection manager. A timeout value of zero is interpreted as an infinite timeout. A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default). -1 Integer camel.component.http.connection-state-disabled Disables connection state tracking. false Boolean camel.component.http.connection-time-to-live The time for connection to live, the time unit is millisecond, the default value is always keep alive. Long camel.component.http.connections-per-route The maximum number of connections per route. 20 Integer camel.component.http.content-compression-disabled Disables automatic content decompression. false Boolean camel.component.http.cookie-management-disabled Disables state (cookie) management. false Boolean camel.component.http.cookie-store 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 cookie shouldn't be stored as we are just bridging (eg acting as a proxy). The option is a org.apache.http.client.CookieStore type. CookieStore camel.component.http.copy-headers If this option is true then IN exchange headers will be copied to OUT exchange headers according to copy strategy. Setting this to false, allows to only include the headers from the HTTP response (not propagating IN headers). true Boolean camel.component.http.default-user-agent-disabled Disables the default user agent set by this builder if none has been provided by the user. false Boolean camel.component.http.enabled Whether to enable auto configuration of the http component. This is enabled by default. Boolean camel.component.http.follow-redirects Whether to the HTTP request should follow redirects. By default the HTTP request does not follow redirects. false Boolean camel.component.http.header-filter-strategy To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. The option is a org.apache.camel.spi.HeaderFilterStrategy type. HeaderFilterStrategy camel.component.http.http-binding To use a custom HttpBinding to control the mapping between Camel message and HttpClient. The option is a org.apache.camel.http.common.HttpBinding type. HttpBinding camel.component.http.http-client-configurer To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used. The option is a org.apache.camel.component.http.HttpClientConfigurer type. HttpClientConfigurer camel.component.http.http-configuration To use the shared HttpConfiguration as base configuration. The option is a org.apache.camel.http.common.HttpConfiguration type. HttpConfiguration camel.component.http.http-context To use a custom org.apache.http.protocol.HttpContext when executing requests. The option is a org.apache.http.protocol.HttpContext type. HttpContext camel.component.http.lazy-start-producer Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. false Boolean camel.component.http.max-total-connections The maximum number of connections. 200 Integer camel.component.http.proxy-auth-domain Proxy authentication domain to use. String camel.component.http.proxy-auth-host Proxy authentication host. String camel.component.http.proxy-auth-method Proxy authentication method to use. String camel.component.http.proxy-auth-nt-host Proxy authentication domain (workstation name) to use with NTML. String camel.component.http.proxy-auth-password Proxy authentication password. String camel.component.http.proxy-auth-port Proxy authentication port. Integer camel.component.http.proxy-auth-scheme Proxy authentication protocol scheme. String camel.component.http.proxy-auth-username Proxy authentication username. String camel.component.http.redirect-handling-disabled Disables automatic redirect handling. false Boolean camel.component.http.response-payload-streaming-threshold This threshold in bytes controls whether the response payload should be stored in memory as a byte array or be streaming based. Set this to -1 to always use streaming mode. 8192 Integer camel.component.http.response-timeout Determines the timeout until arrival of a response from the opposite endpoint. A timeout value of zero is interpreted as an infinite timeout. Please note that response timeout may be unsupported by HTTP transports with message multiplexing. The option is a org.apache.hc.core5.util.Timeout type. Timeout camel.component.http.skip-request-headers Whether to skip mapping all the Camel headers as HTTP request headers. If there are no data from Camel headers needed to be included in the HTTP request then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false Boolean camel.component.http.skip-response-headers Whether to skip mapping all the HTTP response headers to Camel headers. If there are no data needed from HTTP headers then this can avoid parsing overhead with many object allocations for the JVM garbage collector. false Boolean camel.component.http.so-timeout Determines the default socket timeout value for blocking I/O operations. The option is a org.apache.hc.core5.util.Timeout type. Timeout camel.component.http.ssl-context-parameters To configure security using SSLContextParameters. Important: Only one instance of org.apache.camel.support.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. The option is a org.apache.camel.support.jsse.SSLContextParameters type. SSLContextParameters camel.component.http.use-global-ssl-context-parameters Enable usage of global SSL context parameters. false Boolean camel.component.http.x509-hostname-verifier To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier. The option is a javax.net.ssl.HostnameVerifier type. HostnameVerifier
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-http-starter</artifactId> </dependency> http:hostname[:port][/resourceUri][?options] http://httpUri HttpServletRequest request = exchange.getIn().getBody(HttpServletRequest.class); HttpServletResponse response = exchange.getIn().getBody(HttpServletResponse.class); from("direct:start") .to("http://oldhost"); <camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <to uri="http://oldhost"/> </route> </camelContext> from("direct:start") .setHeader(Exchange.HTTP_URI, constant("http://newhost")) .to("http://oldhost"); from("direct:start") .to("http://oldhost?order=123&detail=short"); from("direct:start") .setHeader(Exchange.HTTP_QUERY, constant("order=123&detail=short")) .to("http://oldhost"); from("direct:start") .setHeader(Exchange.HTTP_METHOD, constant(org.apache.camel.component.http.HttpMethods.POST)) .to("http://www.google.com") .to("mock:results"); .setHeader("CamelHttpMethod", constant("POST")) <camelContext xmlns="http://activemq.apache.org/camel/schema/spring"> <route> <from uri="direct:start"/> <setHeader name="CamelHttpMethod"> <constant>POST</constant> </setHeader> <to uri="http://www.google.com"/> <to uri="mock:results"/> </route> </camelContext> from("direct:start") .to("http://oldhost?proxyAuthHost=www.myproxy.com&proxyAuthPort=80"); context.getGlobalOptions().put("http.proxyHost", "172.168.18.9"); context.getGlobalOptions().put("http.proxyPort", "8080"); <camelContext> <properties> <property key="http.proxyHost" value="172.168.18.9"/> <property key="http.proxyPort" value="8080"/> </properties> </camelContext> exchange.setProperty(Exchange.CHARSET_NAME, "ISO-8859-1"); from("timer://foo?fixedRate=true&delay=0&period=10000") .to("http://www.google.com") .setHeader(FileComponent.HEADER_FILE_NAME, "message.html") .to("file:target/google"); // we query for Camel at the Google page template.sendBody("http://www.google.com/search?q=Camel", null); 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("http://www.google.com/search", null, headers); Exchange exchange = template.send("http://www.google.com/search", new Processor() { public void process(Exchange exchange) throws Exception { 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); httpClient.cookieSpec=ignore KeyStoreParameters ksp = new KeyStoreParameters(); ksp.setResource("file:/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("https", HttpComponent.class); httpComponent.setSslContextParameters(scp); <camel:sslContextParameters id="sslContextParameters"> <camel:keyManagers keyPassword="keyPassword"> <camel:keyStore resource="file:/users/home/server/keystore.jks" password="keystorePassword"/> </camel:keyManagers> </camel:sslContextParameters> <to uri="https://127.0.0.1/mail/?sslContextParameters=#sslContextParameters"/> KeyStore keystore = ...; KeyStore truststore = ...; SchemeRegistry registry = new SchemeRegistry(); registry.register(new Scheme("https", 443, new SSLSocketFactory(keystore, "mypassword", truststore))); HttpComponent httpComponent = getContext().getComponent("http", HttpComponent.class); httpComponent.setHttpClientConfigurer(new MyHttpClientConfigurer()); <bean id="myHttpClientConfigurer" class="my.https.HttpClientConfigurer"> </bean> <to uri="https://myhostname.com:443/myURL?httpClientConfigurer=myHttpClientConfigurer"/> 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 } <bean id="myHttpContext" factory-bean="httpContextFactory" factory-method="getObject"/> <to uri="https://myhostname.com:443/myURL?httpContext=myHttpContext"/> <bean id="http-foo" class="org.apache.camel.component.http.HttpComponent"> <property name="sslContextParameters" ref="sslContextParams1"/> <property name="x509HostnameVerifier" ref="hostnameVerifier"/> </bean> <bean id="http-bar" class="org.apache.camel.component.http.HttpComponent"> <property name="sslContextParameters" ref="sslContextParams2"/> <property name="x509HostnameVerifier" ref="hostnameVerifier"/> </bean>