Vert.x HTTP Client

Send requests to external HTTP servers using Vert.x

Metadata

Property	Value
Scheme	`vertx-http`
Support Level	Stable
Labels	http
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-vertx-http</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`httpUri`	string	✓		The HTTP URI to connect to
`bridgeEndpoint`	boolean		`false`	If the option is true, the Exchange.HTTP_URI header will be ignored and the endpoint URI will be used for the HTTP request. You may also set option throwExceptionOnFailure to false to return the fault response back to the client.
`connectTimeout`	integer		`60000`	The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.
`cookieStore`	object		`InMemoryCookieStore`	A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used
`headerFilterStrategy`	object		`VertxHttpHeaderFilterStrategy`	A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.
`httpMethod`	enum			The HTTP method to use. The HttpMethod header cannot override this option if set
`multipartUpload`	boolean		`false`	Whether to force using multipart/form-data for easy file uploads. This is only to be used for uploading the message body as a single entity form-data. For uploading multiple entries then use io.vertx.ext.web.multipart.MultipartForm to build the form.
`multipartUploadName`	string		`data`	The name of the multipart/form-data when multipartUpload is enabled.
`okStatusCodeRange`	string		`200-299`	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
`responsePayloadAsByteArray`	boolean		`true`	Whether the response body should be byte or as io.vertx.core.buffer.Buffer
`sessionManagement`	boolean		`false`	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
`throwExceptionOnFailure`	boolean		`true`	Disable throwing HttpOperationFailedException in case of failed responses from the remote server
`timeout`	integer		`-1`	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.
`tracingPolicy`	enum			The tracing policy used by the HTTP client when integrating with observability frameworks such as OpenTelemetry. If not specified the HTTP client applies a default tracing policy of PROPAGATE.
`transferException`	boolean		`false`	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.
`useCompression`	boolean		`false`	Set whether compression is enabled to handled compressed (E.g gzipped) responses
`vertxHttpBinding`	object			A custom VertxHttpBinding which can control how to bind between Vert.x and Camel.
`webClientOptions`	object			Sets customized options for configuring the Vert.x WebClient
`lazyStartProducer`	boolean		`false`	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.
`proxyHost`	string			The proxy server host address
`proxyPassword`	string			The proxy server password if authentication is required
`proxyPort`	integer			The proxy server port
`proxyType`	enum			The proxy server type
`proxyUsername`	string			The proxy server username if authentication is required
`basicAuthPassword`	string			The password to use for basic authentication
`basicAuthUsername`	string			The user name to use for basic authentication
`bearerToken`	string			The bearer token to use for bearer token authentication
`deserializationFilter`	string			Sets an ObjectInputFilter pattern (jdk.serialFilter syntax) applied when deserializing Java objects from HTTP responses with Content-Type application/x-java-serialized-object. This is used when transferException is enabled (or when allowJavaSerializedObject is enabled on the component) and the remote side returns a serialized payload. When not set, the filter configured via the JVM system property jdk.serialFilter is used when present; otherwise a conservative default filter allowing java., javax. and org.apache.camel. packages is applied.
`sslContextParameters`	object			To configure security using SSLContextParameters