Package com.microsoft.azure.servicebus

Interface IMessageAndSessionPump

All Known Subinterfaces:

IQueueClient, ISubscriptionClient

All Known Implementing Classes:

QueueClient, SubscriptionClient

public interface IMessageAndSessionPump

Represents the pump which is underneath the clients that handles message processing.

Method Summary

Modifier and Type	Method	Description
void	abandon(UUID lockToken)	Abandon Message with lock token.
void	abandon(UUID lockToken, TransactionContext transaction)	Abandon Message with lock token.
void	abandon(UUID lockToken, Map<String,Object> propertiesToModify)	Abandon Message with lock token and updated message property.
void	abandon(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)	Abandon Message with lock token and updated message property.
CompletableFuture<Void>	abandonAsync(UUID lockToken)	Asynchronously abandon Message with lock token.
CompletableFuture<Void>	abandonAsync(UUID lockToken, TransactionContext transaction)	Asynchronously abandon Message with lock token.
CompletableFuture<Void>	abandonAsync(UUID lockToken, Map<String,Object> propertiesToModify)	Asynchronously abandon Message with lock token and updated message property.
CompletableFuture<Void>	abandonAsync(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)	Asynchronously abandon Message with lock token and updated message property.
void	complete(UUID lockToken)	Completes a Message using its lock token.
void	complete(UUID lockToken, TransactionContext transaction)	Completes a Message using its lock token.
CompletableFuture<Void>	completeAsync(UUID lockToken)	Asynchronously completes a Message using its lock token.
CompletableFuture<Void>	completeAsync(UUID lockToken, TransactionContext transaction)	Asynchronously completes a Message using its lock token.
void	deadLetter(UUID lockToken)	Moves a Message to the deadletter sub-queue.
void	deadLetter(UUID lockToken, TransactionContext transaction)	Moves a Message to the deadletter sub-queue.
void	deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)	Moves a Message to the deadletter sub-queue with deadletter reason and error description.
void	deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)	Moves a Message to the deadletter sub-queue with deadletter reason and error description.
void	deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify)	Moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.
void	deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify, TransactionContext transaction)	Moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.
void	deadLetter(UUID lockToken, Map<String,Object> propertiesToModify)	Moves a Message to the deadletter sub-queue with modified message properties.
void	deadLetter(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)	Moves a Message to the deadletter sub-queue with modified message properties.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken)	Asynchronously moves a Message to the deadletter sub-queue with deadletter.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, TransactionContext transaction)	Asynchronously moves a Message to the deadletter sub-queue with deadletter.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)	Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)	Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify)	Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify, TransactionContext transaction)	Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, Map<String,Object> propertiesToModify)	Asynchronously moves a Message to the deadletter sub-queue with modified properties.
CompletableFuture<Void>	deadLetterAsync(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)	Asynchronously moves a Message to the deadletter sub-queue with modified properties.
int	getPrefetchCount()	Get the prefetch value set.
void	registerMessageHandler(IMessageHandler handler)	Deprecated. Use registerMessageHandler(IMessageHandler, ExecutorService)
void	registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions)	Deprecated.
void	registerMessageHandler(IMessageHandler handler, MessageHandlerOptions handlerOptions, ExecutorService executorService)	Receive messages continuously from the entity.
void	registerMessageHandler(IMessageHandler handler, ExecutorService executorService)	Receive messages continuously from the entity.
void	registerSessionHandler(ISessionHandler handler)	Deprecated.
void	registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions)	Deprecated.
void	registerSessionHandler(ISessionHandler handler, SessionHandlerOptions handlerOptions, ExecutorService executorService)	Receive session messages continuously from the queue.
void	registerSessionHandler(ISessionHandler handler, ExecutorService executorService)	Receive session messages continuously from the queue.
void	setPrefetchCount(int prefetchCount)	Set the prefetch count of the receiver.

Method Detail

registerMessageHandler

@Deprecated
void registerMessageHandler(IMessageHandler handler)
                     throws InterruptedException,
                            ServiceBusException

Deprecated.

Use registerMessageHandler(IMessageHandler, ExecutorService)

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on java.util.concurrent.commonPool()

Parameters:

handler - The IMessageHandler instance

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerMessageHandler

void registerMessageHandler(IMessageHandler handler,
                            ExecutorService executorService)
                     throws InterruptedException,
                            ServiceBusException

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on the passed executor service.

Parameters:

handler - The IMessageHandler instance

executorService - ExecutorService which is used to execute IMessageHandler methods.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerMessageHandler

@Deprecated
void registerMessageHandler(IMessageHandler handler,
                            MessageHandlerOptions handlerOptions)
                     throws InterruptedException,
                            ServiceBusException

Deprecated.

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on java.util.concurrent.commonPool()

Parameters:

handler - The IMessageHandler instance

handlerOptions - MessageHandlerOptions

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerMessageHandler

void registerMessageHandler(IMessageHandler handler,
                            MessageHandlerOptions handlerOptions,
                            ExecutorService executorService)
                     throws InterruptedException,
                            ServiceBusException

Receive messages continuously from the entity. Registers a message handler and begins a new thread to receive messages. IMessageHandler methods are executed on the passed executor service.

Parameters:

handler - The IMessageHandler instance

handlerOptions - MessageHandlerOptions

executorService - ExecutorService which is used to execute IMessageHandler methods

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerSessionHandler

@Deprecated
void registerSessionHandler(ISessionHandler handler)
                     throws InterruptedException,
                            ServiceBusException

Deprecated.

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on java.util.concurrent.commonPool()

Parameters:

handler - The ISessionHandler instance

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerSessionHandler

void registerSessionHandler(ISessionHandler handler,
                            ExecutorService executorService)
                     throws InterruptedException,
                            ServiceBusException

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on the passed executor service.

Parameters:

handler - The ISessionHandler instance

executorService - ExecutorService which is used to execute ISessionHandler methods

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerSessionHandler

@Deprecated
void registerSessionHandler(ISessionHandler handler,
                            SessionHandlerOptions handlerOptions)
                     throws InterruptedException,
                            ServiceBusException

Deprecated.

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on java.util.concurrent.commonPool()

Parameters:

handler - The ISessionHandler instance

handlerOptions - SessionHandlerOptions

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

registerSessionHandler

void registerSessionHandler(ISessionHandler handler,
                            SessionHandlerOptions handlerOptions,
                            ExecutorService executorService)
                     throws InterruptedException,
                            ServiceBusException

Receive session messages continuously from the queue. Registers a message handler and begins a new thread to receive session-messages. ISessionHandler methods are executed on the passed executor service.

Parameters:

handler - The ISessionHandler instance

handlerOptions - SessionHandlerOptions

executorService - ExecutorService which is used to execute ISessionHandler methods

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if register failed

abandon

void abandon(UUID lockToken)
      throws InterruptedException,
             ServiceBusException

Abandon Message with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message

Parameters:

lockToken - Message lock token Message.getLockToken()

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

abandon

void abandon(UUID lockToken,
             TransactionContext transaction)
      throws InterruptedException,
             ServiceBusException

Abandon Message with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

abandon

void abandon(UUID lockToken,
             Map<String,Object> propertiesToModify)
      throws InterruptedException,
             ServiceBusException

Abandon Message with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

abandon

void abandon(UUID lockToken,
             Map<String,Object> propertiesToModify,
             TransactionContext transaction)
      throws InterruptedException,
             ServiceBusException

Abandon Message with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

abandonAsync

CompletableFuture<Void> abandonAsync(UUID lockToken)

Asynchronously abandon Message with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.

Parameters:

lockToken - Message lock token Message.getLockToken()

Returns:

a CompletableFuture representing the pending abandon.

abandonAsync

CompletableFuture<Void> abandonAsync(UUID lockToken,
                                     TransactionContext transaction)

Asynchronously abandon Message with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending abandon.

abandonAsync

CompletableFuture<Void> abandonAsync(UUID lockToken,
                                     Map<String,Object> propertiesToModify)

Asynchronously abandon Message with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

Returns:

a CompletableFuture representing the pending abandon.

abandonAsync

CompletableFuture<Void> abandonAsync(UUID lockToken,
                                     Map<String,Object> propertiesToModify,
                                     TransactionContext transaction)

Asynchronously abandon Message with lock token and updated message property. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending abandon.

complete

void complete(UUID lockToken)
       throws InterruptedException,
              ServiceBusException

Completes a Message using its lock token. This will delete the message from the service.

Parameters:

lockToken - Message lock token Message.getLockToken()

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

complete

void complete(UUID lockToken,
              TransactionContext transaction)
       throws InterruptedException,
              ServiceBusException

Completes a Message using its lock token. This will delete the message from the service.

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if abandon failed

completeAsync

CompletableFuture<Void> completeAsync(UUID lockToken)

Asynchronously completes a Message using its lock token. This will delete the message from the service.

Parameters:

lockToken - Message lock token Message.getLockToken()

Returns:

a CompletableFuture representing the pending complete.

completeAsync

CompletableFuture<Void> completeAsync(UUID lockToken,
                                      TransactionContext transaction)

Asynchronously completes a Message using its lock token. This will delete the message from the service.

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending complete.

deadLetter

void deadLetter(UUID lockToken)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue.

Parameters:

lockToken - Message lock token Message.getLockToken()

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                TransactionContext transaction)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue.

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                Map<String,Object> propertiesToModify)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with modified message properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                Map<String,Object> propertiesToModify,
                TransactionContext transaction)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with modified message properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                String deadLetterReason,
                String deadLetterErrorDescription)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with deadletter reason and error description.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                String deadLetterReason,
                String deadLetterErrorDescription,
                TransactionContext transaction)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with deadletter reason and error description.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                String deadLetterReason,
                String deadLetterErrorDescription,
                Map<String,Object> propertiesToModify)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

propertiesToModify - Message properties to modify.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetter

void deadLetter(UUID lockToken,
                String deadLetterReason,
                String deadLetterErrorDescription,
                Map<String,Object> propertiesToModify,
                TransactionContext transaction)
         throws InterruptedException,
                ServiceBusException

Moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Throws:

InterruptedException - if the current thread was interrupted while waiting

ServiceBusException - if deadletter failed

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken)

Asynchronously moves a Message to the deadletter sub-queue with deadletter.

Parameters:

lockToken - Message lock token Message.getLockToken()

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        TransactionContext transaction)

Asynchronously moves a Message to the deadletter sub-queue with deadletter.

Parameters:

lockToken - Message lock token Message.getLockToken()

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        Map<String,Object> propertiesToModify)

Asynchronously moves a Message to the deadletter sub-queue with modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        Map<String,Object> propertiesToModify,
                                        TransactionContext transaction)

Asynchronously moves a Message to the deadletter sub-queue with modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        String deadLetterReason,
                                        String deadLetterErrorDescription)

Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        String deadLetterReason,
                                        String deadLetterErrorDescription,
                                        TransactionContext transaction)

Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        String deadLetterReason,
                                        String deadLetterErrorDescription,
                                        Map<String,Object> propertiesToModify)

Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

propertiesToModify - Message properties to modify.

Returns:

a CompletableFuture representing the pending deadletter.

deadLetterAsync

CompletableFuture<Void> deadLetterAsync(UUID lockToken,
                                        String deadLetterReason,
                                        String deadLetterErrorDescription,
                                        Map<String,Object> propertiesToModify,
                                        TransactionContext transaction)

Asynchronously moves a Message to the deadletter sub-queue with deadletter reason and error description and modified properties.

Parameters:

lockToken - Message lock token Message.getLockToken()

deadLetterReason - The deadletter reason.

deadLetterErrorDescription - The deadletter error description.

propertiesToModify - Message properties to modify.

transaction - TransactionContext which this operation should enlist to.

Returns:

a CompletableFuture representing the pending deadletter.

getPrefetchCount

int getPrefetchCount()

Get the prefetch value set.

Returns:

The set prefetch count value.

setPrefetchCount

void setPrefetchCount(int prefetchCount)
               throws ServiceBusException

Set the prefetch count of the receiver. 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 Receive. Setting a non-zero value prefetches PrefetchCount number of messages. Setting the value to zero turns prefetch off. For RECEIVEANDDELETE mode, the default value is 0. For PEEKLOCK mode, the default value is 100.

The value cannot be set until the receiver is created.

Parameters:

prefetchCount - The desired prefetch count.

Throws:

ServiceBusException - if sets the value failed