Chapter 146. Vert.x HTTP Client Since Camel 3.5 Only producer is supported The Vert.x HTTP component provides the capability to produce messages to HTTP endpoints via the Vert.x Web Client . 146.1. Dependencies When using vertx-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-vertx-http-starter</artifactId> </dependency> 146.2. URI format 146.3. Configuring Options Camel components are configured on two separate levels: component level endpoint level 146.3.1. Configuring component options The component level is the highest level which holds general and common configurations that are inherited by the endpoints. 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. Configuring components can be done with the Component DSL , in a configuration file (application.properties|yaml), or directly with Java code. 146.3.2. Configuring endpoint options Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for 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 , which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse. The following two sections lists all the options, firstly for the component followed by the endpoint. 146.4. Component Options The Vert.x HTTP Client component supports 19 options, which are listed below. Name Description Default Type 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 responsePayloadAsByteArray (producer) Whether the response body should be byte or as io.vertx.core.buffer.Buffer. true boolean allowJavaSerializedObject (advanced) Whether to allow java serialization when a request has the Content-Type application/x-java-serialized-object This is disabled by default. If you enable this, be aware that Java will deserialize the incoming data from the request. This can be a potential security risk. 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 vertx (advanced) To use an existing vertx instead of creating a new instance. Vertx vertxHttpBinding (advanced) A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. VertxHttpBinding vertxOptions (advanced) To provide a custom set of vertx options for configuring vertx. VertxOptions webClientOptions (advanced) To provide a custom set of options for configuring vertx web client. WebClientOptions headerFilterStrategy (filter) To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. HeaderFilterStrategy proxyHost (proxy) The proxy server host address. String proxyPassword (proxy) The proxy server password if authentication is required. String proxyPort (proxy) The proxy server port. Integer proxyType (proxy) The proxy server type. Enum values: HTTP SOCKS4 SOCKS5 ProxyType proxyUsername (proxy) The proxy server username if authentication is required. String basicAuthPassword (security) The password to use for basic authentication. String basicAuthUsername (security) The user name to use for basic authentication. String bearerToken (security) The bearer token to use for bearer token authentication. String sslContextParameters (security) To configure security using SSLContextParameters. SSLContextParameters useGlobalSslContextParameters (security) Enable usage of global SSL context parameters. false boolean 146.5. Endpoint Options The Vert.x HTTP Client endpoint is configured using URI syntax: with the following path and query parameters: 146.5.1. Path Parameters (1 parameters) Name Description Default Type httpUri (producer) Required The HTTP URI to connect to. URI 146.5.2. Query Parameters (23 parameters) Name Description Default Type connectTimeout (producer) The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout. 60000 int cookieStore (producer) A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used. InMemoryCookieStore CookieStore headerFilterStrategy (producer) A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message. VertxHttpHeaderFilterStrategy HeaderFilterStrategy httpMethod (producer) The HTTP method to use. The HttpMethod header cannot override this option if set. HttpMethod okStatusCodeRange (producer) 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 responsePayloadAsByteArray (producer) Whether the response body should be byte or as io.vertx.core.buffer.Buffer. true boolean sessionManagement (producer) Enables session management via WebClientSession. By default the client is configured to use an in-memory CookieStore. The cookieStore option can be used to override this. false boolean throwExceptionOnFailure (producer) Disable throwing HttpOperationFailedException in case of failed responses from the remote server. true boolean timeout (producer) The amount of time in milliseconds after which if the request does not return any data within the timeout period a TimeoutException fails the request. Setting zero or a negative value disables the timeout. -1 long transferException (producer) If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was sent back serialized in the response as a application/x-java-serialized-object content type. On the producer side the exception will be deserialized and thrown as is, instead of HttpOperationFailedException. The caused exception is required to be serialized. This is by default turned off. If you enable this then be aware that Camel will deserialize the incoming data from the request to a Java object, which can be a potential security risk. false boolean useCompression (producer) Set whether compression is enabled to handled compressed (E.g gzipped) responses. false boolean vertxHttpBinding (producer) A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. VertxHttpBinding webClientOptions (producer) Sets customized options for configuring the Vert.x WebClient. WebClientOptions 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 proxyHost (proxy) The proxy server host address. String proxyPassword (proxy) The proxy server password if authentication is required. String proxyPort (proxy) The proxy server port. Integer proxyType (proxy) The proxy server type. Enum values: HTTP SOCKS4 SOCKS5 ProxyType proxyUsername (proxy) The proxy server username if authentication is required. String basicAuthPassword (security) The password to use for basic authentication. String basicAuthUsername (security) The user name to use for basic authentication. String bearerToken (security) The bearer token to use for bearer token authentication. String sslContextParameters (security) To configure security using SSLContextParameters. SSLContextParameters 146.6. Message Headers The Vert.x HTTP Client component supports 8 message header(s), which is/are listed below: Name Description Default Type CamelHttpMethod (producer) Constant: HTTP_METHOD The http method. HttpMethod CamelHttpResponseCode (producer) Constant: HTTP_RESPONSE_CODE The HTTP response code from the external server. Integer CamelHttpResponseText (producer) Constant: HTTP_RESPONSE_TEXT The HTTP response text from the external server. 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 CamelHttpQuery (producer) Constant: HTTP_QUERY URI parameters. Will override existing URI parameters set directly on the endpoint. String CamelHttpUri (producer) Constant: HTTP_URI URI to call. Will override the 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 Content-Encoding (producer) Constant: CONTENT_ENCODING The HTTP content encoding. Is set to provide a content encoding, such as gzip. String 146.7. Usage The following example shows how to send a request to an HTTP endpoint. You can override the URI configured on the vertx-http producer via headers Exchange.HTTP_URI and Exchange.HTTP_PATH . from("direct:start") .to("vertx-http:https://camel.apache.org"); 146.8. URI Parameters The vertx-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. 146.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. 146.10. 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. 146.11. 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 146.12. HTTP method The following algorithm determines the HTTP method to be used: Use method provided as endpoint configuration ( httpMethod ). Use method provided in header ( Exchange.HTTP_METHOD ). GET if query string is provided in header. GET if endpoint is configured with a query string. POST if there is data to send (body is not null ). GET otherwise. 146.13. HTTP form parameters You can send HTTP form parameters in one of two ways. Set the Exchange.CONTENT_TYPE header to the value application/x-www-form-urlencoded and ensure the message body is a String formatted as form variables. For example, param1=value1&param2=value2 . Set the message body as a MultiMap which allows you to configure form parameter names and values. 146.14. Multipart form data You can upload text or binary files by setting the message body as a MultipartForm . 146.15. Customizing Vert.x Web Client options When finer control of the Vert.x Web Client configuration is required, you can bind a custom WebClientOptions instance to the registry. WebClientOptions options = new WebClientOptions().setMaxRedirects(5) .setIdleTimeout(10) .setConnectTimeout(3); camelContext.getRegistry.bind("clientOptions", options); Then reference the options on the vertx-http producer. from("direct:start") .to("vertx-http:http://localhost:8080?webClientOptions=#clientOptions") 146.15.1. SSL The Vert.x HTTP component supports SSL/TLS configuration through the Camel JSSE Configuration Utility . It is also possible to configure SSL options by providing a custom WebClientOptions . 146.16. Session Management Session management can be enabled via the sessionManagement URI option. When enabled, an in-memory cookie store is used to track cookies. This can be overridden by providing a custom CookieStore via the cookieStore URI option. 146.17. Spring Boot Auto-Configuration The component supports 20 options, which are listed below. Name Description Default Type camel.component.vertx-http.allow-java-serialized-object Whether to allow java serialization when a request has the Content-Type application/x-java-serialized-object This is disabled by default. If you enable this, be aware that Java will deserialize the incoming data from the request. This can be a potential security risk. false Boolean camel.component.vertx-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.vertx-http.basic-auth-password The password to use for basic authentication. String camel.component.vertx-http.basic-auth-username The user name to use for basic authentication. String camel.component.vertx-http.bearer-token The bearer token to use for bearer token authentication. String camel.component.vertx-http.enabled Whether to enable auto configuration of the vertx-http component. This is enabled by default. Boolean camel.component.vertx-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.vertx-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.vertx-http.proxy-host The proxy server host address. String camel.component.vertx-http.proxy-password The proxy server password if authentication is required. String camel.component.vertx-http.proxy-port The proxy server port. Integer camel.component.vertx-http.proxy-type The proxy server type. ProxyType camel.component.vertx-http.proxy-username The proxy server username if authentication is required. String camel.component.vertx-http.response-payload-as-byte-array Whether the response body should be byte or as io.vertx.core.buffer.Buffer. true Boolean camel.component.vertx-http.ssl-context-parameters To configure security using SSLContextParameters. The option is a org.apache.camel.support.jsse.SSLContextParameters type. SSLContextParameters camel.component.vertx-http.use-global-ssl-context-parameters Enable usage of global SSL context parameters. false Boolean camel.component.vertx-http.vertx To use an existing vertx instead of creating a new instance. The option is a io.vertx.core.Vertx type. Vertx camel.component.vertx-http.vertx-http-binding A custom VertxHttpBinding which can control how to bind between Vert.x and Camel. The option is a org.apache.camel.component.vertx.http.VertxHttpBinding type. VertxHttpBinding camel.component.vertx-http.vertx-options To provide a custom set of vertx options for configuring vertx. The option is a io.vertx.core.VertxOptions type. VertxOptions camel.component.vertx-http.web-client-options To provide a custom set of options for configuring vertx web client. The option is a io.vertx.ext.web.client.WebClientOptions type. WebClientOptions

Commands:
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-vertx-http-starter</artifactId> </dependency>
vertx-http:hostname[:port][/resourceUri][?options]
vertx-http:httpUri
from("direct:start") .to("vertx-http:https://camel.apache.org");
WebClientOptions options = new WebClientOptions().setMaxRedirects(5) .setIdleTimeout(10) .setConnectTimeout(3); camelContext.getRegistry.bind("clientOptions", options);
from("direct:start") .to("vertx-http:http://localhost:8080?webClientOptions=#clientOptions")