This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 6f481892dc8 [DOCS] Update HTTP and Kafka components. (#7919)
6f481892dc8 is described below
commit 6f481892dc8e103327874403cd49758d64a68691
Author: mmajerni <[email protected]>
AuthorDate: Wed Jun 29 13:34:45 2022 +0200
[DOCS] Update HTTP and Kafka components. (#7919)
---
.../org/apache/camel/component/http/http.json | 2 +-
.../camel-http/src/main/docs/http-component.adoc | 9 ++---
.../component/infinispan/remote/infinispan.json | 2 +-
.../org/apache/camel/component/kafka/kafka.json | 38 +++++++++++-----------
.../camel-kafka/src/main/docs/kafka-component.adoc | 32 +++++++++---------
5 files changed, 42 insertions(+), 41 deletions(-)
diff --git
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
index 537118010e8..9e9690dca69 100644
---
a/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
+++
b/components/camel-http/src/generated/resources/org/apache/camel/component/http/http.json
@@ -71,7 +71,7 @@
"CamelHttpProtocolVersion": { "kind": "header", "displayName": "",
"group": "producer", "label": "producer", "required": false, "javaType":
"String", "deprecated": false, "deprecationNote": "", "autowired": false,
"secret": false, "description": "The version of the http protocol used.",
"constantName":
"org.apache.camel.component.http.HttpConstants#HTTP_PROTOCOL_VERSION" },
"Host": { "kind": "header", "displayName": "", "group": "producer",
"label": "producer", "required": false, "javaType": "String", "deprecated":
false, "deprecationNote": "", "autowired": false, "secret": false,
"description": "The target host.", "constantName":
"org.apache.camel.component.http.HttpConstants#HTTP_HEADER_HOST" },
"CamelRestHttpUri": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The rest http URI.", "constantName":
"org.apache.camel.component.http.HttpConstants#REST_HTTP_URI" },
- "CamelHttpUri": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "URI to call. Will override 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 [...]
+ "CamelHttpUri": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "URI to call. Will override existing URI set directly on
the endpoint. This uri is the uri of the http server to call. It is not the
same as the Camel endpoint uri, where you can configure endpoint options such
as security etc. This header does not suppo [...]
"CamelHttpPath": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "Request URI's path, the header will be used to build the
request URI with the HTTP_URI.", "constantName":
"org.apache.camel.component.http.HttpConstants#HTTP_PATH" },
"CamelRestHttpQuery": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The rest http query.", "constantName":
"org.apache.camel.component.http.HttpConstants#REST_HTTP_QUERY" },
"CamelHttpRawQuery": { "kind": "header", "displayName": "", "group":
"producer", "label": "producer", "required": false, "javaType": "String",
"deprecated": false, "deprecationNote": "", "autowired": false, "secret":
false, "description": "The http raw query.", "constantName":
"org.apache.camel.component.http.HttpConstants#HTTP_RAW_QUERY" },
diff --git a/components/camel-http/src/main/docs/http-component.adoc
b/components/camel-http/src/main/docs/http-component.adoc
index 2371a6368e6..63645e27b3a 100644
--- a/components/camel-http/src/main/docs/http-component.adoc
+++ b/components/camel-http/src/main/docs/http-component.adoc
@@ -98,6 +98,7 @@ with the information.
and will throw a `HttpOperationFailedException` with the information.
*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. +
@@ -125,7 +126,7 @@ The following algorithm is used to determine what HTTP
method should be used: +
== Configuring URI to call
-You can set the HTTP producer's URI directly form the endpoint URI. In
+You can set the HTTP producer's URI directly from the endpoint URI. In
the route below, Camel will call out to the external server, `oldhost`,
using HTTP.
@@ -147,8 +148,8 @@ And the equivalent Spring sample:
</camelContext>
---------------------------------------------------------------------
-You can override the HTTP endpoint URI by adding a header with the key,
-`Exchange.HTTP_URI`, on the message.
+You can override the HTTP endpoint URI by adding a header with the key
+`Exchange.HTTP_URI` on the message.
[source,java]
-----------------------------------------------------------
@@ -409,7 +410,7 @@ Configuring Apache HTTP Client Directly
Basically camel-http component is built on the top of
http://hc.apache.org/httpcomponents-client-ga/[Apache HttpClient].
Please refer to
-http://hc.apache.org/httpcomponents-client-ga/tutorial/html/connmgmt.html#d4e537[SSL/TLS
+https://hc.apache.org/httpcomponents-client-4.5.x/current/tutorial/html/connmgmt.html[SSL/TLS
customization] for details or have a look into the
`org.apache.camel.component.http.HttpsServerTestSupport` unit test base
class. +
diff --git
a/components/camel-infinispan/camel-infinispan/src/generated/resources/org/apache/camel/component/infinispan/remote/infinispan.json
b/components/camel-infinispan/camel-infinispan/src/generated/resources/org/apache/camel/component/infinispan/remote/infinispan.json
index 1adebd2cef6..72588b4bf03 100644
---
a/components/camel-infinispan/camel-infinispan/src/generated/resources/org/apache/camel/component/infinispan/remote/infinispan.json
+++
b/components/camel-infinispan/camel-infinispan/src/generated/resources/org/apache/camel/component/infinispan/remote/infinispan.json
@@ -28,7 +28,7 @@
"secure": { "kind": "property", "displayName": "Secure", "group":
"common", "label": "common", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Define if we are
connecting to a secured Infinispan instance" },
"bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Allows for bridging the
consumer to the Camel routing Error Handler, which mean any exceptions occurred
while the consumer is trying to pickup incoming messages, or the likes, will
now be processed as a me [...]
"customListener": { "kind": "property", "displayName": "Custom Listener",
"group": "consumer", "label": "consumer", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteCustomListener",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Returns the custom
listener in [...]
- "eventTypes": { "kind": "property", "displayName": "Event Types", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Specifies the set of
event types to register by the consumer.Multiple event can be separated by co
[...]
+ "eventTypes": { "kind": "property", "displayName": "Event Types", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Specifies the set of
event types to register by the consumer. Multiple event can be separated by c
[...]
"defaultValue": { "kind": "property", "displayName": "Default Value",
"group": "producer", "label": "producer", "required": false, "type": "object",
"javaType": "java.lang.Object", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Set a specific default
value for some producer operations" },
"key": { "kind": "property", "displayName": "Key", "group": "producer",
"label": "producer", "required": false, "type": "object", "javaType":
"java.lang.Object", "deprecated": false, "autowired": false, "secret": false,
"configurationClass":
"org.apache.camel.component.infinispan.remote.InfinispanRemoteConfiguration",
"configurationField": "configuration", "description": "Set a specific key for
producer operations" },
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
diff --git
a/components/camel-kafka/src/generated/resources/org/apache/camel/component/kafka/kafka.json
b/components/camel-kafka/src/generated/resources/org/apache/camel/component/kafka/kafka.json
index 4207ad92539..47472b64eef 100644
---
a/components/camel-kafka/src/generated/resources/org/apache/camel/component/kafka/kafka.json
+++
b/components/camel-kafka/src/generated/resources/org/apache/camel/component/kafka/kafka.json
@@ -33,13 +33,13 @@
"autoCommitEnable": { "kind": "property", "displayName": "Auto Commit
Enable", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "If true, periodically commit to ZooKeeper the
offset of messages already fetched by the consum [...]
"autoCommitIntervalMs": { "kind": "property", "displayName": "Auto Commit
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "5000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The frequency in ms that
the consumer offsets are committed to zookeeper." },
"autoOffsetReset": { "kind": "property", "displayName": "Auto Offset
Reset", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "enum": [ "latest", "earliest",
"none" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "latest", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "What to do when there is no initial offset
[...]
- "breakOnFirstError": { "kind": "property", "displayName": "Break On First
Error", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "This options controls what happens when a
consumer is processing an exchange and it fails. [...]
+ "breakOnFirstError": { "kind": "property", "displayName": "Break On First
Error", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "This option controls what happens when a
consumer is processing an exchange and it fails. [...]
"bridgeErrorHandler": { "kind": "property", "displayName": "Bridge Error
Handler", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Allows for bridging the
consumer to the Camel routing Error Handler, which mean any exceptions occurred
while the consumer is trying to pickup incoming messages, or the likes, will
now be processed as a me [...]
"checkCrcs": { "kind": "property", "displayName": "Check Crcs", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "true", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Automatically check the CRC32 of the records
consumed. This ensures no on-the-wire or on-disk cor [...]
"commitTimeoutMs": { "kind": "property", "displayName": "Commit Timeout
Ms", "group": "consumer", "label": "consumer", "required": false, "type":
"duration", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "5000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum time, in milliseconds, that the
code will wait for a synchronous commit to [...]
"consumerRequestTimeoutMs": { "kind": "property", "displayName": "Consumer
Request Timeout Ms", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "40000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The configuration
controls the maximum amount of time the client [...]
"consumersCount": { "kind": "property", "displayName": "Consumers Count",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 1, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The number of consumers that connect to kafka
server. Each consumer is run on a separate thread, that retr [...]
- "fetchMaxBytes": { "kind": "property", "displayName": "Fetch Max Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "52428800", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of data the server should
return for a fetch request This is not [...]
+ "fetchMaxBytes": { "kind": "property", "displayName": "Fetch Max Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "52428800", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of data the server should
return for a fetch request. This is not [...]
"fetchMinBytes": { "kind": "property", "displayName": "Fetch Min Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The minimum amount of data the server should
return for a fetch request. If insufficient da [...]
"fetchWaitMaxMs": { "kind": "property", "displayName": "Fetch Wait Max
Ms", "group": "consumer", "label": "consumer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "500", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of time the server will
block before answering the fetch request if [...]
"groupId": { "kind": "property", "displayName": "Group Id", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A string that uniquely identifies the group of
consumer processes to which this consumer belongs. By setting the same group id
[...]
@@ -47,7 +47,7 @@
"headerDeserializer": { "kind": "property", "displayName": "Header
Deserializer", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer", "deprecated":
false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "To use a custom KafkaHeaderDeserializer to
deserialize kafk [...]
"heartbeatIntervalMs": { "kind": "property", "displayName": "Heartbeat
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "3000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The expected time
between heartbeats to the consumer coordinator when using [...]
"keyDeserializer": { "kind": "property", "displayName": "Key
Deserializer", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"org.apache.kafka.common.serialization.StringDeserializer",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Deserializer class for
key that imp [...]
- "maxPartitionFetchBytes": { "kind": "property", "displayName": "Max
Partition Fetch Bytes", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "1048576",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum amount of
data per-partition the server will return. T [...]
+ "maxPartitionFetchBytes": { "kind": "property", "displayName": "Max
Partition Fetch Bytes", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "1048576",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum amount of
data per-partition the server will return. T [...]
"maxPollIntervalMs": { "kind": "property", "displayName": "Max Poll
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "duration", "javaType": "java.lang.Long", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum delay between invocations of
poll() when using consumer group management. This places an uppe [...]
"maxPollRecords": { "kind": "property", "displayName": "Max Poll Records",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "500", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum number of records returned in a
single call to poll()" },
"offsetRepository": { "kind": "property", "displayName": "Offset
Repository", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"org.apache.camel.spi.StateRepository<java.lang.String, java.lang.String>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The offset repository to use in order to
locally stor [...]
@@ -75,8 +75,8 @@
"key": { "kind": "property", "displayName": "Key", "group": "producer",
"label": "producer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The record key (or null
if no key is specified). If this option has been configured then it take
precedence over header KafkaConstants#KEY" },
"keySerializer": { "kind": "property", "displayName": "Key Serializer",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue":
"org.apache.kafka.common.serialization.StringSerializer", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The serializer class for keys (defaults t [...]
"lazyStartProducer": { "kind": "property", "displayName": "Lazy Start
Producer", "group": "producer", "label": "producer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "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 star [...]
- "lingerMs": { "kind": "property", "displayName": "Linger Ms", "group":
"producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "0", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer groups together any records that
arrive in between request transmissions into a single ba [...]
- "maxBlockMs": { "kind": "property", "displayName": "Max Block Ms",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The configuration controls how long sending to
kafka will block. These methods can be blocked [...]
+ "lingerMs": { "kind": "property", "displayName": "Linger Ms", "group":
"producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "0", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer groups together any records that
arrive in between request transmissions into a single ba [...]
+ "maxBlockMs": { "kind": "property", "displayName": "Max Block Ms",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The configuration controls how long sending to
kafka will block. These methods can be blocked [...]
"maxInFlightRequest": { "kind": "property", "displayName": "Max In Flight
Request", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "5", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum number of unacknowledged requests
the client will send on a single c [...]
"maxRequestSize": { "kind": "property", "displayName": "Max Request Size",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1048576", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum size of a request. This is also
effectively a cap on the maximum record [...]
"metadataMaxAgeMs": { "kind": "property", "displayName": "Metadata Max Age
Ms", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "300000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The period of time in milliseconds after which
we force a refresh of metadata e [...]
@@ -85,7 +85,7 @@
"noOfMetricsSample": { "kind": "property", "displayName": "No Of Metrics
Sample", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "2", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The number of samples maintained to compute
metrics." },
"partitioner": { "kind": "property", "displayName": "Partitioner",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue":
"org.apache.kafka.clients.producer.internals.DefaultPartitioner",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The partitioner class
for partitioning [...]
"partitionKey": { "kind": "property", "displayName": "Partition Key",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The partition to which the record will be sent
(or null if no partition was specified). If this option has been con [...]
- "producerBatchSize": { "kind": "property", "displayName": "Producer Batch
Size", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "16384", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer will attempt to batch records
together into fewer requests wheneve [...]
+ "producerBatchSize": { "kind": "property", "displayName": "Producer Batch
Size", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "16384", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer will attempt to batch records
together into fewer requests wheneve [...]
"queueBufferingMaxMessages": { "kind": "property", "displayName": "Queue
Buffering Max Messages", "group": "producer", "label": "producer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "10000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum number of
unsent messages that can be queued up th [...]
"receiveBufferBytes": { "kind": "property", "displayName": "Receive Buffer
Bytes", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "65536", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The size of the TCP receive buffer (SO_RCVBUF)
to use when reading data." },
"reconnectBackoffMs": { "kind": "property", "displayName": "Reconnect
Backoff Ms", "group": "producer", "label": "producer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "50",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The amount of time to
wait before attempting to reconnect to a given host. This [...]
@@ -103,17 +103,17 @@
"kafkaClientFactory": { "kind": "property", "displayName": "Kafka Client
Factory", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "org.apache.camel.component.kafka.KafkaClientFactory",
"deprecated": false, "autowired": true, "secret": false, "description":
"Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer
and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to
configure a custom factory to cr [...]
"synchronous": { "kind": "property", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets whether synchronous processing should be
strictly used" },
"schemaRegistryURL": { "kind": "property", "displayName": "Schema Registry
URL", "group": "confluent", "label": "confluent", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "URL of the Confluent Platform schema registry
servers to use. The format is host1:port1,host2:port2. Thi [...]
- "interceptorClasses": { "kind": "property", "displayName": "Interceptor
Classes", "group": "monitoring", "label": "common,monitoring", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets interceptors for producer or consumers.
Producer interceptors have to be classes implemen [...]
+ "interceptorClasses": { "kind": "property", "displayName": "Interceptor
Classes", "group": "monitoring", "label": "common,monitoring", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets interceptors for producer or consumers.
Producer interceptors have to be classes implemen [...]
"kerberosBeforeReloginMinTime": { "kind": "property", "displayName":
"Kerberos Before Relogin Min Time", "group": "security", "label":
"common,security", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Login thread sleep time between refresh
attempts." },
"kerberosInitCmd": { "kind": "property", "displayName": "Kerberos Init
Cmd", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "\/usr\/bin\/kinit",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Kerberos kinit command
path. Default is \/usr\/bin\/kinit" },
- "kerberosPrincipalToLocalRules": { "kind": "property", "displayName":
"Kerberos Principal To Local Rules", "group": "security", "label":
"common,security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "DEFAULT", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of rules for mapping from principal nam
[...]
+ "kerberosPrincipalToLocalRules": { "kind": "property", "displayName":
"Kerberos Principal To Local Rules", "group": "security", "label":
"common,security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "DEFAULT", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of rules for mapping from principal nam
[...]
"kerberosRenewJitter": { "kind": "property", "displayName": "Kerberos
Renew Jitter", "group": "security", "label": "common,security", "required":
false, "type": "number", "javaType": "java.lang.Double", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "0.05",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Percentage of random
jitter added to the renewal time." },
"kerberosRenewWindowFactor": { "kind": "property", "displayName":
"Kerberos Renew Window Factor", "group": "security", "label":
"common,security", "required": false, "type": "number", "javaType":
"java.lang.Double", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "0.8", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Login thread will sleep until the specified
window factor o [...]
"saslJaasConfig": { "kind": "property", "displayName": "Sasl Jaas Config",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": true, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Expose the kafka sasl.jaas.config parameter
Example: org.apache.kafka.common.security.plain.PlainLoginModu [...]
"saslKerberosServiceName": { "kind": "property", "displayName": "Sasl
Kerberos Service Name", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The Kerberos principal name that Kafka runs
as. This can be defined either in Kafka's [...]
"saslMechanism": { "kind": "property", "displayName": "Sasl Mechanism",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "GSSAPI", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The Simple Authentication and Security Layer
(SASL) Mechanism used. For the valid [...]
"securityProtocol": { "kind": "property", "displayName": "Security
Protocol", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "PLAINTEXT",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Protocol used to
communicate with brokers. SASL_PLAINTEXT, PLAINTEXT and [...]
- "sslCipherSuites": { "kind": "property", "displayName": "Ssl Cipher
Suites", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of cipher suites. This is a named
combination of authentication, encryption, MAC and key exchang [...]
+ "sslCipherSuites": { "kind": "property", "displayName": "Ssl Cipher
Suites", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of cipher suites. This is a named
combination of authentication, encryption, MAC and key exchang [...]
"sslContextParameters": { "kind": "property", "displayName": "Ssl Context
Parameters", "group": "security", "label": "common,security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "SSL configuration using a Camel
SSLContextParameters object [...]
"sslEnabledProtocols": { "kind": "property", "displayName": "Ssl Enabled
Protocols", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The list of protocols enabled for SSL
connections. TLSv1.2, TLSv1.1 and TLSv1 are enabled by de [...]
"sslEndpointAlgorithm": { "kind": "property", "displayName": "Ssl Endpoint
Algorithm", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "https",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The endpoint
identification algorithm to validate server hostname us [...]
@@ -122,7 +122,7 @@
"sslKeystoreLocation": { "kind": "property", "displayName": "Ssl Keystore
Location", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The location of the key store file. This is
optional for client and can be used for two-way aut [...]
"sslKeystorePassword": { "kind": "property", "displayName": "Ssl Keystore
Password", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The store password for the key store file.This
is optional for client and only needed if ssl.key [...]
"sslKeystoreType": { "kind": "property", "displayName": "Ssl Keystore
Type", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "JKS",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The file format of the
key store file. This is optional for client. Default valu [...]
- "sslProtocol": { "kind": "property", "displayName": "Ssl Protocol",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The SSL protocol used to generate the
SSLContext. Default setting is TLS, which is fine for most cases. Allowed [...]
+ "sslProtocol": { "kind": "property", "displayName": "Ssl Protocol",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "TLS", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The SSL protocol used to generate the
SSLContext. Default setting is TLS, which is fine f [...]
"sslProvider": { "kind": "property", "displayName": "Ssl Provider",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The name of the security provider used for SSL
connections. Default value is the default security provider of th [...]
"sslTrustmanagerAlgorithm": { "kind": "property", "displayName": "Ssl
Trustmanager Algorithm", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"PKIX", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The algorithm used by trust manager factory
for SSL connectio [...]
"sslTruststoreLocation": { "kind": "property", "displayName": "Ssl
Truststore Location", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The location of the trust store file." },
@@ -157,12 +157,12 @@
"autoCommitEnable": { "kind": "parameter", "displayName": "Auto Commit
Enable", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "If true, periodically commit to ZooKeeper the
offset of messages already fetched by the consu [...]
"autoCommitIntervalMs": { "kind": "parameter", "displayName": "Auto Commit
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "5000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The frequency in ms that
the consumer offsets are committed to zookeeper." },
"autoOffsetReset": { "kind": "parameter", "displayName": "Auto Offset
Reset", "group": "consumer", "label": "consumer", "required": false, "type":
"string", "javaType": "java.lang.String", "enum": [ "latest", "earliest",
"none" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "latest", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "What to do when there is no initial offse [...]
- "breakOnFirstError": { "kind": "parameter", "displayName": "Break On First
Error", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "This options controls what happens when a
consumer is processing an exchange and it fails [...]
+ "breakOnFirstError": { "kind": "parameter", "displayName": "Break On First
Error", "group": "consumer", "label": "consumer", "required": false, "type":
"boolean", "javaType": "boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "This option controls what happens when a
consumer is processing an exchange and it fails. [...]
"checkCrcs": { "kind": "parameter", "displayName": "Check Crcs", "group":
"consumer", "label": "consumer", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "true", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Automatically check the CRC32 of the records
consumed. This ensures no on-the-wire or on-disk co [...]
"commitTimeoutMs": { "kind": "parameter", "displayName": "Commit Timeout
Ms", "group": "consumer", "label": "consumer", "required": false, "type":
"duration", "javaType": "java.lang.Long", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "5000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum time, in milliseconds, that the
code will wait for a synchronous commit t [...]
"consumerRequestTimeoutMs": { "kind": "parameter", "displayName":
"Consumer Request Timeout Ms", "group": "consumer", "label": "consumer",
"required": false, "type": "integer", "javaType": "java.lang.Integer",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"40000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The configuration controls the maximum amount
of time the clien [...]
"consumersCount": { "kind": "parameter", "displayName": "Consumers Count",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "int", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": 1, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The number of consumers that connect to kafka
server. Each consumer is run on a separate thread, that ret [...]
- "fetchMaxBytes": { "kind": "parameter", "displayName": "Fetch Max Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "52428800", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of data the server should
return for a fetch request This is not [...]
+ "fetchMaxBytes": { "kind": "parameter", "displayName": "Fetch Max Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "52428800", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of data the server should
return for a fetch request. This is no [...]
"fetchMinBytes": { "kind": "parameter", "displayName": "Fetch Min Bytes",
"group": "consumer", "label": "consumer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The minimum amount of data the server should
return for a fetch request. If insufficient d [...]
"fetchWaitMaxMs": { "kind": "parameter", "displayName": "Fetch Wait Max
Ms", "group": "consumer", "label": "consumer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "500", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum amount of time the server will
block before answering the fetch request i [...]
"groupId": { "kind": "parameter", "displayName": "Group Id", "group":
"consumer", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A string that uniquely identifies the group of
consumer processes to which this consumer belongs. By setting the same group id
[...]
@@ -170,7 +170,7 @@
"headerDeserializer": { "kind": "parameter", "displayName": "Header
Deserializer", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.kafka.serde.KafkaHeaderDeserializer", "deprecated":
false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "To use a custom KafkaHeaderDeserializer to
deserialize kaf [...]
"heartbeatIntervalMs": { "kind": "parameter", "displayName": "Heartbeat
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "3000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The expected time
between heartbeats to the consumer coordinator when using [...]
"keyDeserializer": { "kind": "parameter", "displayName": "Key
Deserializer", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue":
"org.apache.kafka.common.serialization.StringDeserializer",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Deserializer class for
key that im [...]
- "maxPartitionFetchBytes": { "kind": "parameter", "displayName": "Max
Partition Fetch Bytes", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "1048576",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum amount of
data per-partition the server will return. [...]
+ "maxPartitionFetchBytes": { "kind": "parameter", "displayName": "Max
Partition Fetch Bytes", "group": "consumer", "label": "consumer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "1048576",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum amount of
data per-partition the server will return. [...]
"maxPollIntervalMs": { "kind": "parameter", "displayName": "Max Poll
Interval Ms", "group": "consumer", "label": "consumer", "required": false,
"type": "duration", "javaType": "java.lang.Long", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum delay between invocations of
poll() when using consumer group management. This places an upp [...]
"maxPollRecords": { "kind": "parameter", "displayName": "Max Poll
Records", "group": "consumer", "label": "consumer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "500", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum number of records returned in a
single call to poll()" },
"offsetRepository": { "kind": "parameter", "displayName": "Offset
Repository", "group": "consumer", "label": "consumer", "required": false,
"type": "object", "javaType":
"org.apache.camel.spi.StateRepository<java.lang.String, java.lang.String>",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The offset repository to use in order to
locally sto [...]
@@ -195,8 +195,8 @@
"headerSerializer": { "kind": "parameter", "displayName": "Header
Serializer", "group": "producer", "label": "producer", "required": false,
"type": "object", "javaType":
"org.apache.camel.component.kafka.serde.KafkaHeaderSerializer", "deprecated":
false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "To use a custom KafkaHeaderSerializer to
serialize kafka headers [...]
"key": { "kind": "parameter", "displayName": "Key", "group": "producer",
"label": "producer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The record key (or null
if no key is specified). If this option has been configured then it take
precedence over header KafkaConstants#KEY" },
"keySerializer": { "kind": "parameter", "displayName": "Key Serializer",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue":
"org.apache.kafka.common.serialization.StringSerializer", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The serializer class for keys (defaults [...]
- "lingerMs": { "kind": "parameter", "displayName": "Linger Ms", "group":
"producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "0", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer groups together any records that
arrive in between request transmissions into a single b [...]
- "maxBlockMs": { "kind": "parameter", "displayName": "Max Block Ms",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The configuration controls how long sending to
kafka will block. These methods can be blocke [...]
+ "lingerMs": { "kind": "parameter", "displayName": "Linger Ms", "group":
"producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "0", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer groups together any records that
arrive in between request transmissions into a single b [...]
+ "maxBlockMs": { "kind": "parameter", "displayName": "Max Block Ms",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The configuration controls how long sending to
kafka will block. These methods can be blocke [...]
"maxInFlightRequest": { "kind": "parameter", "displayName": "Max In Flight
Request", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "5", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum number of unacknowledged requests
the client will send on a single [...]
"maxRequestSize": { "kind": "parameter", "displayName": "Max Request
Size", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "1048576", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The maximum size of a request. This is also
effectively a cap on the maximum recor [...]
"metadataMaxAgeMs": { "kind": "parameter", "displayName": "Metadata Max
Age Ms", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "300000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The period of time in milliseconds after which
we force a refresh of metadata [...]
@@ -205,7 +205,7 @@
"noOfMetricsSample": { "kind": "parameter", "displayName": "No Of Metrics
Sample", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "2", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The number of samples maintained to compute
metrics." },
"partitioner": { "kind": "parameter", "displayName": "Partitioner",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue":
"org.apache.kafka.clients.producer.internals.DefaultPartitioner",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The partitioner class
for partitionin [...]
"partitionKey": { "kind": "parameter", "displayName": "Partition Key",
"group": "producer", "label": "producer", "required": false, "type": "integer",
"javaType": "java.lang.Integer", "deprecated": false, "autowired": false,
"secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The partition to which the record will be sent
(or null if no partition was specified). If this option has been co [...]
- "producerBatchSize": { "kind": "parameter", "displayName": "Producer Batch
Size", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "16384", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer will attempt to batch records
together into fewer requests whenev [...]
+ "producerBatchSize": { "kind": "parameter", "displayName": "Producer Batch
Size", "group": "producer", "label": "producer", "required": false, "type":
"integer", "javaType": "java.lang.Integer", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "16384", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The producer will attempt to batch records
together into fewer requests whenev [...]
"queueBufferingMaxMessages": { "kind": "parameter", "displayName": "Queue
Buffering Max Messages", "group": "producer", "label": "producer", "required":
false, "type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "10000",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The maximum number of
unsent messages that can be queued up t [...]
"receiveBufferBytes": { "kind": "parameter", "displayName": "Receive
Buffer Bytes", "group": "producer", "label": "producer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "65536",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The size of the TCP
receive buffer (SO_RCVBUF) to use when reading data." },
"reconnectBackoffMs": { "kind": "parameter", "displayName": "Reconnect
Backoff Ms", "group": "producer", "label": "producer", "required": false,
"type": "integer", "javaType": "java.lang.Integer", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "50",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The amount of time to
wait before attempting to reconnect to a given host. This [...]
@@ -223,7 +223,7 @@
"kafkaClientFactory": { "kind": "parameter", "displayName": "Kafka Client
Factory", "group": "advanced", "label": "advanced", "required": false, "type":
"object", "javaType": "org.apache.camel.component.kafka.KafkaClientFactory",
"deprecated": false, "autowired": false, "secret": false, "description":
"Factory to use for creating org.apache.kafka.clients.consumer.KafkaConsumer
and org.apache.kafka.clients.producer.KafkaProducer instances. This allows to
configure a custom factory to [...]
"synchronous": { "kind": "parameter", "displayName": "Synchronous",
"group": "advanced", "label": "advanced", "required": false, "type": "boolean",
"javaType": "boolean", "deprecated": false, "autowired": false, "secret":
false, "defaultValue": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets whether synchronous processing should be
strictly used" },
"schemaRegistryURL": { "kind": "parameter", "displayName": "Schema
Registry URL", "group": "confluent", "label": "confluent", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "URL of the Confluent Platform schema registry
servers to use. The format is host1:port1,host2:port2. Th [...]
- "interceptorClasses": { "kind": "parameter", "displayName": "Interceptor
Classes", "group": "monitoring", "label": "common,monitoring", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets interceptors for producer or consumers.
Producer interceptors have to be classes impleme [...]
+ "interceptorClasses": { "kind": "parameter", "displayName": "Interceptor
Classes", "group": "monitoring", "label": "common,monitoring", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Sets interceptors for producer or consumers.
Producer interceptors have to be classes impleme [...]
"kerberosBeforeReloginMinTime": { "kind": "parameter", "displayName":
"Kerberos Before Relogin Min Time", "group": "security", "label":
"common,security", "required": false, "type": "integer", "javaType":
"java.lang.Integer", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "60000", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "Login thread sleep time between refresh
attempts." },
"kerberosInitCmd": { "kind": "parameter", "displayName": "Kerberos Init
Cmd", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "\/usr\/bin\/kinit",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Kerberos kinit command
path. Default is \/usr\/bin\/kinit" },
"kerberosPrincipalToLocalRules": { "kind": "parameter", "displayName":
"Kerberos Principal To Local Rules", "group": "security", "label":
"common,security", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "DEFAULT", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of rules for mapping from principal na
[...]
@@ -233,7 +233,7 @@
"saslKerberosServiceName": { "kind": "parameter", "displayName": "Sasl
Kerberos Service Name", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The Kerberos principal name that Kafka runs
as. This can be defined either in Kafka's [...]
"saslMechanism": { "kind": "parameter", "displayName": "Sasl Mechanism",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "GSSAPI", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The Simple Authentication and Security Layer
(SASL) Mechanism used. For the valid [...]
"securityProtocol": { "kind": "parameter", "displayName": "Security
Protocol", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "PLAINTEXT",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "Protocol used to
communicate with brokers. SASL_PLAINTEXT, PLAINTEXT and [...]
- "sslCipherSuites": { "kind": "parameter", "displayName": "Ssl Cipher
Suites", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of cipher suites. This is a named
combination of authentication, encryption, MAC and key exchan [...]
+ "sslCipherSuites": { "kind": "parameter", "displayName": "Ssl Cipher
Suites", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "A list of cipher suites. This is a named
combination of authentication, encryption, MAC and key exchan [...]
"sslContextParameters": { "kind": "parameter", "displayName": "Ssl Context
Parameters", "group": "security", "label": "common,security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "SSL configuration using a Camel
SSLContextParameters objec [...]
"sslEnabledProtocols": { "kind": "parameter", "displayName": "Ssl Enabled
Protocols", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The list of protocols enabled for SSL
connections. TLSv1.2, TLSv1.1 and TLSv1 are enabled by d [...]
"sslEndpointAlgorithm": { "kind": "parameter", "displayName": "Ssl
Endpoint Algorithm", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"https", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The endpoint identification algorithm to
validate server hostname u [...]
@@ -242,7 +242,7 @@
"sslKeystoreLocation": { "kind": "parameter", "displayName": "Ssl Keystore
Location", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The location of the key store file. This is
optional for client and can be used for two-way au [...]
"sslKeystorePassword": { "kind": "parameter", "displayName": "Ssl Keystore
Password", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": true, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The store password for the key store file.This
is optional for client and only needed if ssl.ke [...]
"sslKeystoreType": { "kind": "parameter", "displayName": "Ssl Keystore
Type", "group": "security", "label": "common,security", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "JKS",
"configurationClass": "org.apache.camel.component.kafka.KafkaConfiguration",
"configurationField": "configuration", "description": "The file format of the
key store file. This is optional for client. Default val [...]
- "sslProtocol": { "kind": "parameter", "displayName": "Ssl Protocol",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The SSL protocol used to generate the
SSLContext. Default setting is TLS, which is fine for most cases. Allowed [...]
+ "sslProtocol": { "kind": "parameter", "displayName": "Ssl Protocol",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "TLS", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The SSL protocol used to generate the
SSLContext. Default setting is TLS, which is fine [...]
"sslProvider": { "kind": "parameter", "displayName": "Ssl Provider",
"group": "security", "label": "common,security", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The name of the security provider used for SSL
connections. Default value is the default security provider of t [...]
"sslTrustmanagerAlgorithm": { "kind": "parameter", "displayName": "Ssl
Trustmanager Algorithm", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
"PKIX", "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The algorithm used by trust manager factory
for SSL connecti [...]
"sslTruststoreLocation": { "kind": "parameter", "displayName": "Ssl
Truststore Location", "group": "security", "label": "common,security",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "configurationClass":
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField":
"configuration", "description": "The location of the trust store file." },
diff --git a/components/camel-kafka/src/main/docs/kafka-component.adoc
b/components/camel-kafka/src/main/docs/kafka-component.adoc
index 135b0a2f7d1..e6d289af58f 100644
--- a/components/camel-kafka/src/main/docs/kafka-component.adoc
+++ b/components/camel-kafka/src/main/docs/kafka-component.adoc
@@ -59,15 +59,15 @@
http://kafka.apache.org/documentation.html#producerconfigs[http://kafka.apache.o
include::partial$component-endpoint-headers.adoc[]
// component headers: END
-If you want to send a message to a dynamic topic then use
`KafkaConstants.OVERRIDE_TOPIC` as its used as a one-time header
-that are not send along the message, as it's removed in the producer.
+If you want to send a message to a dynamic topic then use
`KafkaConstants.OVERRIDE_TOPIC` as it is used as a one-time header
+that is not send along the message, as it is removed in the producer.
== Consumer error handling
While kafka consumer is polling messages from the kafka broker, then errors
can happen. This section describes what happens and what
you can configure.
-The consumer may throw exception when invoking the Kafka `poll` API. For
example if the message cannot be de-serialized due invalid data,
+The consumer may throw exception when invoking the Kafka `poll` API. For
example, if the message cannot be de-serialized due invalid data,
and many other kind of errors. Those errors are in the form of
`KafkaException` which are either _retryable_ or not. The exceptions
which can be retried (`RetriableException`) will be retried again (with a poll
timeout in between). All other kind of exceptions are
handled according to the _pollOnError_ configuration. This configuration has
the following values:
@@ -79,10 +79,10 @@ handled according to the _pollOnError_ configuration. This
configuration has the
* STOP will stop the consumer (have to be manually started/restarted if the
consumer should be able to consume messages again).
The default is *ERROR_HANDLER* which will let Camel's error handler (if any
configured) process the caused exception.
-And then afterwards continue to poll the next message. This behavior is
similar to the _bridgeErrorHandler_ option that
+Afterwards continue to poll the next message. This behavior is similar to the
_bridgeErrorHandler_ option that
Camel components have.
-For advanced control then a custom implementation of
`org.apache.camel.component.kafka.PollExceptionStrategy` can be configured
+For advanced control a custom implementation of
`org.apache.camel.component.kafka.PollExceptionStrategy` can be configured
on the component level, which allows to control which exceptions causes which
of the strategies above.
== Samples
@@ -172,9 +172,9 @@ from("direct:start")
== SSL configuration
-You have 2 different ways to configure the SSL communication on the Kafka`
component.
+You have 2 different ways to configure the SSL communication on the Kafka
component.
-The first way is through the many SSL endpoint parameters
+The first way is through the many SSL endpoint parameters:
[source,java]
----
@@ -187,7 +187,7 @@ from("kafka:" + TOPIC + "?brokers=localhost:{{kafkaPort}}" +
.to("mock:result");
----
-The second way is to use the `sslContextParameters` endpoint parameter.
+The second way is to use the `sslContextParameters` endpoint parameter:
[source,java]
----
@@ -228,7 +228,7 @@ camelContext.addRoutes(new RouteBuilder() {
The `camel-kafka` library provides a Kafka topic-based idempotent repository.
This repository stores broadcasts all changes to idempotent state (add/remove)
in a Kafka topic, and populates a local in-memory cache for each repository's
process instance through event sourcing.
The topic used must be unique per idempotent repository instance. The
mechanism does not have any requirements about the number of topic partitions;
as the repository consumes from all partitions at the same time. It also does
not have any requirements about the replication factor of the topic.
Each repository instance that uses the topic (e.g. typically on different
machines running in parallel) controls its own consumer group, so in a cluster
of 10 Camel processes using the same topic each will control its own offset.
-On startup, the instance subscribes to the topic and rewinds the offset to the
beginning, rebuilding the cache to the latest state. The cache will not be
considered warmed up until one poll of `pollDurationMs` in length returns 0
records. Startup will not be completed until either the cache has warmed up, or
30 seconds go by; if the latter happens the idempotent repository may be in an
inconsistent state until its consumer catches up to the end of the topic.
+On startup, the instance subscribes to the topic, rewinds the offset to the
beginning and rebuilds the cache to the latest state. The cache will not be
considered warmed up until one poll of `pollDurationMs` in length returns 0
records. Startup will not be completed until either the cache has warmed up, or
30 seconds go by; if the latter happens the idempotent repository may be in an
inconsistent state until its consumer catches up to the end of the topic.
Be mindful of the format of the header used for the uniqueness check. By
default, it uses Strings as the data types. When using primitive numeric
formats, the header must be deserialized accordingly. Check the samples below
for examples.
A `KafkaIdempotentRepository` has the following properties:
@@ -303,7 +303,7 @@ from("direct:performInsert")
.end()
----
-Alternatively, it is possible use a custom serializer configured via the route
URL to perform the conversion:
+Alternatively, it is possible to use a custom serializer configured via the
route URL to perform the conversion:
[source,java]
----
@@ -341,7 +341,7 @@ from(from).routeId("foo")
== Using manual commit with Kafka consumer
-By default the Kafka consumer will use auto commit, where the offset will be
committed automatically in the background using a given interval.
+By default, the Kafka consumer will use auto commit, where the offset will be
committed automatically in the background using a given interval.
In case you want to force manual commits, you can use `KafkaManualCommit` API
from the Camel Exchange, stored on the message header.
This requires to turn on manual commits by either setting the option
`allowManualCommit` to `true` on the `KafkaComponent`
@@ -355,7 +355,7 @@ kafka.setAllowManualCommit(true);
camelContext.addComponent("kafka", kafka);
----
-You can then use the `KafkaManualCommit` from Java code such as a Camel
`Processor`:
+Then you can use the `KafkaManualCommit` from Java code such as a Camel
`Processor`:
[source,java]
----
public void process(Exchange exchange) {
@@ -365,12 +365,12 @@ public void process(Exchange exchange) {
}
----
-This will force a synchronous commit which will block until the commit is
acknowledge on Kafka, or if it fails an exception is thrown.
+This will force a synchronous commit which will block until the commit is
acknowledged on Kafka, or if it fails an exception is thrown.
You can use an asynchronous commit as well by configuring the
`KafkaManualCommitFactory` with the `DefaultKafkaManualAsyncCommitFactory`
implementation.
-The commit will then be done in the next consumer loop using the kafka
asynchronous commit api.
+Then the commit will be done in the next consumer loop using the kafka
asynchronous commit api.
Be aware that records from a partition must be processed and committed by a
unique thread.
-If not, this could lead with non consistent behaviors.
+If not, this could lead with non-consistent behaviors.
This is mostly useful with aggregation's completion timeout strategies.
If you want to use a custom implementation of `KafkaManualCommit` then you can
configure a custom `KafkaManualCommitFactory`
@@ -410,7 +410,7 @@ from("kafka:my_topic?headerDeserializer=#myDeserializer")
.to("kafka:my_topic?headerSerializer=#mySerializer")
----
-By default all headers are being filtered by `KafkaHeaderFilterStrategy`.
+By default, all headers are being filtered by `KafkaHeaderFilterStrategy`.
Strategy filters out headers which start with `Camel` or `org.apache.camel`
prefixes.
Default strategy can be overridden by using `headerFilterStrategy` uri
parameter in both `to` and `from` routes:
