camel-netty-http-kafka-connector sink configuration

When using camel-netty-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-netty-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.nettyhttp.CamelNettyhttpSinkConnector

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

Name Description Default Priority

camel.sink.path.protocol

The protocol to use which is either http, https or proxy - a consumer only option. One of: [http] [https]

null

HIGH

camel.sink.path.host

The local hostname such as localhost, or 0.0.0.0 when being a consumer. The remote HTTP server hostname when using producer.

null

HIGH

camel.sink.path.port

The host port number

null

MEDIUM

camel.sink.path.path

Resource path

null

MEDIUM

camel.sink.endpoint.bridgeEndpoint

If the option is true, the producer will ignore the Exchange.HTTP_URI header, and use the endpoint’s URI for request. You may also set the throwExceptionOnFailure to be false to let the producer send all the fault response back. The consumer working in the bridge mode will skip the gzip compression and WWW URL form encoding (by adding the Exchange.SKIP_GZIP_ENCODING and Exchange.SKIP_WWW_FORM_URLENCODED headers to the consumed exchange).

false

MEDIUM

camel.sink.endpoint.disconnect

Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.

false

MEDIUM

camel.sink.endpoint.keepAlive

Setting to ensure socket is not closed due to inactivity

true

MEDIUM

camel.sink.endpoint.reuseAddress

Setting to facilitate socket multiplexing

true

MEDIUM

camel.sink.endpoint.reuseChannel

This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well.

false

MEDIUM

camel.sink.endpoint.sync

Setting to set endpoint as one-way or request-response

true

MEDIUM

camel.sink.endpoint.tcpNoDelay

Setting to improve TCP protocol performance

true

MEDIUM

camel.sink.endpoint.connectTimeout

Time to wait for a socket connection to be available. Value is in milliseconds.

10000

MEDIUM

camel.sink.endpoint.cookieHandler

Configure a cookie handler to maintain a HTTP session

null

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

Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty’s ReadTimeoutHandler to trigger the timeout.

null

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

To use a custom ClientInitializerFactory

null

MEDIUM

camel.sink.endpoint.lazyChannelCreation

Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.

true

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. The default range is 200-299

"200-299"

MEDIUM

camel.sink.endpoint.producerPoolEnabled

Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details.

true

MEDIUM

camel.sink.endpoint.producerPoolMaxActive

Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit.

-1

MEDIUM

camel.sink.endpoint.producerPoolMaxIdle

Sets the cap on the number of idle instances in the pool.

100

MEDIUM

camel.sink.endpoint.producerPoolMinEvictableIdle

Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.

300000L

MEDIUM

camel.sink.endpoint.producerPoolMinIdle

Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.

null

MEDIUM

camel.sink.endpoint.useRelativePath

Sets whether to use a relative path in HTTP requests.

true

MEDIUM

camel.sink.endpoint.allowSerializedHeaders

Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level.

false

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

To use a explicit ChannelGroup.

null

MEDIUM

camel.sink.endpoint.configuration

To use a custom configured NettyHttpConfiguration for configuring this endpoint.

null

MEDIUM

camel.sink.endpoint.disableStreamCache

Determines whether or not the raw input stream from Netty HttpRequest#getContent() or HttpResponset#getContent() is cached or not (Camel will read the stream into a in light-weight memory based Stream caching) cache. By default Camel will cache the Netty 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. Mind that if you enable this option, then you cannot read the Netty stream multiple times out of the box, and you would need manually to reset the reader index on the Netty raw stream. Also Netty will auto-close the Netty stream when the Netty HTTP server/HTTP client is done processing, which means that if the asynchronous routing engine is in use then any asynchronous thread that may continue routing the org.apache.camel.Exchange may not be able to read the Netty stream, because Netty has closed it.

false

MEDIUM

camel.sink.endpoint.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.

null

MEDIUM

camel.sink.endpoint.nativeTransport

Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html

false

MEDIUM

camel.sink.endpoint.nettyHttpBinding

To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.

null

MEDIUM

camel.sink.endpoint.options

Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.

null

MEDIUM

camel.sink.endpoint.receiveBufferSize

The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.

65536

MEDIUM

camel.sink.endpoint.receiveBufferSizePredictor

Configures the buffer size predictor. See details at Jetty documentation and this mail thread.

null

MEDIUM

camel.sink.endpoint.sendBufferSize

The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.

65536

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

Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.

false

MEDIUM

camel.sink.endpoint.workerCount

When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty.

null

MEDIUM

camel.sink.endpoint.workerGroup

To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads.

null

MEDIUM

camel.sink.endpoint.decoders

A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.

null

MEDIUM

camel.sink.endpoint.encoders

A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.

null

MEDIUM

camel.sink.endpoint.enabledProtocols

Which protocols to enable when using SSL

"TLSv1,TLSv1.1,TLSv1.2"

MEDIUM

camel.sink.endpoint.keyStoreFile

Client side certificate keystore to be used for encryption

null

MEDIUM

camel.sink.endpoint.keyStoreFormat

Keystore format to be used for payload encryption. Defaults to JKS if not set

null

MEDIUM

camel.sink.endpoint.keyStoreResource

Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

null

MEDIUM

camel.sink.endpoint.passphrase

Password setting to use in order to encrypt/decrypt payloads sent using SSH

null

MEDIUM

camel.sink.endpoint.securityProvider

Security provider to be used for payload encryption. Defaults to SunX509 if not set.

null

MEDIUM

camel.sink.endpoint.ssl

Setting to specify whether SSL encryption is applied to this endpoint

false

MEDIUM

camel.sink.endpoint.sslClientCertHeaders

When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.

false

MEDIUM

camel.sink.endpoint.sslContextParameters

To configure security using SSLContextParameters

null

MEDIUM

camel.sink.endpoint.sslHandler

Reference to a class that could be used to return an SSL Handler

null

MEDIUM

camel.sink.endpoint.trustStoreFile

Server side certificate keystore to be used for encryption

null

MEDIUM

camel.sink.endpoint.trustStoreResource

Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

null

MEDIUM

camel.component.netty-http.configuration

To use the NettyConfiguration as configuration when creating endpoints.

null

MEDIUM

camel.component.netty-http.disconnect

Whether or not to disconnect(close) from Netty Channel right after use. Can be used for both consumer and producer.

false

MEDIUM

camel.component.netty-http.keepAlive

Setting to ensure socket is not closed due to inactivity

true

MEDIUM

camel.component.netty-http.reuseAddress

Setting to facilitate socket multiplexing

true

MEDIUM

camel.component.netty-http.reuseChannel

This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key NettyConstants#NETTY_CHANNEL which allows you to obtain the channel during routing and use it as well.

false

MEDIUM

camel.component.netty-http.sync

Setting to set endpoint as one-way or request-response

true

MEDIUM

camel.component.netty-http.tcpNoDelay

Setting to improve TCP protocol performance

true

MEDIUM

camel.component.netty-http.connectTimeout

Time to wait for a socket connection to be available. Value is in milliseconds.

10000

MEDIUM

camel.component.netty-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.netty-http.requestTimeout

Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty’s ReadTimeoutHandler to trigger the timeout.

null

MEDIUM

camel.component.netty-http.clientInitializer Factory

To use a custom ClientInitializerFactory

null

MEDIUM

camel.component.netty-http.correlationManager

To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details.

null

MEDIUM

camel.component.netty-http.lazyChannelCreation

Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.

true

MEDIUM

camel.component.netty-http.producerPoolEnabled

Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details.

true

MEDIUM

camel.component.netty-http.producerPoolMaxActive

Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit.

-1

MEDIUM

camel.component.netty-http.producerPoolMaxIdle

Sets the cap on the number of idle instances in the pool.

100

MEDIUM

camel.component.netty-http.producerPoolMin EvictableIdle

Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.

300000L

MEDIUM

camel.component.netty-http.producerPoolMinIdle

Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.

null

MEDIUM

camel.component.netty-http.udpConnectionless Sending

This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port.

false

MEDIUM

camel.component.netty-http.useByteBuf

If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out.

false

MEDIUM

camel.component.netty-http.allowSerializedHeaders

Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level.

false

MEDIUM

camel.component.netty-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.netty-http.channelGroup

To use a explicit ChannelGroup.

null

MEDIUM

camel.component.netty-http.headerFilterStrategy

To use a custom org.apache.camel.spi.HeaderFilterStrategy to filter headers.

null

MEDIUM

camel.component.netty-http.nativeTransport

Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html

false

MEDIUM

camel.component.netty-http.nettyHttpBinding

To use a custom org.apache.camel.component.netty.http.NettyHttpBinding for binding to/from Netty and Camel Message API.

null

MEDIUM

camel.component.netty-http.options

Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false to set the netty option child.keepAlive=false. See the Netty documentation for possible options that can be used.

null

MEDIUM

camel.component.netty-http.receiveBufferSize

The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.

65536

MEDIUM

camel.component.netty-http.receiveBufferSize Predictor

Configures the buffer size predictor. See details at Jetty documentation and this mail thread.

null

MEDIUM

camel.component.netty-http.sendBufferSize

The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.

65536

MEDIUM

camel.component.netty-http.transferExchange

Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.

false

MEDIUM

camel.component.netty-http.udpByteArrayCodec

For UDP only. If enabled the using byte array codec instead of Java serialization protocol.

false

MEDIUM

camel.component.netty-http.workerCount

When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty.

null

MEDIUM

camel.component.netty-http.workerGroup

To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads.

null

MEDIUM

camel.component.netty-http.allowDefaultCodec

The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain.

true

MEDIUM

camel.component.netty-http.autoAppendDelimiter

Whether or not to auto append missing end delimiter when sending using the textline codec.

true

MEDIUM

camel.component.netty-http.decoderMaxLineLength

The max line length to use for the textline codec.

1024

MEDIUM

camel.component.netty-http.decoders

A list of decoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.

null

MEDIUM

camel.component.netty-http.delimiter

The delimiter to use for the textline codec. Possible values are LINE and NULL. One of: [LINE] [NULL]

"LINE"

MEDIUM

camel.component.netty-http.encoders

A list of encoders to be used. You can use a String which have values separated by comma, and have the values be looked up in the Registry. Just remember to prefix the value with # so Camel knows it should lookup.

null

MEDIUM

camel.component.netty-http.encoding

The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset.

null

MEDIUM

camel.component.netty-http.textline

Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default.

false

MEDIUM

camel.component.netty-http.enabledProtocols

Which protocols to enable when using SSL

"TLSv1,TLSv1.1,TLSv1.2"

MEDIUM

camel.component.netty-http.keyStoreFile

Client side certificate keystore to be used for encryption

null

MEDIUM

camel.component.netty-http.keyStoreFormat

Keystore format to be used for payload encryption. Defaults to JKS if not set

null

MEDIUM

camel.component.netty-http.keyStoreResource

Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

null

MEDIUM

camel.component.netty-http.passphrase

Password setting to use in order to encrypt/decrypt payloads sent using SSH

null

MEDIUM

camel.component.netty-http.securityConfiguration

Refers to a org.apache.camel.component.netty.http.NettyHttpSecurityConfiguration for configuring secure web resources.

null

MEDIUM

camel.component.netty-http.securityProvider

Security provider to be used for payload encryption. Defaults to SunX509 if not set.

null

MEDIUM

camel.component.netty-http.ssl

Setting to specify whether SSL encryption is applied to this endpoint

false

MEDIUM

camel.component.netty-http.sslClientCertHeaders

When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.

false

MEDIUM

camel.component.netty-http.sslContextParameters

To configure security using SSLContextParameters

null

MEDIUM

camel.component.netty-http.sslHandler

Reference to a class that could be used to return an SSL Handler

null

MEDIUM

camel.component.netty-http.trustStoreFile

Server side certificate keystore to be used for encryption

null

MEDIUM

camel.component.netty-http.trustStoreResource

Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.

null

MEDIUM

camel.component.netty-http.useGlobalSslContext Parameters

Enable usage of global SSL context parameters.

false

MEDIUM

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

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

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