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 f0c246e6cc26 camel-core-xml: fix three wrong attribute docs on
redeliveryPolicyProfile (#29950)
f0c246e6cc26 is described below
commit f0c246e6cc2621ec6f9bb0f1d5b691857a3b2e42
Author: dhairya05 <[email protected]>
AuthorDate: Sun Nov 15 01:06:30 2026 +0530
camel-core-xml: fix three wrong attribute docs on redeliveryPolicyProfile
(#29950)
…file
AbstractCamelRedeliveryPolicyFactoryBean carries its own @Metadata copy
of the redelivery policy options, and camel-spring.xsd ends up with both
it and the RedeliveryPolicyDefinition copy, so the same attribute is
documented twice in one schema. Three of the profile copies disagree
with the model, and are wrong rather than merely terser:
* redeliveryDelay carried maximumRedeliveryDelay's text, "Sets the
maximum redelivery delay. Use -1 if you wish to have no maximum",
describing the wrong option. It is the initial delay before the first
attempt; -1 means nothing to it.
* retryAttemptedLogInterval declared defaultValue=0, while
RedeliveryPolicy initialises it to 1, and did not say what the number
means.
* logRetryStackTrace carried logStackTrace's text, so the two attributes
read identically and nothing said this one is about failed retries.
All three now use the RedeliveryPolicyDefinition wording, so both copies
of each attribute in camel-spring.xsd read the same.
---
.../org/apache/camel/catalog/schemas/camel-spring.xsd | 7 ++++---
.../org/apache/camel/spring/xml/redeliveryPolicyProfile.json | 6 +++---
.../core/xml/AbstractCamelRedeliveryPolicyFactoryBean.java | 10 +++++++---
3 files changed, 14 insertions(+), 9 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
index b7f6676da99f..cf1aec01c1fe 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/schemas/camel-spring.xsd
@@ -2573,7 +2573,7 @@ Sets the maximum number of times a message exchange will
be redelivered. Setting
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-Sets the maximum redelivery delay. Use -1 if you wish to have no maximum.
Default value: 1000
+Sets the initial delay in milliseconds before the first redelivery attempt.
Default value: 1000
]]>
</xs:documentation>
</xs:annotation>
@@ -2660,7 +2660,7 @@ Sets the logging level to use for log messages when
retries are attempted. Defau
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-Sets the interval for log messages when retries are attempted. Default value: 0
+Sets how often to log redelivery attempts. For example, a value of 3 logs
every 3rd redelivery attempt. Default value: 1
]]>
</xs:documentation>
</xs:annotation>
@@ -2687,7 +2687,8 @@ Sets whether stack traces should be logged or not.
Default value: true
<xs:annotation>
<xs:documentation xml:lang="en">
<![CDATA[
-Sets whether stack traces should be logged or not. Default value: false
+Whether stack traces should be logged when a retry attempt failed. Can be used
to include or reduce verbose logging.
+Default value: false
]]>
</xs:documentation>
</xs:annotation>
diff --git
a/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/redeliveryPolicyProfile.json
b/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/redeliveryPolicyProfile.json
index f3051094f210..ce470e6ce027 100644
---
a/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/redeliveryPolicyProfile.json
+++
b/components/camel-spring-parent/camel-spring-xml/src/generated/resources/META-INF/org/apache/camel/spring/xml/redeliveryPolicyProfile.json
@@ -14,7 +14,7 @@
"properties": {
"id": { "index": 0, "kind": "attribute", "displayName": "Id", "group":
"common", "required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "The
id of this node" },
"maximumRedeliveries": { "index": 1, "kind": "attribute", "displayName":
"Maximum Redeliveries", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets the maximum number of times a message
exchange will be redelivered. Setting a negative value will retry forever." },
- "redeliveryDelay": { "index": 2, "kind": "attribute", "displayName":
"Redelivery Delay", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "description": "Sets the maximum
redelivery delay. Use -1 if you wish to have no maximum" },
+ "redeliveryDelay": { "index": 2, "kind": "attribute", "displayName":
"Redelivery Delay", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "1000", "description": "Sets the initial delay
in milliseconds before the first redelivery attempt." },
"asyncDelayedRedelivery": { "index": 3, "kind": "attribute",
"displayName": "Async Delayed Redelivery", "group": "common", "required":
false, "type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Sets whether asynchronous delayed redelivery is allowed. This is disabled by
default. When enabled it allows Camel to schedule a future task for delayed
redelivery which prevents current thread fro [...]
"backOffMultiplier": { "index": 4, "kind": "attribute", "displayName":
"Back Off Multiplier", "group": "common", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": "2", "description": "Sets the multiplier used
to increase the delay between redeliveries if useExponentialBackOff is enabled"
},
"useExponentialBackOff": { "index": 5, "kind": "attribute", "displayName":
"Use Exponential Back Off", "group": "common", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description":
"Enables\/disables exponential backoff using the backOffMultiplier to increase
the time between retries" },
@@ -23,10 +23,10 @@
"maximumRedeliveryDelay": { "index": 8, "kind": "attribute",
"displayName": "Maximum Redelivery Delay", "group": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "60000", "description":
"Sets the maximum redelivery delay. Use -1 if you wish to have no maximum" },
"retriesExhaustedLogLevel": { "index": 9, "kind": "attribute",
"displayName": "Retries Exhausted Log Level", "group": "common", "required":
false, "type": "enum", "javaType": "java.lang.String", "enum": [ "TRACE",
"DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "ERROR", "description": "Sets the
logging level to use for log messages when retries have been exhausted." },
"retryAttemptedLogLevel": { "index": 10, "kind": "attribute",
"displayName": "Retry Attempted Log Level", "group": "common", "required":
false, "type": "enum", "javaType": "java.lang.String", "enum": [ "TRACE",
"DEBUG", "INFO", "WARN", "ERROR", "OFF" ], "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "DEBUG", "description": "Sets the
logging level to use for log messages when retries are attempted." },
- "retryAttemptedLogInterval": { "index": 11, "kind": "attribute",
"displayName": "Retry Attempted Log Interval", "group": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "0", "description": "Sets
the interval for log messages when retries are attempted." },
+ "retryAttemptedLogInterval": { "index": 11, "kind": "attribute",
"displayName": "Retry Attempted Log Interval", "group": "common", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "1", "description": "Sets
how often to log redelivery attempts. For example, a value of 3 logs every 3rd
redelivery attempt." },
"logRetryAttempted": { "index": 12, "kind": "attribute", "displayName":
"Log Retry Attempted", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Sets whether to log
retry attempts" },
"logStackTrace": { "index": 13, "kind": "attribute", "displayName": "Log
Stack Trace", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Sets whether stack
traces should be logged or not" },
- "logRetryStackTrace": { "index": 14, "kind": "attribute", "displayName":
"Log Retry Stack Trace", "group": "common", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Sets whether
stack traces should be logged or not" },
+ "logRetryStackTrace": { "index": 14, "kind": "attribute", "displayName":
"Log Retry Stack Trace", "group": "common", "required": false, "type":
"boolean", "javaType": "java.lang.Boolean", "deprecated": false, "autowired":
false, "secret": false, "defaultValue": false, "description": "Whether stack
traces should be logged when a retry attempt failed. Can be used to include or
reduce verbose logging." },
"logHandled": { "index": 15, "kind": "attribute", "displayName": "Log
Handled", "group": "common", "required": false, "type": "boolean", "javaType":
"java.lang.Boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Sets whether errors should be logged
even if its handled" },
"logNewException": { "index": 16, "kind": "attribute", "displayName": "Log
New Exception", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": true, "description": "Sets whether errors
should be logged when a new exception occurred during handling a previous
exception" },
"logContinued": { "index": 17, "kind": "attribute", "displayName": "Log
Continued", "group": "common", "required": false, "type": "boolean",
"javaType": "java.lang.Boolean", "deprecated": false, "autowired": false,
"secret": false, "defaultValue": false, "description": "Sets whether errors
should be logged even if its continued" },
diff --git
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelRedeliveryPolicyFactoryBean.java
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelRedeliveryPolicyFactoryBean.java
index 9f661595dfd0..f4cc8beb3535 100644
---
a/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelRedeliveryPolicyFactoryBean.java
+++
b/core/camel-core-xml/src/main/java/org/apache/camel/core/xml/AbstractCamelRedeliveryPolicyFactoryBean.java
@@ -36,7 +36,8 @@ public abstract class
AbstractCamelRedeliveryPolicyFactoryBean extends AbstractC
@Metadata(description = "Sets the maximum number of times a message
exchange will be redelivered. Setting a negative value will retry forever.")
private String maximumRedeliveries;
@XmlAttribute
- @Metadata(defaultValue = "1000", description = "Sets the maximum
redelivery delay. Use -1 if you wish to have no maximum")
+ @Metadata(defaultValue = "1000",
+ description = "Sets the initial delay in milliseconds before the
first redelivery attempt.")
private String redeliveryDelay;
@XmlAttribute
@Metadata(defaultValue = "false", javaType = "java.lang.Boolean",
@@ -72,7 +73,9 @@ public abstract class
AbstractCamelRedeliveryPolicyFactoryBean extends AbstractC
description = "Sets the logging level to use for log messages
when retries are attempted.")
private String retryAttemptedLogLevel;
@XmlAttribute
- @Metadata(defaultValue = "0", description = "Sets the interval for log
messages when retries are attempted.")
+ @Metadata(defaultValue = "1",
+ description = "Sets how often to log redelivery attempts. For
example, a value of 3 logs "
+ + "every 3rd redelivery attempt.")
private String retryAttemptedLogInterval;
@XmlAttribute
@Metadata(defaultValue = "true", javaType = "java.lang.Boolean",
description = "Sets whether to log retry attempts")
@@ -83,7 +86,8 @@ public abstract class
AbstractCamelRedeliveryPolicyFactoryBean extends AbstractC
private String logStackTrace;
@XmlAttribute
@Metadata(defaultValue = "false", javaType = "java.lang.Boolean",
- description = "Sets whether stack traces should be logged or
not")
+ description = "Whether stack traces should be logged when a
retry attempt failed. "
+ + "Can be used to include or reduce verbose
logging.")
private String logRetryStackTrace;
@XmlAttribute
@Metadata(defaultValue = "false", javaType = "java.lang.Boolean",
