camel-vertx-http-kafka-connector sink configuration

Connector Description: Send requests to external HTTP servers using Vert.x

When using camel-vertx-http-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-vertx-http-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this Sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.vertxhttp.CamelVertxhttpSinkConnector

The camel-vertx-http sink connector supports 42 options, which are listed below.

Name Description Default Required Priority

camel.sink.path.httpUri

The HTTP URI to connect to

null

true

HIGH

camel.sink.endpoint.connectTimeout

The amount of time in milliseconds until a connection is established. A timeout value of zero is interpreted as an infinite timeout.

60000

false

MEDIUM

camel.sink.endpoint.cookieStore

A custom CookieStore to use when session management is enabled. If this option is not set then an in-memory CookieStore is used

"InMemoryCookieStore"

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

A custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

"VertxHttpHeaderFilterStrategy"

false

MEDIUM

camel.sink.endpoint.httpMethod

The HTTP method to use. The HttpMethod header cannot override this option if set One of: [OPTIONS] [GET] [HEAD] [POST] [PUT] [DELETE] [TRACE] [CONNECT] [PATCH] [OTHER]

null

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

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

false

MEDIUM

camel.sink.endpoint.okStatusCodeRange

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"

false

MEDIUM

camel.sink.endpoint.responsePayloadAsByteArray

Whether the response body should be byte or as io.vertx.core.buffer.Buffer

true

false

MEDIUM

camel.sink.endpoint.sessionManagement

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

false

MEDIUM

camel.sink.endpoint.throwExceptionOnFailure

Disable throwing HttpOperationFailedException in case of failed responses from the remote server

true

false

MEDIUM

camel.sink.endpoint.timeout

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.

-1L

false

MEDIUM

camel.sink.endpoint.transferException

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

false

MEDIUM

camel.sink.endpoint.useCompression

Set whether compression is enabled to handled compressed (E.g gzipped) responses

false

false

MEDIUM

camel.sink.endpoint.vertxHttpBinding

A custom VertxHttpBinding which can control how to bind between Vert.x and Camel.

null

false

MEDIUM

camel.sink.endpoint.webClientOptions

Sets customized options for configuring the Vert.x WebClient

null

false

MEDIUM

camel.sink.endpoint.proxyHost

The proxy server host address

null

false

MEDIUM

camel.sink.endpoint.proxyPassword

The proxy server password if authentication is required

null

false

MEDIUM

camel.sink.endpoint.proxyPort

The proxy server port

null

false

MEDIUM

camel.sink.endpoint.proxyType

The proxy server type One of: [HTTP] [SOCKS4] [SOCKS5]

null

false

MEDIUM

camel.sink.endpoint.proxyUsername

The proxy server username if authentication is required

null

false

MEDIUM

camel.sink.endpoint.basicAuthPassword

The password to use for basic authentication

null

false

MEDIUM

camel.sink.endpoint.basicAuthUsername

The user name to use for basic authentication

null

false

MEDIUM

camel.sink.endpoint.bearerToken

The bearer token to use for bearer token authentication

null

false

MEDIUM

camel.sink.endpoint.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.vertx-http.lazyStartProducer

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

false

MEDIUM

camel.component.vertx-http.responsePayloadAsByte Array

Whether the response body should be byte or as io.vertx.core.buffer.Buffer

true

false

MEDIUM

camel.component.vertx-http.allowJavaSerialized 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

false

MEDIUM

camel.component.vertx-http.autowiredEnabled

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

false

MEDIUM

camel.component.vertx-http.vertx

To use an existing vertx instead of creating a new instance

null

false

MEDIUM

camel.component.vertx-http.vertxHttpBinding

A custom VertxHttpBinding which can control how to bind between Vert.x and Camel

null

false

MEDIUM

camel.component.vertx-http.vertxOptions

To provide a custom set of vertx options for configuring vertx

null

false

MEDIUM

camel.component.vertx-http.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter header to and from Camel message.

null

false

MEDIUM

camel.component.vertx-http.proxyHost

The proxy server host address

null

false

MEDIUM

camel.component.vertx-http.proxyPassword

The proxy server password if authentication is required

null

false

MEDIUM

camel.component.vertx-http.proxyPort

The proxy server port

null

false

MEDIUM

camel.component.vertx-http.proxyType

The proxy server type One of: [HTTP] [SOCKS4] [SOCKS5]

null

false

MEDIUM

camel.component.vertx-http.proxyUsername

The proxy server username if authentication is required

null

false

MEDIUM

camel.component.vertx-http.basicAuthPassword

The password to use for basic authentication

null

false

MEDIUM

camel.component.vertx-http.basicAuthUsername

The user name to use for basic authentication

null

false

MEDIUM

camel.component.vertx-http.bearerToken

The bearer token to use for bearer token authentication

null

false

MEDIUM

camel.component.vertx-http.sslContextParameters

To configure security using SSLContextParameters

null

false

MEDIUM

camel.component.vertx-http.useGlobalSslContext Parameters

Enable usage of global SSL context parameters

false

false

MEDIUM

The camel-vertx-http sink connector has no converters out of the box.

The camel-vertx-http sink connector has no transforms out of the box.

The camel-vertx-http sink connector has no aggregation strategies out of the box.