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 2604205 Regen for commit 1a244126519a3410cfd30c577fc4affcd17e9c91
(#5798)
2604205 is described below
commit 260420509e80f3dab57b13ff85c9ed21002a1c27
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Jul 6 18:55:54 2021 +0200
Regen for commit 1a244126519a3410cfd30c577fc4affcd17e9c91 (#5798)
Signed-off-by: GitHub <[email protected]>
Co-authored-by: coheigea <[email protected]>
---
bom/camel-bom/pom.xml | 4 +-
.../catalog/docs/azure-servicebus-component.adoc | 29 ---
.../apache/camel/catalog/docs/file-component.adoc | 2 +-
.../AzureServicebusComponentBuilderFactory.java | 2 +-
.../builder/endpoint/StaticEndpointBuilders.java | 10 +-
.../dsl/ServiceBusEndpointBuilderFactory.java | 4 +-
docs/components/modules/ROOT/nav.adoc | 1 +
.../ROOT/pages/azure-servicebus-component.adoc | 240 ++++++++++++++++++++-
.../modules/ROOT/pages/file-component.adoc | 2 +-
9 files changed, 249 insertions(+), 45 deletions(-)
diff --git a/bom/camel-bom/pom.xml b/bom/camel-bom/pom.xml
index b396f38c..ee75f46 100644
--- a/bom/camel-bom/pom.xml
+++ b/bom/camel-bom/pom.xml
@@ -278,12 +278,12 @@
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-azure-servicebus</artifactId>
+ <artifactId>camel-azure-parent</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
- <artifactId>camel-azure-parent</artifactId>
+ <artifactId>camel-azure-servicebus</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/azure-servicebus-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/azure-servicebus-component.adoc
deleted file mode 100644
index 161ed3b..0000000
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/azure-servicebus-component.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-[[azure-servicebus-component]]
-= Azure ServiceBus Component
-:docTitle: Azure ServiceBus
-:artifactId: camel-azure-servicebus
-:description: The azure-servicebus component that integrates Azure ServiceBus.
Azure ServiceBus is a fully managed enterprise integration message broker.
Service Bus can decouple applications and services. Service Bus offers a
reliable and secure platform for asynchronous transfer of data and state. Data
is transferred between different applications and services using messages.
-:since: 3.12
-:supportLevel: Preview
-:component-header: Both producer and consumer are supported
-include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/azure-servicebus.adoc[opts=optional]
-//Manually maintained attributes
-:group: Azure
-
-*Since Camel {since}*
-
-*{component-header}*
-
-```
-
-=== Development Notes (Important)
-When developing on this component, you will need to obtain your Azure
accessKey in order to run the integration tests. In addition to the mocked unit
tests
-you *will need to run the integration tests with every change you make or even
client upgrade as the Azure client can break things even on minor versions
upgrade.*
-To run the integration tests, on this component directory, run the following
maven command:
-----
-mvn verify -PfullTests -DconnectionString=string -DblobAccountName=blob
-DblobAccessKey=key
-----
-Whereby `blobAccountName` is your Azure account name and `blobAccessKey` is
the access key being generated from Azure portal and `connectionString` is the
eventHub connection string.
-
-
-include::{page-component-version}@camel-spring-boot::page$azure-servicebus-starter.adoc[]
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/file-component.adoc
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/file-component.adoc
index 887eebc..557fdd0 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/file-component.adoc
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/docs/file-component.adoc
@@ -637,7 +637,7 @@ Will for example create a file named `foo.done` if the
target file was
== Samples
-#=== Read from a directory and write to another directory
+=== Read from a directory and write to another directory
[source,java]
----
diff --git
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureServicebusComponentBuilderFactory.java
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureServicebusComponentBuilderFactory.java
index 0000b25..52ec6c3 100644
---
a/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureServicebusComponentBuilderFactory.java
+++
b/core/camel-componentdsl/src/generated/java/org/apache/camel/builder/component/dsl/AzureServicebusComponentBuilderFactory.java
@@ -307,7 +307,7 @@ public interface AzureServicebusComponentBuilderFactory {
* The option is a:
*
<code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code>
type.
*
- * Default: PEER_LOCK
+ * Default: PEEK_LOCK
* Group: consumer
*
* @param serviceBusReceiveMode the value to set
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
index 4b7e089..6ecfdf8 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/StaticEndpointBuilders.java
@@ -1961,7 +1961,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>azure-servicebus:queueNameOrTopicName</code>
*
* Path parameter: topicOrQueueName
- * d
+ * Selected topic name or the queue name, that is depending on
+ * serviceBusType config. For example if serviceBusType=queue, then this
+ * will be the queue name and if serviceBusType=topic, this will be the
+ * topic name.
*
* @param path queueNameOrTopicName
* @return the dsl builder
@@ -1986,7 +1989,10 @@ public class StaticEndpointBuilders {
* Syntax: <code>azure-servicebus:queueNameOrTopicName</code>
*
* Path parameter: topicOrQueueName
- * d
+ * Selected topic name or the queue name, that is depending on
+ * serviceBusType config. For example if serviceBusType=queue, then this
+ * will be the queue name and if serviceBusType=topic, this will be the
+ * topic name.
*
* @param componentName to use a custom component name for the endpoint
* instead of the default name
diff --git
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ServiceBusEndpointBuilderFactory.java
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ServiceBusEndpointBuilderFactory.java
index 4dbfd3b..76cc138 100644
---
a/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ServiceBusEndpointBuilderFactory.java
+++
b/core/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/ServiceBusEndpointBuilderFactory.java
@@ -513,7 +513,7 @@ public interface ServiceBusEndpointBuilderFactory {
* The option is a:
*
<code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code>
type.
*
- * Default: PEER_LOCK
+ * Default: PEEK_LOCK
* Group: consumer
*
* @param serviceBusReceiveMode the value to set
@@ -530,7 +530,7 @@ public interface ServiceBusEndpointBuilderFactory {
* The option will be converted to a
*
<code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code>
type.
*
- * Default: PEER_LOCK
+ * Default: PEEK_LOCK
* Group: consumer
*
* @param serviceBusReceiveMode the value to set
diff --git a/docs/components/modules/ROOT/nav.adoc
b/docs/components/modules/ROOT/nav.adoc
index a6c6302..1c712a8 100644
--- a/docs/components/modules/ROOT/nav.adoc
+++ b/docs/components/modules/ROOT/nav.adoc
@@ -46,6 +46,7 @@
** xref:azure-summary.adoc[Azure]
*** xref:azure-cosmosdb-component.adoc[Azure CosmosDB]
*** xref:azure-eventhubs-component.adoc[Azure Event Hubs]
+*** xref:azure-servicebus-component.adoc[Azure ServiceBus]
*** xref:azure-storage-blob-component.adoc[Azure Storage Blob Service]
*** xref:azure-storage-datalake-component.adoc[Azure storage datalake service]
*** xref:azure-storage-queue-component.adoc[Azure Storage Queue Service]
diff --git a/docs/components/modules/ROOT/pages/azure-servicebus-component.adoc
b/docs/components/modules/ROOT/pages/azure-servicebus-component.adoc
index a4da533..04664ff 100644
--- a/docs/components/modules/ROOT/pages/azure-servicebus-component.adoc
+++ b/docs/components/modules/ROOT/pages/azure-servicebus-component.adoc
@@ -16,16 +16,242 @@
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/azure-serv
*{component-header}*
-```
+The azure-servicebus component that integrates
https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-messaging-overview[Azure
ServiceBus]. Azure ServiceBus is a fully managed enterprise
+integration message broker. Service Bus can decouple applications and
services. Service Bus offers a reliable and secure platform for asynchronous
transfer of data and state. Data is transferred between different applications
and
+ services using messages.
+
+Prerequisites
+
+You must have a valid Windows Azure Storage account. More information is
available at
+https://docs.microsoft.com/azure/[Azure Documentation Portal].
+
+[source,xml]
+------------------------------------------------------------
+<dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-azure-servicebus</artifactId>
+ <version>x.x.x</version>
+ <!-- use the same version as your Camel core version -->
+</dependency>
+------------------------------------------------------------
+
+== URI Options
+// endpoint options: START
+The Azure ServiceBus endpoint is configured using URI syntax:
-=== Development Notes (Important)
-When developing on this component, you will need to obtain your Azure
accessKey in order to run the integration tests. In addition to the mocked unit
tests
-you *will need to run the integration tests with every change you make or even
client upgrade as the Azure client can break things even on minor versions
upgrade.*
-To run the integration tests, on this component directory, run the following
maven command:
----
-mvn verify -PfullTests -DconnectionString=string -DblobAccountName=blob
-DblobAccessKey=key
+azure-servicebus:queueNameOrTopicName
----
-Whereby `blobAccountName` is your Azure account name and `blobAccessKey` is
the access key being generated from Azure portal and `connectionString` is the
eventHub connection string.
+
+with the following path and query parameters:
+
+=== Path Parameters (1 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *topicOrQueueName* | Selected topic name or the queue name, that is
depending on serviceBusType config. For example if serviceBusType=queue, then
this will be the queue name and if serviceBusType=topic, this will be the topic
name. | | String
+|===
+
+
+=== Query Parameters (23 parameters):
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *amqpRetryOptions* (common) | Sets the retry options for Service Bus
clients. If not specified, the default retry options are used. | |
AmqpRetryOptions
+| *amqpTransportType* (common) | Sets the transport type by which all the
communication with Azure Service Bus occurs. Default value is
AmqpTransportType#AMQP. There are 2 enums and the value can be one of: Amqp,
AmqpWebSockets | AMQP | AmqpTransportType
+| *clientOptions* (common) | Sets the ClientOptions to be sent from the client
built from this builder, enabling customization of certain properties, as well
as support the addition of custom header information. Refer to the
ClientOptions documentation for more information. | | ClientOptions
+| *proxyOptions* (common) | Sets the proxy configuration to use for
ServiceBusSenderAsyncClient. When a proxy is configured,
AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. | |
ProxyOptions
+| *serviceBusType* (common) | *Required* The service bus type of connection to
execute. Queue is for typical queue option and topic for subscription based
model. There are 2 enums and the value can be one of: queue, topic | queue |
ServiceBusType
+| *bridgeErrorHandler* (consumer) | 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 message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *consumerOperation* (consumer) | Sets the desired operation to be used in
the consumer. There are 2 enums and the value can be one of: receiveMessages,
peekMessages | receiveMessages | ServiceBusConsumerOperationDefinition
+| *disableAutoComplete* (consumer) | Disables auto-complete and auto-abandon
of received messages. By default, a successfully processed message is {link
ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}.
If an error happens when the message is processed, it is {link
ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}. |
false | boolean
+| *maxAutoLockRenewDuration* (consumer) | Sets the amount of time to continue
auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal.
For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode,
auto-renewal is disabled. | 5min | Duration
+| *peekNumMaxMessages* (consumer) | Set the max number of messages to be
peeked during the peek operation. | | Integer
+| *prefetchCount* (consumer) | Sets the prefetch count of the receiver. For
both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link
ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default
value is 1. Prefetch speeds up the message flow by aiming to have a message
readily available for local retrieval when and before the application asks for
one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero
value will prefetch that number of messa [...]
+| *receiverAsyncClient* (consumer) | *Autowired* Sets the receiverAsyncClient
in order to consume messages in the Consumer | | ServiceBusReceiverAsyncClient
+| *serviceBusReceiveMode* (consumer) | Sets the receive mode for the receiver.
There are 2 enums and the value can be one of: PEEK_LOCK, RECEIVE_AND_DELETE |
PEEK_LOCK | ServiceBusReceiveMode
+| *subQueue* (consumer) | Sets the type of the SubQueue to connect to. There
are 3 enums and the value can be one of: NONE, DEAD_LETTER_QUEUE,
TRANSFER_DEAD_LETTER_QUEUE | | SubQueue
+| *subscriptionName* (consumer) | Sets the name of the subscription in the
topic to listen to. topicOrQueueName and serviceBusType=topic must also be set.
| | String
+| *exceptionHandler* (consumer) | To let the consumer use a custom
ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this
option is not in use. By default the consumer will deal with exceptions, that
will be logged at WARN or ERROR level and ignored. | | ExceptionHandler
+| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer
creates an exchange. There are 3 enums and the value can be one of: InOnly,
InOut, InOptionalOut | | ExchangePattern
+| *lazyStartProducer* (producer) | 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
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *producerOperation* (producer) | Sets the desired operation to be used in
the producer. There are 2 enums and the value can be one of: sendMessages,
scheduleMessages | sendMessages | ServiceBusProducerOperationDefinition
+| *scheduledEnqueueTime* (producer) | Sets OffsetDateTime at which the message
should appear in the Service Bus queue or topic. | | OffsetDateTime
+| *senderAsyncClient* (producer) | *Autowired* Sets SenderAsyncClient to be
used in the producer. | | ServiceBusSenderAsyncClient
+| *serviceBusTransactionContext* (producer) | Represents transaction in
service. This object just contains transaction id. | |
ServiceBusTransactionContext
+| *connectionString* (security) | *Required* Sets the connection string for a
Service Bus namespace or a specific Service Bus resource. | | String
+|===
+// endpoint options: END
+
+== Component Options
+// component options: START
+The Azure ServiceBus component supports 23 options, which are listed below.
+
+
+
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Type
+| *amqpRetryOptions* (common) | Sets the retry options for Service Bus
clients. If not specified, the default retry options are used. | |
AmqpRetryOptions
+| *amqpTransportType* (common) | Sets the transport type by which all the
communication with Azure Service Bus occurs. Default value is
AmqpTransportType#AMQP. There are 2 enums and the value can be one of: Amqp,
AmqpWebSockets | AMQP | AmqpTransportType
+| *clientOptions* (common) | Sets the ClientOptions to be sent from the client
built from this builder, enabling customization of certain properties, as well
as support the addition of custom header information. Refer to the
ClientOptions documentation for more information. | | ClientOptions
+| *configuration* (common) | The component configurations | |
ServiceBusConfiguration
+| *proxyOptions* (common) | Sets the proxy configuration to use for
ServiceBusSenderAsyncClient. When a proxy is configured,
AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. | |
ProxyOptions
+| *serviceBusType* (common) | *Required* The service bus type of connection to
execute. Queue is for typical queue option and topic for subscription based
model. There are 2 enums and the value can be one of: queue, topic | queue |
ServiceBusType
+| *bridgeErrorHandler* (consumer) | 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 message and handled by the routing Error Handler. By default the
consumer will use the org.apache.camel.spi.ExceptionHandler to deal with
exceptions, that will be logged at WARN or ERROR level and ignored. | false |
boolean
+| *consumerOperation* (consumer) | Sets the desired operation to be used in
the consumer. There are 2 enums and the value can be one of: receiveMessages,
peekMessages | receiveMessages | ServiceBusConsumerOperationDefinition
+| *disableAutoComplete* (consumer) | Disables auto-complete and auto-abandon
of received messages. By default, a successfully processed message is {link
ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage) completed}.
If an error happens when the message is processed, it is {link
ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage) abandoned}. |
false | boolean
+| *maxAutoLockRenewDuration* (consumer) | Sets the amount of time to continue
auto-renewing the lock. Setting Duration#ZERO or null disables auto-renewal.
For {link ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} mode,
auto-renewal is disabled. | 5min | Duration
+| *peekNumMaxMessages* (consumer) | Set the max number of messages to be
peeked during the peek operation. | | Integer
+| *prefetchCount* (consumer) | Sets the prefetch count of the receiver. For
both {link ServiceBusReceiveMode#PEEK_LOCK PEEK_LOCK} and {link
ServiceBusReceiveMode#RECEIVE_AND_DELETE RECEIVE_AND_DELETE} modes the default
value is 1. Prefetch speeds up the message flow by aiming to have a message
readily available for local retrieval when and before the application asks for
one using ServiceBusReceiverAsyncClient#receiveMessages(). Setting a non-zero
value will prefetch that number of messa [...]
+| *receiverAsyncClient* (consumer) | *Autowired* Sets the receiverAsyncClient
in order to consume messages in the Consumer | | ServiceBusReceiverAsyncClient
+| *serviceBusReceiveMode* (consumer) | Sets the receive mode for the receiver.
There are 2 enums and the value can be one of: PEEK_LOCK, RECEIVE_AND_DELETE |
PEEK_LOCK | ServiceBusReceiveMode
+| *subQueue* (consumer) | Sets the type of the SubQueue to connect to. There
are 3 enums and the value can be one of: NONE, DEAD_LETTER_QUEUE,
TRANSFER_DEAD_LETTER_QUEUE | | SubQueue
+| *subscriptionName* (consumer) | Sets the name of the subscription in the
topic to listen to. topicOrQueueName and serviceBusType=topic must also be set.
| | String
+| *lazyStartProducer* (producer) | 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
starting and cause the route to fail being started. By deferring this startup
to be lazy then the startup failure can be handled during routing messages via
Camel's routing error handlers. Beware that when the first message is processed
then creating and [...]
+| *producerOperation* (producer) | Sets the desired operation to be used in
the producer. There are 2 enums and the value can be one of: sendMessages,
scheduleMessages | sendMessages | ServiceBusProducerOperationDefinition
+| *scheduledEnqueueTime* (producer) | Sets OffsetDateTime at which the message
should appear in the Service Bus queue or topic. | | OffsetDateTime
+| *senderAsyncClient* (producer) | *Autowired* Sets SenderAsyncClient to be
used in the producer. | | ServiceBusSenderAsyncClient
+| *serviceBusTransactionContext* (producer) | Represents transaction in
service. This object just contains transaction id. | |
ServiceBusTransactionContext
+| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used
for automatic autowiring options (the option must be marked as autowired) by
looking up in the registry to find if there is a single instance of matching
type, which then gets configured on the component. This can be used for
automatic configuring JDBC data sources, JMS connection factories, AWS Clients,
etc. | true | boolean
+| *connectionString* (security) | *Required* Sets the connection string for a
Service Bus namespace or a specific Service Bus resource. | | String
+|===
+// component options: END
+
+== Async Consumer and Producer
+
+This component implements the async Consumer and producer.
+
+This allows camel route to consume and produce events asynchronously without
blocking any threads.
+
+== Usage
+=== Message headers evaluated by the component producer
+[width="100%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+|Header |Variable Name |Type |Description
+
+|`CamelAzureServiceBusScheduledEnqueueTime`|
`ServiceBusConstants.SCHEDULED_ENQUEUE_TIME`|`OffsetDateTime`| Overrides the
OffsetDateTime at which the message should appear in the Service Bus queue or
topic.
+|`CamelAzureServiceBusServiceBusTransactionContext`|
`ServiceBusConstants.SERVICE_BUS_TRANSACTION_CONTEXT`|`ServiceBusTransactionContext`|
Overrides the transaction in service. This object just contains transaction id.
+|`CamelAzureServiceBusProducerOperation`|
`ServiceBusConstants.PRODUCER_OPERATION`|`ServiceBusProducerOperationDefinition`|
Overrides the desired operation to be used in the producer.
+|=======================================================================
+
+
+=== Message headers set by the component consumer
+[width="100%",cols="10%,10%,10%,70%",options="header",]
+|=======================================================================
+|Header |Variable Name |Type |Description
+
+|`CamelAzureServiceBusApplicationProperties`|
`ServiceBusConstants.APPLICATION_PROPERTIES`|`Map<String, Object>`| Gets the
set of free-form {@link ServiceBusReceivedMessage} properties which may be used
for passing metadata associated with the {@link ServiceBusReceivedMessage}
during Service Bus operations.
+|`CamelAzureServiceBusContentType`|
`ServiceBusConstants.CONTENT_TYPE`|`String`| Gets the content type of the
message.
+|`CamelAzureServiceBusMessageId`| `ServiceBusConstants.MESSAGE_ID`|`String`|
Gets the identifier for the message.
+|`CamelAzureServiceBusCorrelationId`|
`ServiceBusConstants.CORRELATION_ID`|`String`| Gets a correlation identifier.
+|`CamelAzureServiceBusDeadLetterErrorDescription`|
`ServiceBusConstants.DEAD_LETTER_ERROR_DESCRIPTION`|`String`| Gets the
description for a message that has been dead-lettered.
+|`CamelAzureServiceBusDeadLetterReason`|
`ServiceBusConstants.DEAD_LETTER_REASON`|`String`| Gets the reason a message
was dead-lettered.
+|`CamelAzureServiceBusDeadLetterSource`|
`ServiceBusConstants.DEAD_LETTER_SOURCE`|`String`| Gets the name of the queue
or subscription that this message was enqueued on, before it was dead-lettered.
+|`CamelAzureServiceBusDeliveryCount`|
`ServiceBusConstants.DELIVERY_COUNT`|`long`| Gets the number of the times this
message was delivered to clients.
+|`CamelAzureServiceBusScheduledEnqueueTime`|
`ServiceBusConstants.SCHEDULED_ENQUEUE_TIME`|`OffsetDateTime`| Gets the
scheduled enqueue time of this message.
+|`CamelAzureServiceBusEnqueuedSequenceNumber`|
`ServiceBusConstants.ENQUEUED_SEQUENCE_NUMBER`|`long`| Gets the enqueued
sequence number assigned to a message by Service Bus.
+|`CamelAzureServiceBusEnqueuedTime`|
`ServiceBusConstants.ENQUEUED_TIME`|`OffsetDateTime`| Gets the datetime at
which this message was enqueued in Azure Service Bus.
+|`CamelAzureServiceBusExpiresAt`|
`ServiceBusConstants.EXPIRES_AT`|`OffsetDateTime`| Gets the datetime at which
this message will expire.
+|`CamelAzureServiceBusLockToken`| `ServiceBusConstants.LOCK_TOKEN`|`String`|
Gets the lock token for the current message.
+|`CamelAzureServiceBusLockedUntil`|
`ServiceBusConstants.LOCKED_UNTIL`|`OffsetDateTime`| Gets the datetime at which
the lock of this message expires.
+|`CamelAzureServiceBusPartitionKey`|
`ServiceBusConstants.PARTITION_KEY`|`String`| Gets the partition key for
sending a message to a partitioned entity.
+|`CamelAzureServiceBusRawAmqpMessage`|
`ServiceBusConstants.RAW_AMQP_MESSAGE`|`AmqpAnnotatedMessage`| The
representation of message as defined by AMQP protocol.
+|`CamelAzureServiceBusReplyTo`| `ServiceBusConstants.REPLY_TO`|`String`| Gets
the address of an entity to send replies to.
+|`CamelAzureServiceBusReplyToSessionId`|
`ServiceBusConstants.REPLY_TO_SESSION_ID`|`String`| Gets or sets a session
identifier augmenting the {@link #getReplyTo() ReplyTo} address.
+|`CamelAzureServiceBusSequenceNumber`|
`ServiceBusConstants.SEQUENCE_NUMBER`|`long`| Gets the unique number assigned
to a message by Service Bus.
+|`CamelAzureServiceBusSessionId`| `ServiceBusConstants.SESSION_ID`|`String`|
Gets the session id of the message.
+|`CamelAzureServiceBusSubject`| `ServiceBusConstants.SUBJECT`|`String`| Gets
the subject for the message.
+|`CamelAzureServiceBusTimeToLive`|
`ServiceBusConstants.TIME_TO_LIVE`|`Duration`| Gets the duration before this
message expires.
+|`CamelAzureServiceBusTimeTo`| `ServiceBusConstants.TO`|`String`| Gets the
"to" address.
+|=======================================================================
+
+
+=== Message Body
+In the producer, this component accepts message body of `String` type or
`List<String>` 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",]
+|===
+|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
+- `sendMessages`
+
+[source,java]
+--------------------------------------------------------------------------------
+from("direct:start")
+ .process(exchange -> {
+ final List<Object> inputBatch = new LinkedList<>();
+ inputBatch.add("test batch 1");
+ inputBatch.add("test batch 2");
+ inputBatch.add("test batch 3");
+ inputBatch.add(123456);
+
+ exchange.getIn().setBody(inputBatch);
+ })
+ .to("azure-servicebus:test//?connectionString=test")
+ .to("mock:result");
+--------------------------------------------------------------------------------
+
+
+- `scheduleMessages`
+
+[source,java]
+--------------------------------------------------------------------------------
+from("direct:start")
+ .process(exchange -> {
+ final List<Object> inputBatch = new LinkedList<>();
+ inputBatch.add("test batch 1");
+ inputBatch.add("test batch 2");
+ inputBatch.add("test batch 3");
+ inputBatch.add(123456);
+
+
exchange.getIn().setHeader(ServiceBusConstants.SCHEDULED_ENQUEUE_TIME,
OffsetDateTime.now());
+ exchange.getIn().setBody(inputBatch);
+ })
+
.to("azure-servicebus:test//?connectionString=test&producerOperation=scheduleMessages")
+ .to("mock:result");
+--------------------------------------------------------------------------------
+
+- `receiveMessages`
+
+[source,java]
+--------------------------------------------------------------------------------
+from("azure-servicebus:test//?connectionString=test")
+ .log("${body}")
+ .to("mock:result");
+--------------------------------------------------------------------------------
+
+- `peekMessages`
+
+[source,java]
+--------------------------------------------------------------------------------
+from("azure-servicebus:test//?connectionString=test&consumerOperation=peekMessages&peekNumMaxMessages=3")
+ .log("${body}")
+ .to("mock:result");
+--------------------------------------------------------------------------------
+
include::{page-component-version}@camel-spring-boot::page$azure-servicebus-starter.adoc[]
diff --git a/docs/components/modules/ROOT/pages/file-component.adoc
b/docs/components/modules/ROOT/pages/file-component.adoc
index d13b8c6..c663952 100644
--- a/docs/components/modules/ROOT/pages/file-component.adoc
+++ b/docs/components/modules/ROOT/pages/file-component.adoc
@@ -639,7 +639,7 @@ Will for example create a file named `foo.done` if the
target file was
== Samples
-#=== Read from a directory and write to another directory
+=== Read from a directory and write to another directory
[source,java]
----
