ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder (Azure SDK for Java Reference Documentation)

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

Enclosing class:: ServiceBusClientBuilder

public final class ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder
extends Object

Builder for creating ServiceBusProcessorClient to consume messages from a session-based Service Bus entity. ServiceBusProcessorClient processes messages and errors via ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.processMessage(Consumer) and ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.processError(Consumer). When the processor finishes processing a session, it tries to fetch the next session to process.

By default, the processor:

Automatically settles messages. Disabled via ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.disableAutoComplete()
Processes 1 session concurrently. Configured via ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.maxConcurrentSessions(int)
Invokes 1 instance of processMessage consumer. Configured via ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.maxConcurrentCalls(int)

Instantiate a session-enabled processor client

 Consumer<ServiceBusReceivedMessageContext> onMessage = context -> {
     ServiceBusReceivedMessage message = context.getMessage();
     System.out.printf("Processing message. Session: %s, Sequence #: %s. Contents: %s%n",
         message.getSessionId(), 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 sessionProcessor = new ServiceBusClientBuilder()
     .connectionString(connectionString)
     .sessionProcessor()
     .queueName(queueName)
     .maxConcurrentSessions(2)
     .processMessage(onMessage)
     .processError(onError)
     .buildProcessorClient();
 
 // Start the processor in the background
 sessionProcessor.start();

See Also:: ServiceBusProcessorClient

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceBusProcessorClient`	`buildProcessorClient()` Creates a session-aware Service Bus processor responsible for reading `messages` from a specific queue or subscription.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`disableAutoComplete()` Disables auto-complete and auto-abandon of received messages.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)` Sets the amount of time to continue auto-renewing the lock.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`maxConcurrentCalls(int maxConcurrentCalls)` Max concurrent messages that this processor should process.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`maxConcurrentSessions(int maxConcurrentSessions)` Enables session processing roll-over by processing at most `maxConcurrentSessions`.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`prefetchCount(int prefetchCount)` Sets the prefetch count of the processor.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`processError(Consumer<ServiceBusErrorContext> processError)` The error handler for the processor which will be invoked in the event of an error while receiving messages.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)` The message processing callback for the processor that will be executed when a message is received.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`queueName(String queueName)` Sets the name of the queue to create a processor for.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`receiveMode(ServiceBusReceiveMode receiveMode)` Sets the receive mode for the processor.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`subQueue(SubQueue subQueue)` Sets the type of the `SubQueue` to connect to.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`subscriptionName(String subscriptionName)` Sets the name of the subscription in the topic to listen to.
`ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder`	`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
  - maxAutoLockRenewDuration
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder 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.ServiceBusSessionProcessorClientBuilder object.
    
    Throws:
    
    IllegalArgumentException - If {code maxAutoLockRenewDuration} is negative.
  - maxConcurrentSessions
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder maxConcurrentSessions(int maxConcurrentSessions)
```
    Enables session processing roll-over by processing at most maxConcurrentSessions.
    
    Parameters:
    
    maxConcurrentSessions - Maximum number of concurrent sessions to process at any given time.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
    
    Throws:
    
    IllegalArgumentException - if maxConcurrentSessions is less than 1.
  - prefetchCount
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder 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. Using a non-zero prefetch risks of losing messages even though it has better performance.
    
    Parameters:
    
    prefetchCount - The prefetch count.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusProcessorClientBuilder object.
    
    See Also:
    
    Service Bus Prefetch
  - queueName
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder queueName(String queueName)
```
    Sets the name of the queue to create a processor for.
    
    Parameters:
    
    queueName - Name of the queue.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
  - receiveMode
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder receiveMode(ServiceBusReceiveMode receiveMode)
```
    Sets the receive mode for the processor.
    
    Parameters:
    
    receiveMode - Mode for receiving messages.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
  - subQueue
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder 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.ServiceBusSessionProcessorClientBuilder object.
    
    See Also:
    
    A queuename or #topicName A topic name should be set as well., SubQueue
  - subscriptionName
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder subscriptionName(String subscriptionName)
```
    Sets the name of the subscription in the topic to listen to. ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.topicName(String) must also be set.
    
    Parameters:
    
    subscriptionName - Name of the subscription.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
    
    See Also:
    
    A topic name should be set as well.
  - topicName
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder topicName(String topicName)
```
    Sets the name of the topic. ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.subscriptionName(String) must also be set.
    
    Parameters:
    
    topicName - Name of the topic.
    
    Returns:
    
    The modified ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
    
    See Also:
    
    A subscription name should be set as well.
  - processMessage
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)
```
    The message processing callback for the processor that 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.ServiceBusSessionProcessorClientBuilder 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
  - maxConcurrentCalls
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder maxConcurrentCalls(int maxConcurrentCalls)
```
    Max concurrent messages that this processor should process.
    
    Parameters:
    
    maxConcurrentCalls - max concurrent messages that this processor should process.
    
    Returns:
    
    The updated ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder object.
    
    Throws:
    
    IllegalArgumentException - if maxConcurrentCalls is less than 1.
  - disableAutoComplete
```
public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder 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.ServiceBusSessionProcessorClientBuilder object.
  - buildProcessorClient
```
public ServiceBusProcessorClient buildProcessorClient()
```
    Creates a session-aware Service Bus processor responsible for reading messages from a specific queue or subscription.
    
    Returns:
    
    An new ServiceBusProcessorClient that receives 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.ServiceBusSessionProcessorClientBuilder.processMessage(Consumer) or ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder.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.ServiceBusSessionProcessorClientBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

maxAutoLockRenewDuration

maxConcurrentSessions

prefetchCount

queueName

receiveMode

subQueue

subscriptionName

topicName

processMessage

processError

maxConcurrentCalls

disableAutoComplete

buildProcessorClient