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 95fd9a1eeec camel-azure-servicebus: Tidy component documentation
(#16984)
95fd9a1eeec is described below
commit 95fd9a1eeec5220d51cdf9034b489986468aedc7
Author: James Netherton <[email protected]>
AuthorDate: Thu Jan 30 08:10:43 2025 +0000
camel-azure-servicebus: Tidy component documentation (#16984)
---
.../src/main/docs/azure-servicebus-component.adoc | 27 +++++++---------------
1 file changed, 8 insertions(+), 19 deletions(-)
diff --git
a/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
b/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
index c8d81e65c3b..9bf56c66084 100644
---
a/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
+++
b/components/camel-azure/camel-azure-servicebus/src/main/docs/azure-servicebus-component.adoc
@@ -60,7 +60,7 @@ This component implements the Consumer and Producer.
=== Authentication Information
-You have three different Credential Types: AZURE_IDENTITY, TOKEN_CREDENTIAL
and CONNECTION_STRING. You can also provide a client instance yourself.
+There are three different Credential Types: `AZURE_IDENTITY`,
`TOKEN_CREDENTIAL` and `CONNECTION_STRING`.
To use this component, you have three options to provide the required Azure
authentication information:
*CONNECTION_STRING*:
@@ -77,33 +77,24 @@ See the documentation
https://docs.microsoft.com/en-us/azure/active-directory/au
- This will use `com.azure.identity.DefaultAzureCredentialBuilder().build();`
instance. This will follow the Default Azure Credential Chain.
See the documentation
https://docs.microsoft.com/en-us/azure/active-directory/authentication/overview-authentication[here
about Azure-AD authentication].
-*Client instance*:
+=== Custom Client Instance
-- You can provide a `com.azure.messaging.servicebus.ServiceBusSenderClient`
for sending message and/or
`com.azure.messaging.servicebus.ServiceBusReceiverClient` to receive messages.
If you provide the instances, they will be autowired.
+It is possible to provide a custom client instance on either the consumer or
producer endpoints.
+`com.azure.messaging.servicebus.ServiceBusSenderClient` for sending messages
and `com.azure.messaging.servicebus.ServiceBusReceiverClient` to receive
messages.
+When clients are bound to the Camel registry, they will be autowired into the
Service Bus component.
=== Message Body
-In the producer, this component accepts message body of `String`, `byte[]` and
`BinaryData` types or `List<String>`, `List<byte[]>` and `List<BinaryData>` to
send batch messages.
-
-In the consumer, the returned message body will be of type `String.
+In the producer, this component accepts a message body of `String`, `byte[]`
and `BinaryData` types. Or `List<String>`, `List<byte[]>` and
`List<BinaryData>` to send batch messages.
+In the consumer, the returned message body will be of type `String`.
=== Azure ServiceBus Producer operations
[width="100%",cols="10%,90%",options="header",]
|===
|Operation |Description
|`sendMessages` | Sends a set of messages to a Service Bus queue or topic
using a batched approach.
-|`scheduleMessages` | Sends a scheduled message to the Azure Service Bus
entity this sender is connected to. A scheduled message is enqueued and made
available to receivers only at the scheduled enqueue time.
-|===
-
-
-=== Azure ServiceBus Consumer operations
-[width="100%",cols="10%,90%",options="header",]
+|`scheduleMessages` | Sends a scheduled message to the Azure Service Bus
queue or topic. A scheduled message is enqueued and made available to receivers
only at the scheduled time.
|===
-|Operation |Description
-|`receiveMessages` | Receives an <b>infinite</b> stream of messages from the
Service Bus entity.
-|`peekMessages` | Reads the next batch of active messages without changing
the state of the receiver or the message source.
-|===
-
== Examples
@@ -177,6 +168,4 @@
from("azure-servicebus:test//?connectionString=test&sessionEnabled=true")
.to("mock:result");
--------------------------------------------------------------------------------
-
-
include::spring-boot:partial$starter.adoc[]
