Claus Ibsen created CAMEL-27186:
-----------------------------------
Summary: camel-azure-servicebus - enableDeadLettering description
is wrong
Key: CAMEL-27186
URL: https://issues.apache.org/jira/browse/CAMEL-27186
Project: Camel
Issue Type: Bug
Components: camel-azure-servicebus
Reporter: Claus Ibsen
h3. Problem
The javadoc (and so the option description in the catalog and docs) of
{{enableDeadLettering}} reads:
{noformat}
Enable application level deadlettering to the subscription deadletter subqueue
if deadletter related headers are set.
{noformat}
What the consumer does ({{ServiceBusConsumer}}, the {{onFailure}} of the
exchange's completion):
* when an exchange fails, in {{PEEK_LOCK}} mode, the message is dead-lettered
instead of abandoned; the exception becomes the dead-letter reason and its
stack trace the error description (bounded, CAMEL-25660);
* it applies to queues as well as topic subscriptions (the message goes to the
dead-letter queue of the entity it was read from), not only to subscriptions;
* no headers are involved: nothing in the route has to set dead-letter headers;
* it does nothing in {{RECEIVE_AND_DELETE}} mode, and nothing when {{subQueue}}
is set (reading a dead-letter queue), where the message is abandoned.
Verified while adding the option to the Kamelet {{azure-servicebus-source}}: on
a plain queue, a session queue and a topic subscription, a failing message was
dead-lettered once with the exception as reason.
h3. Where
{{components/camel-azure/camel-azure-servicebus/src/main/java/org/apache/camel/component/azure/servicebus/ServiceBusConfiguration.java}}
- javadoc of {{isEnableDeadLettering}}; behaviour in
{{components/camel-azure/camel-azure-servicebus/src/main/java/org/apache/camel/component/azure/servicebus/ServiceBusConsumer.java}}
- {{onFailure}}.
h3. Suggested fix
Reword the javadoc, for example:
{noformat}
Dead-letters a message whose exchange failed, instead of abandoning it, with
the exception as the dead-letter reason
and its stack trace as the error description. Applies to queues and
subscriptions, only in PEEK_LOCK receive mode,
and not when reading a sub-queue (subQueue).
{noformat}
and regenerate the component metadata and docs.
--
This message was sent by Atlassian Jira
(v10.3.26#10030026)