ServiceBusClientBuilder.ServiceBusProcessorClientBuilder (Azure SDK for Java Reference Documentation)

java.lang.Object
- com.azure.messaging.servicebus.ServiceBusClientBuilder.ServiceBusProcessorClientBuilder

Enclosing class:: ServiceBusClientBuilder

public final class ServiceBusClientBuilder.ServiceBusProcessorClientBuilder
extends Object

Builder for creating ServiceBusProcessorClient to consume messages from a Service Bus entity. ServiceBusProcessorClients provides a push-based mechanism that notifies the message processing callback when a message is received or the error handle when an error is observed. To create an instance, therefore, configuring the two callbacks - ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.processMessage(Consumer) and ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.processError(Consumer) are necessary. By default, a ServiceBusProcessorClient is configured with auto-completion and auto-lock renewal capabilities.

Sample code to instantiate a processor client

 Consumer<ServiceBusReceivedMessageContext> onMessage = context -> {
     ServiceBusReceivedMessage message = context.getMessage();
     System.out.printf("Processing message. Sequence #: %s. Contents: %s%n",
         message.getSequenceNumber(), message.getBody());
 };
 
 Consumer<ServiceBusErrorContext> onError = context -> {
     System.out.printf("Error when receiving messages from namespace: '%s'. Entity: '%s'%n",
         context.getFullyQualifiedNamespace(), context.getEntityPath());
 
     if (context.getException() instanceof ServiceBusException) {
         ServiceBusException exception = (ServiceBusException) context.getException();
         System.out.printf("Error source: %s, reason %s%n", context.getErrorSource(),
             exception.getReason());
     } else {
         System.out.printf("Error occurred: %s%n", context.getException());
     }
 };
 
 // Retrieve 'connectionString/queueName' from your configuration.
 
 ServiceBusProcessorClient processor = new ServiceBusClientBuilder()
     .connectionString(connectionString)
     .processor()
     .queueName(queueName)
     .processMessage(onMessage)
     .processError(onError)
     .buildProcessorClient();
 
 // Start the processor in the background
 processor.start();

See Also:: ServiceBusProcessorClient

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceBusProcessorClient`	`buildProcessorClient()` Creates Service Bus message processor responsible for reading `messages` from a specific queue or subscription.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`disableAutoComplete()` Disables auto-complete and auto-abandon of received messages.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)` Sets the amount of time to continue auto-renewing the lock.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`maxConcurrentCalls(int maxConcurrentCalls)` Max concurrent messages that this processor should process.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`prefetchCount(int prefetchCount)` Sets the prefetch count of the processor.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`processError(Consumer<ServiceBusErrorContext> processError)` The error handler for the processor which will be invoked in the event of an error while receiving messages.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)` The message processing callback for the processor which will be executed when a message is received.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`queueName(String queueName)` Sets the name of the queue to create a processor for.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`receiveMode(ServiceBusReceiveMode receiveMode)` Sets the receive mode for the processor.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`subQueue(SubQueue subQueue)` Sets the type of the `SubQueue` to connect to.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`subscriptionName(String subscriptionName)` Sets the name of the subscription in the topic to listen to.
`ServiceBusClientBuilder.ServiceBusProcessorClientBuilder`	`topicName(String topicName)` Sets the name of the topic.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - prefetchCount
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder prefetchCount(int prefetchCount)
```
    Sets the prefetch count of the processor. For both PEEK_LOCK and RECEIVE_AND_DELETE modes the default value is 0. Prefetch speeds up the message flow by aiming to have a message readily available for local retrieval when and before the application starts the processor. Setting a non-zero value will prefetch that number of messages. Setting the value to zero turns prefetch off.
    
    Parameters:
    
    prefetchCount - The prefetch count.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
  - queueName
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder queueName(String queueName)
```
    Sets the name of the queue to create a processor for.
    
    Parameters:
    
    queueName - Name of the queue.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
  - receiveMode
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder receiveMode(ServiceBusReceiveMode receiveMode)
```
    Sets the receive mode for the processor.
    
    Parameters:
    
    receiveMode - Mode for receiving messages.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
  - subQueue
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder subQueue(SubQueue subQueue)
```
    Sets the type of the SubQueue to connect to. Azure Service Bus queues and subscriptions provide a secondary sub-queue, called a dead-letter queue (DLQ).
    
    Parameters:
    
    subQueue - The type of the sub queue.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    See Also:
    
    A queuename or #topicName A topic name should be set as well., SubQueue
  - subscriptionName
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder subscriptionName(String subscriptionName)
```
    Sets the name of the subscription in the topic to listen to. ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.topicName(String) must also be set.
    
    Parameters:
    
    subscriptionName - Name of the subscription.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    See Also:
    
    A topic name should be set as well.
  - topicName
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder topicName(String topicName)
```
    Sets the name of the topic. ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.subscriptionName(String) must also be set.
    
    Parameters:
    
    topicName - Name of the topic.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    See Also:
    
    A subscription name should be set as well.
  - processMessage
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)
```
    The message processing callback for the processor which will be executed when a message is received.
    
    Parameters:
    
    processMessage - The message processing consumer that will be executed when a message is received.
    
    Returns:
    
    The updated ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
  - processError
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder processError(Consumer<ServiceBusErrorContext> processError)
```
    The error handler for the processor which will be invoked in the event of an error while receiving messages.
    
    Parameters:
    
    processError - The error handler which will be executed when an error occurs.
    
    Returns:
    
    The updated ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object
  - maxAutoLockRenewDuration
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)
```
    Sets the amount of time to continue auto-renewing the lock. Setting Duration.ZERO or null disables auto-renewal. For RECEIVE_AND_DELETE mode, auto-renewal is disabled.
    
    Parameters:
    
    maxAutoLockRenewDuration - the amount of time to continue auto-renewing the lock. Duration.ZERO or null indicates that auto-renewal is disabled.
    
    Returns:
    
    The updated ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    Throws:
    
    IllegalArgumentException - If {code maxAutoLockRenewDuration} is negative.
  - maxConcurrentCalls
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder maxConcurrentCalls(int maxConcurrentCalls)
```
    Max concurrent messages that this processor should process. By default, this is set to 1.
    
    Parameters:
    
    maxConcurrentCalls - max concurrent messages that this processor should process.
    
    Returns:
    
    The updated ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    Throws:
    
    IllegalArgumentException - if the maxConcurrentCalls is set to a value less than 1.
  - disableAutoComplete
```
public ServiceBusClientBuilder.ServiceBusProcessorClientBuilder disableAutoComplete()
```
    Disables auto-complete and auto-abandon of received messages. By default, a successfully processed message is completed. If an error happens when the message is processed, it is abandoned.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
  - buildProcessorClient
```
public ServiceBusProcessorClient buildProcessorClient()
```
    Creates Service Bus message processor responsible for reading messages from a specific queue or subscription.
    
    Returns:
    
    An new ServiceBusProcessorClient that processes messages from a queue or subscription.
    
    Throws:
    
    IllegalStateException - if queueName or topicName are not set or, both of these fields are set. It is also thrown if the Service Bus connectionString contains an EntityPath that does not match one set in queueName or topicName. Lastly, if a topicName is set, but subscriptionName is not.
    
    IllegalArgumentException - Queue or topic name are not set via queueName() or topicName(), respectively.
    
    NullPointerException - if the ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.processMessage(Consumer) or ServiceBusClientBuilder.ServiceBusProcessorClientBuilder.processError(Consumer) callbacks are not set.

Visit the Azure for Java Developers site for more Java documentation, including quick starts, tutorials, and code samples.

Class ServiceBusClientBuilder.ServiceBusProcessorClientBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

prefetchCount

queueName

receiveMode

subQueue

subscriptionName

topicName

processMessage

processError

maxAutoLockRenewDuration

maxConcurrentCalls

disableAutoComplete

buildProcessorClient