com.azure.messaging.servicebus

Class ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder

java.lang.Object

com.azure.messaging.servicebus.ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder

Enclosing class:

ServiceBusClientBuilder

public final class ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder
extends Object

Builder for creating ServiceBusReceiverClient and ServiceBusReceiverAsyncClient to consume messages from a session aware Service Bus entity.

Method Summary

Modifier and Type	Method and Description
ServiceBusReceiverAsyncClient	buildAsyncClient() Creates an asynchronous, session-aware Service Bus receiver responsible for reading messages from a specific queue or topic.
ServiceBusReceiverClient	buildClient() Creates a synchronous, session-aware Service Bus receiver responsible for reading messages from a specific queue or topic.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	maxConcurrentSessions(int maxConcurrentSessions) Enables session processing roll-over by processing at most maxConcurrentSessions.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	prefetchCount(int prefetchCount) Sets the prefetch count of the receiver.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	queueName(String queueName) Sets the name of the queue to create a receiver for.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	receiveMode(ReceiveMode receiveMode) Sets the receive mode for the receiver.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	sessionId(String sessionId) Sets the session id.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	subscriptionName(String subscriptionName) Sets the name of the subscription in the topic to listen to.
ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder	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

maxConcurrentSessions

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder 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.ServiceBusReceiverClientBuilder object.

Throws:

IllegalArgumentException - if maxConcurrentSessions is less than 1.

prefetchCount

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder prefetchCount(int prefetchCount)

Sets the prefetch count of the receiver. For both PEEK_LOCK and 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.receive(). 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.ServiceBusReceiverClientBuilder object.

queueName

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder queueName(String queueName)

Sets the name of the queue to create a receiver for.

Parameters:

queueName - Name of the queue.

Returns:

The modified ServiceBusClientBuilder.ServiceBusReceiverClientBuilder object.

receiveMode

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder receiveMode(ReceiveMode receiveMode)

Sets the receive mode for the receiver.

Parameters:

receiveMode - Mode for receiving messages.

Returns:

The modified ServiceBusClientBuilder.ServiceBusReceiverClientBuilder object.

sessionId

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder sessionId(String sessionId)

Sets the session id.

Parameters:

sessionId - session id.

Returns:

The modified ServiceBusClientBuilder.ServiceBusReceiverClientBuilder object.

subscriptionName

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder subscriptionName(String subscriptionName)

Sets the name of the subscription in the topic to listen to. ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder.topicName(String) must also be set.

Parameters:

subscriptionName - Name of the subscription.

Returns:

The modified ServiceBusClientBuilder.ServiceBusReceiverClientBuilder object.

See Also:

A topic name should be set as well.

topicName

public ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder topicName(String topicName)

Sets the name of the topic. ServiceBusClientBuilder.ServiceBusSessionReceiverClientBuilder.subscriptionName(String) must also be set.

Parameters:

topicName - Name of the topic.

Returns:

The modified ServiceBusClientBuilder.ServiceBusReceiverClientBuilder object.

See Also:

A subscription name should be set as well.

buildAsyncClient

public ServiceBusReceiverAsyncClient buildAsyncClient()

Creates an asynchronous, session-aware Service Bus receiver responsible for reading messages from a specific queue or topic.

Returns:

An new ServiceBusReceiverAsyncClient that receives messages from a queue or topic.

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.

buildClient

public ServiceBusReceiverClient buildClient()

Creates a synchronous, session-aware Service Bus receiver responsible for reading messages from a specific queue or topic.

Returns:

An new ServiceBusReceiverClient that receives messages from a queue or topic.

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.