| // spring-boot-auto-configure options: START |
| :page-partial: |
| :doctitle: Camel Spring Boot Starter for azure-servicebus |
| |
| == Spring Boot Auto-Configuration |
| |
| When using azure-servicebus with Spring Boot make sure to use the following Maven dependency to have support for auto configuration: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.springboot</groupId> |
| <artifactId>camel-azure-servicebus-starter</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel core version --> |
| </dependency> |
| ---- |
| |
| |
| The component supports 24 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Type |
| | *camel.component.azure-servicebus.amqp-retry-options* | Sets the retry options for Service Bus clients. If not specified, the default retry options are used. The option is a com.azure.core.amqp.AmqpRetryOptions type. | | AmqpRetryOptions |
| | *camel.component.azure-servicebus.amqp-transport-type* | Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP. | | AmqpTransportType |
| | *camel.component.azure-servicebus.autowired-enabled* | 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 |
| | *camel.component.azure-servicebus.bridge-error-handler* | 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 |
| | *camel.component.azure-servicebus.client-options* | 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. The option is a com.azure.core.util.ClientOptions type. | | ClientOptions |
| | *camel.component.azure-servicebus.configuration* | The component configurations. The option is a org.apache.camel.component.azure.servicebus.ServiceBusConfiguration type. | | ServiceBusConfiguration |
| | *camel.component.azure-servicebus.connection-string* | Sets the connection string for a Service Bus namespace or a specific Service Bus resource. | | String |
| | *camel.component.azure-servicebus.consumer-operation* | Sets the desired operation to be used in the consumer | | ServiceBusConsumerOperationDefinition |
| | *camel.component.azure-servicebus.disable-auto-complete* | 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 |
| | *camel.component.azure-servicebus.enabled* | Whether to enable auto configuration of the azure-servicebus component. This is enabled by default. | | Boolean |
| | *camel.component.azure-servicebus.lazy-start-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 starting the producer may take a little time and prolong the total processing time of the processing. | false | Boolean |
| | *camel.component.azure-servicebus.max-auto-lock-renew-duration* | 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. The option is a java.time.Duration type. | | Duration |
| | *camel.component.azure-servicebus.peek-num-max-messages* | Set the max number of messages to be peeked during the peek operation. | | Integer |
| | *camel.component.azure-servicebus.prefetch-count* | 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 messages. Setting the value to zero turns prefetch off. | 0 | Integer |
| | *camel.component.azure-servicebus.producer-operation* | Sets the desired operation to be used in the producer | | ServiceBusProducerOperationDefinition |
| | *camel.component.azure-servicebus.proxy-options* | Sets the proxy configuration to use for ServiceBusSenderAsyncClient. When a proxy is configured, AmqpTransportType#AMQP_WEB_SOCKETS must be used for the transport type. The option is a com.azure.core.amqp.ProxyOptions type. | | ProxyOptions |
| | *camel.component.azure-servicebus.receiver-async-client* | Sets the receiverAsyncClient in order to consume messages in the Consumer. The option is a com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient type. | | ServiceBusReceiverAsyncClient |
| | *camel.component.azure-servicebus.scheduled-enqueue-time* | Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. The option is a java.time.OffsetDateTime type. | | OffsetDateTime |
| | *camel.component.azure-servicebus.sender-async-client* | Sets SenderAsyncClient to be used in the producer. The option is a com.azure.messaging.servicebus.ServiceBusSenderAsyncClient type. | | ServiceBusSenderAsyncClient |
| | *camel.component.azure-servicebus.service-bus-receive-mode* | Sets the receive mode for the receiver. | | ServiceBusReceiveMode |
| | *camel.component.azure-servicebus.service-bus-transaction-context* | Represents transaction in service. This object just contains transaction id. The option is a com.azure.messaging.servicebus.ServiceBusTransactionContext type. | | ServiceBusTransactionContext |
| | *camel.component.azure-servicebus.service-bus-type* | The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. | | ServiceBusType |
| | *camel.component.azure-servicebus.sub-queue* | Sets the type of the SubQueue to connect to. | | SubQueue |
| | *camel.component.azure-servicebus.subscription-name* | Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. | | String |
| |=== |
| |
| |
| // spring-boot-auto-configure options: END |
