This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch camel-spring-boot-4.0.x
in repository https://gitbox.apache.org/repos/asf/camel-spring-boot.git


The following commit(s) were added to refs/heads/camel-spring-boot-4.0.x by 
this push:
     new 51940e7b026 Regen
51940e7b026 is described below

commit 51940e7b026b3dcdfff2ac483237bb3b688e2841
Author: Claus Ibsen <[email protected]>
AuthorDate: Fri Dec 22 09:16:11 2023 +0100

    Regen
---
 .../apache/camel/springboot/catalog/components/kafka.json  |  4 ++--
 .../camel-kafka-starter/src/main/docs/kafka.json           |  2 +-
 .../kafka/springboot/KafkaComponentConfiguration.java      | 14 +++++++++-----
 3 files changed, 12 insertions(+), 8 deletions(-)

diff --git 
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/kafka.json
 
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/kafka.json
index 14051479650..c00a590b1a5 100644
--- 
a/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/kafka.json
+++ 
b/catalog/camel-catalog-provider-springboot/src/main/resources/org/apache/camel/springboot/catalog/components/kafka.json
@@ -33,7 +33,7 @@
     "autoCommitEnable": { "index": 8, "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 b [...]
     "autoCommitIntervalMs": { "index": 9, "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 t [...]
     "autoOffsetReset": { "index": 10, "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 i [...]
-    "breakOnFirstError": { "index": 11, "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  [...]
+    "breakOnFirstError": { "index": 11, "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  [...]
     "bridgeErrorHandler": { "index": 12, "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 proc [...]
     "checkCrcs": { "index": 13, "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 o [...]
     "commitTimeoutMs": { "index": 14, "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 synchron [...]
@@ -162,7 +162,7 @@
     "autoCommitEnable": { "index": 8, "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  [...]
     "autoCommitIntervalMs": { "index": 9, "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  [...]
     "autoOffsetReset": { "index": 10, "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  [...]
-    "breakOnFirstError": { "index": 11, "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 [...]
+    "breakOnFirstError": { "index": 11, "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 [...]
     "checkCrcs": { "index": 12, "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  [...]
     "commitTimeoutMs": { "index": 13, "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 synchro [...]
     "consumerRequestTimeoutMs": { "index": 14, "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": "30000", "configurationClass": 
"org.apache.camel.component.kafka.KafkaConfiguration", "configurationField": 
"configuration", "description": "The configuration controls the maximum amount 
of t [...]
diff --git a/components-starter/camel-kafka-starter/src/main/docs/kafka.json 
b/components-starter/camel-kafka-starter/src/main/docs/kafka.json
index bd855acebb7..16dd8678bda 100644
--- a/components-starter/camel-kafka-starter/src/main/docs/kafka.json
+++ b/components-starter/camel-kafka-starter/src/main/docs/kafka.json
@@ -64,7 +64,7 @@
     {
       "name": "camel.component.kafka.break-on-first-error",
       "type": "java.lang.Boolean",
-      "description": "This options controls what happens when a consumer is 
processing an exchange and it fails. If the option is false then the consumer 
continues to the next message and processes it. If the option is true then the 
consumer breaks out, and will seek back to offset of the message that caused a 
failure, and then re-attempt to process this message. However this can lead to 
endless processing of the same message if its bound to fail every time, eg a 
poison message. Therefor [...]
+      "description": "This options controls what happens when a consumer is 
processing an exchange and it fails. If the option is false then the consumer 
continues to the next message and processes it. If the option is true then the 
consumer breaks out. Using the default NoopCommitManager will cause the 
consumer to not commit the offset so that the message is re-attempted. The 
consumer should use the KafkaManualCommit to determine the best way to handle 
the message. Using either the Sync [...]
       "sourceType": 
"org.apache.camel.component.kafka.springboot.KafkaComponentConfiguration",
       "defaultValue": false
     },
diff --git 
a/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
 
b/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
index 21e0c873a50..962e277e622 100644
--- 
a/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
+++ 
b/components-starter/camel-kafka-starter/src/main/java/org/apache/camel/component/kafka/springboot/KafkaComponentConfiguration.java
@@ -121,11 +121,15 @@ public class KafkaComponentConfiguration
      * This options controls what happens when a consumer is processing an
      * exchange and it fails. If the option is false then the consumer 
continues
      * to the next message and processes it. If the option is true then the
-     * consumer breaks out, and will seek back to offset of the message that
-     * caused a failure, and then re-attempt to process this message. However
-     * this can lead to endless processing of the same message if its bound to
-     * fail every time, eg a poison message. Therefore it is recommended to 
deal
-     * with that for example by using Camel's error handler.
+     * consumer breaks out. Using the default NoopCommitManager will cause the
+     * consumer to not commit the offset so that the message is re-attempted.
+     * The consumer should use the KafkaManualCommit to determine the best way
+     * to handle the message. Using either the SynchCommitManager or the
+     * AsynchCommitManager the consumer will seek back to the offset of the
+     * message that caused a failure, and then re-attempt to process this
+     * message. However this can lead to endless processing of the same message
+     * if its bound to fail every time, eg a poison message. Therefore its
+     * recommended to deal with that for example by using Camel's error 
handler.
      */
     private Boolean breakOnFirstError = false;
     /**

Reply via email to