org.apache.camel.builder.component.dsl

Interface AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.azure.servicebus.ServiceBusComponent>

All Known Implementing Classes:

AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilderImpl

Enclosing interface:

AzureServicebusComponentBuilderFactory

public static interface AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder
extends ComponentBuilder<org.apache.camel.component.azure.servicebus.ServiceBusComponent>

Builder for the Azure ServiceBus component.

Method Summary

Modifier and Type	Method and Description
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions) Sets the retry options for Service Bus clients.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType) Sets the transport type by which all the communication with Azure Service Bus occurs.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	bridgeErrorHandler(boolean bridgeErrorHandler) 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.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions) 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.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	configuration(org.apache.camel.component.azure.servicebus.ServiceBusConfiguration configuration) The component configurations.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	connectionString(String connectionString) Sets the connection string for a Service Bus namespace or a specific Service Bus resource.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	consumerOperation(org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition consumerOperation) Sets the desired operation to be used in the consumer.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	disableAutoComplete(boolean disableAutoComplete) Disables auto-complete and auto-abandon of received messages.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	lazyStartProducer(boolean lazyStartProducer) Whether the producer should be started lazy (on the first message).
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration) Sets the amount of time to continue auto-renewing the lock.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	peekNumMaxMessages(Integer peekNumMaxMessages) Set the max number of messages to be peeked during the peek operation.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	prefetchCount(int prefetchCount) Sets the prefetch count of the receiver.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	producerOperation(org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition producerOperation) Sets the desired operation to be used in the producer.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions) Sets the proxy configuration to use for ServiceBusSenderAsyncClient.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	receiverAsyncClient(com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient receiverAsyncClient) Sets the receiverAsyncClient in order to consume messages in the Consumer.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	scheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime) Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	senderAsyncClient(com.azure.messaging.servicebus.ServiceBusSenderAsyncClient senderAsyncClient) Sets SenderAsyncClient to be used in the producer.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	serviceBusReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode serviceBusReceiveMode) Sets the receive mode for the receiver.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	serviceBusTransactionContext(com.azure.messaging.servicebus.ServiceBusTransactionContext serviceBusTransactionContext) Represents transaction in service.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType) The service bus type of connection to execute.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	subQueue(com.azure.messaging.servicebus.models.SubQueue subQueue) Sets the type of the SubQueue to connect to.
default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder	subscriptionName(String subscriptionName) Sets the name of the subscription in the topic to listen to.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

build, build, doSetProperty, register

Method Detail

amqpRetryOptions

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder amqpRetryOptions(com.azure.core.amqp.AmqpRetryOptions amqpRetryOptions)

Sets the retry options for Service Bus clients. If not specified, the default retry options are used. The option is a: <code>com.azure.core.amqp.AmqpRetryOptions</code> type. Group: common

Parameters:

amqpRetryOptions - the value to set

Returns:

the dsl builder

amqpTransportType

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder amqpTransportType(com.azure.core.amqp.AmqpTransportType amqpTransportType)

Sets the transport type by which all the communication with Azure Service Bus occurs. Default value is AmqpTransportType#AMQP. The option is a: <code>com.azure.core.amqp.AmqpTransportType</code> type. Default: AMQP Group: common

Parameters:

amqpTransportType - the value to set

Returns:

the dsl builder

clientOptions

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

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: <code>com.azure.core.util.ClientOptions</code> type. Group: common

Parameters:

clientOptions - the value to set

Returns:

the dsl builder

configuration

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder configuration(org.apache.camel.component.azure.servicebus.ServiceBusConfiguration configuration)

The component configurations. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusConfiguration</code> type. Group: common

Parameters:

configuration - the value to set

Returns:

the dsl builder

proxyOptions

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder proxyOptions(com.azure.core.amqp.ProxyOptions proxyOptions)

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: <code>com.azure.core.amqp.ProxyOptions</code> type. Group: common

Parameters:

proxyOptions - the value to set

Returns:

the dsl builder

serviceBusType

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder serviceBusType(org.apache.camel.component.azure.servicebus.ServiceBusType serviceBusType)

The service bus type of connection to execute. Queue is for typical queue option and topic for subscription based model. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusType</code> type. Default: queue Group: common

Parameters:

serviceBusType - the value to set

Returns:

the dsl builder

bridgeErrorHandler

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)

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. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

bridgeErrorHandler - the value to set

Returns:

the dsl builder

consumerOperation

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder consumerOperation(org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition consumerOperation)

Sets the desired operation to be used in the consumer. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusConsumerOperationDefinition</code> type. Default: receiveMessages Group: consumer

Parameters:

consumerOperation - the value to set

Returns:

the dsl builder

disableAutoComplete

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder disableAutoComplete(boolean disableAutoComplete)

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}. The option is a: <code>boolean</code> type. Default: false Group: consumer

Parameters:

disableAutoComplete - the value to set

Returns:

the dsl builder

maxAutoLockRenewDuration

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)

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: <code>java.time.Duration</code> type. Default: 5min Group: consumer

Parameters:

maxAutoLockRenewDuration - the value to set

Returns:

the dsl builder

peekNumMaxMessages

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder peekNumMaxMessages(Integer peekNumMaxMessages)

Set the max number of messages to be peeked during the peek operation. The option is a: <code>java.lang.Integer</code> type. Group: consumer

Parameters:

peekNumMaxMessages - the value to set

Returns:

the dsl builder

prefetchCount

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder prefetchCount(int prefetchCount)

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. The option is a: <code>int</code> type. Default: 0 Group: consumer

Parameters:

prefetchCount - the value to set

Returns:

the dsl builder

receiverAsyncClient

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder receiverAsyncClient(com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient receiverAsyncClient)

Sets the receiverAsyncClient in order to consume messages in the Consumer. The option is a: <code>com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient</code> type. Group: consumer

Parameters:

receiverAsyncClient - the value to set

Returns:

the dsl builder

serviceBusReceiveMode

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder serviceBusReceiveMode(com.azure.messaging.servicebus.models.ServiceBusReceiveMode serviceBusReceiveMode)

Sets the receive mode for the receiver. The option is a: <code>com.azure.messaging.servicebus.models.ServiceBusReceiveMode</code> type. Default: PEEK_LOCK Group: consumer

Parameters:

serviceBusReceiveMode - the value to set

Returns:

the dsl builder

subQueue

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder subQueue(com.azure.messaging.servicebus.models.SubQueue subQueue)

Sets the type of the SubQueue to connect to. The option is a: <code>com.azure.messaging.servicebus.models.SubQueue</code> type. Group: consumer

Parameters:

subQueue - the value to set

Returns:

the dsl builder

subscriptionName

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder subscriptionName(String subscriptionName)

Sets the name of the subscription in the topic to listen to. topicOrQueueName and serviceBusType=topic must also be set. The option is a: <code>java.lang.String</code> type. Group: consumer

Parameters:

subscriptionName - the value to set

Returns:

the dsl builder

lazyStartProducer

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder lazyStartProducer(boolean lazyStartProducer)

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. The option is a: <code>boolean</code> type. Default: false Group: producer

Parameters:

lazyStartProducer - the value to set

Returns:

the dsl builder

producerOperation

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder producerOperation(org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition producerOperation)

Sets the desired operation to be used in the producer. The option is a: <code>org.apache.camel.component.azure.servicebus.ServiceBusProducerOperationDefinition</code> type. Default: sendMessages Group: producer

Parameters:

producerOperation - the value to set

Returns:

the dsl builder

scheduledEnqueueTime

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder scheduledEnqueueTime(OffsetDateTime scheduledEnqueueTime)

Sets OffsetDateTime at which the message should appear in the Service Bus queue or topic. The option is a: <code>java.time.OffsetDateTime</code> type. Group: producer

Parameters:

scheduledEnqueueTime - the value to set

Returns:

the dsl builder

senderAsyncClient

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder senderAsyncClient(com.azure.messaging.servicebus.ServiceBusSenderAsyncClient senderAsyncClient)

Sets SenderAsyncClient to be used in the producer. The option is a: <code>com.azure.messaging.servicebus.ServiceBusSenderAsyncClient</code> type. Group: producer

Parameters:

senderAsyncClient - the value to set

Returns:

the dsl builder

serviceBusTransactionContext

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder serviceBusTransactionContext(com.azure.messaging.servicebus.ServiceBusTransactionContext serviceBusTransactionContext)

Represents transaction in service. This object just contains transaction id. The option is a: <code>com.azure.messaging.servicebus.ServiceBusTransactionContext</code> type. Group: producer

Parameters:

serviceBusTransactionContext - the value to set

Returns:

the dsl builder

autowiredEnabled

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder autowiredEnabled(boolean autowiredEnabled)

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. The option is a: <code>boolean</code> type. Default: true Group: advanced

Parameters:

autowiredEnabled - the value to set

Returns:

the dsl builder

connectionString

default AzureServicebusComponentBuilderFactory.AzureServicebusComponentBuilder connectionString(String connectionString)

Sets the connection string for a Service Bus namespace or a specific Service Bus resource. The option is a: <code>java.lang.String</code> type. Group: security

Parameters:

connectionString - the value to set

Returns:

the dsl builder