camel-http-kafka-connector sink configuration

When using camel-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-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.http.CamelHttpSinkConnector

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

Name Description Default Priority

camel.sink.path.httpUri

The url of the HTTP endpoint to call.

null

HIGH

camel.sink.endpoint.disableStreamCache

Determines whether or not the raw input stream from Servlet is cached or not (Camel will read the stream into a in memory/overflow to file, Stream caching) cache. By default Camel will cache the Servlet 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 http producer 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 as the message body.

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom HeaderFilterStrategy to filter header to and from Camel message.

null

MEDIUM

camel.sink.endpoint.httpBinding

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

null

MEDIUM

camel.sink.endpoint.bridgeEndpoint

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

MEDIUM

camel.sink.endpoint.chunked

If this option is false the Servlet will disable the HTTP streaming and set the content-length header on the response

true

MEDIUM

camel.sink.endpoint.clearExpiredCookies

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.

true

MEDIUM

camel.sink.endpoint.connectionClose

Specifies whether a Connection Close header must be added to HTTP Request. By default connectionClose is false.

false

MEDIUM

camel.sink.endpoint.copyHeaders

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

MEDIUM

camel.sink.endpoint.customHostHeader

To use custom host header for producer. When not set in query will be ignored. When set will override host header derived from url.

null

MEDIUM

camel.sink.endpoint.httpMethod

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

null

MEDIUM

camel.sink.endpoint.ignoreResponseBody

If this option is true, The http producer won’t read response body and cache the input stream

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

MEDIUM

camel.sink.endpoint.preserveHostHeader

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

MEDIUM

camel.sink.endpoint.throwExceptionOnFailure

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

MEDIUM

camel.sink.endpoint.transferException

If enabled and an Exchange failed processing on the consumer side, and if the caused Exception was send 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 the HttpOperationFailedException. The caused exception is required to be serialized. 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

MEDIUM

camel.sink.endpoint.cookieHandler

Configure a cookie handler to maintain a HTTP session

null

MEDIUM

camel.sink.endpoint.cookieStore

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.

null

MEDIUM

camel.sink.endpoint.deleteWithBody

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

MEDIUM

camel.sink.endpoint.getWithBody

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

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"

MEDIUM

camel.sink.endpoint.basicPropertyBinding

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.sink.endpoint.clientBuilder

Provide access to the http client request parameters used on new RequestConfig instances used by producers or consumers of this endpoint.

null

MEDIUM

camel.sink.endpoint.clientConnectionManager

To use a custom HttpClientConnectionManager to manage connections

null

MEDIUM

camel.sink.endpoint.connectionsPerRoute

The maximum number of connections per route.

20

MEDIUM

camel.sink.endpoint.httpClient

Sets a custom HttpClient to be used by the producer

null

MEDIUM

camel.sink.endpoint.httpClientConfigurer

Register a custom configuration strategy for new HttpClient instances created by producers or consumers such as to configure authentication mechanisms etc.

null

MEDIUM

camel.sink.endpoint.httpClientOptions

To configure the HttpClient using the key/values from the Map.

null

MEDIUM

camel.sink.endpoint.httpContext

To use a custom HttpContext instance

null

MEDIUM

camel.sink.endpoint.mapHttpMessageBody

If this option is true then IN exchange Body of the exchange will be mapped to HTTP body. Setting this to false will avoid the HTTP mapping.

true

MEDIUM

camel.sink.endpoint.mapHttpMessageFormUrlEncoded Body

If this option is true then IN exchange Form Encoded body of the exchange will be mapped to HTTP. Setting this to false will avoid the HTTP Form Encoded body mapping.

true

MEDIUM

camel.sink.endpoint.mapHttpMessageHeaders

If this option is true then IN exchange Headers of the exchange will be mapped to HTTP headers. Setting this to false will avoid the HTTP Headers mapping.

true

MEDIUM

camel.sink.endpoint.maxTotalConnections

The maximum number of connections.

200

MEDIUM

camel.sink.endpoint.synchronous

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

MEDIUM

camel.sink.endpoint.useSystemProperties

To use System Properties as fallback for configuration

false

MEDIUM

camel.sink.endpoint.proxyAuthDomain

Proxy authentication domain to use with NTML

null

MEDIUM

camel.sink.endpoint.proxyAuthHost

Proxy authentication host

null

MEDIUM

camel.sink.endpoint.proxyAuthMethod

Proxy authentication method to use One of: [Basic] [Digest] [NTLM]

null

MEDIUM

camel.sink.endpoint.proxyAuthNtHost

Proxy authentication domain (workstation name) to use with NTML

null

MEDIUM

camel.sink.endpoint.proxyAuthPassword

Proxy authentication password

null

MEDIUM

camel.sink.endpoint.proxyAuthPort

Proxy authentication port

null

MEDIUM

camel.sink.endpoint.proxyAuthScheme

Proxy authentication scheme to use One of: [http] [https]

null

MEDIUM

camel.sink.endpoint.proxyAuthUsername

Proxy authentication username

null

MEDIUM

camel.sink.endpoint.proxyHost

Proxy hostname to use

null

MEDIUM

camel.sink.endpoint.proxyPort

Proxy port to use

null

MEDIUM

camel.sink.endpoint.authDomain

Authentication domain to use with NTML

null

MEDIUM

camel.sink.endpoint.authenticationPreemptive

If this option is true, camel-http sends preemptive basic authentication to the server.

false

MEDIUM

camel.sink.endpoint.authHost

Authentication host to use with NTML

null

MEDIUM

camel.sink.endpoint.authMethod

Authentication methods allowed to use as a comma separated list of values Basic, Digest or NTLM.

null

MEDIUM

camel.sink.endpoint.authMethodPriority

Which authentication method to prioritize to use, either as Basic, Digest or NTLM. One of: [Basic] [Digest] [NTLM]

null

MEDIUM

camel.sink.endpoint.authPassword

Authentication password

null

MEDIUM

camel.sink.endpoint.authUsername

Authentication username

null

MEDIUM

camel.sink.endpoint.sslContextParameters

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.

null

MEDIUM

camel.sink.endpoint.x509HostnameVerifier

To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier

null

MEDIUM

camel.component.http.cookieStore

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).

null

MEDIUM

camel.component.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

MEDIUM

camel.component.http.allowJavaSerializedObject

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

MEDIUM

camel.component.http.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

MEDIUM

camel.component.http.clientConnectionManager

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.

null

MEDIUM

camel.component.http.connectionsPerRoute

The maximum number of connections per route.

20

MEDIUM

camel.component.http.connectionTimeToLive

The time for connection to live, the time unit is millisecond, the default value is always keep alive.

null

MEDIUM

camel.component.http.httpBinding

To use a custom HttpBinding to control the mapping between Camel message and HttpClient.

null

MEDIUM

camel.component.http.httpClientConfigurer

To use the custom HttpClientConfigurer to perform configuration of the HttpClient that will be used.

null

MEDIUM

camel.component.http.httpConfiguration

To use the shared HttpConfiguration as base configuration.

null

MEDIUM

camel.component.http.httpContext

To use a custom org.apache.http.protocol.HttpContext when executing requests.

null

MEDIUM

camel.component.http.maxTotalConnections

The maximum number of connections.

200

MEDIUM

camel.component.http.headerFilterStrategy

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

null

MEDIUM

camel.component.http.proxyAuthDomain

Proxy authentication domain to use

null

MEDIUM

camel.component.http.proxyAuthHost

Proxy authentication host

null

MEDIUM

camel.component.http.proxyAuthMethod

Proxy authentication method to use One of: [Basic] [Digest] [NTLM]

null

MEDIUM

camel.component.http.proxyAuthNtHost

Proxy authentication domain (workstation name) to use with NTML

null

MEDIUM

camel.component.http.proxyAuthPassword

Proxy authentication password

null

MEDIUM

camel.component.http.proxyAuthPort

Proxy authentication port

null

MEDIUM

camel.component.http.proxyAuthUsername

Proxy authentication username

null

MEDIUM

camel.component.http.sslContextParameters

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.

null

MEDIUM

camel.component.http.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

MEDIUM

camel.component.http.x509HostnameVerifier

To use a custom X509HostnameVerifier such as DefaultHostnameVerifier or NoopHostnameVerifier.

null

MEDIUM

camel.component.http.connectionRequestTimeout

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

MEDIUM

camel.component.http.connectTimeout

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

MEDIUM

camel.component.http.socketTimeout

Defines the socket timeout in milliseconds, which is the timeout for waiting for data or, put differently, a maximum period inactivity between two consecutive data packets). A timeout value of zero is interpreted as an infinite timeout. A negative value is interpreted as undefined (system default).

-1

MEDIUM

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

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

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