public class MessageSession extends ClientEntity implements IMessageSession
| Modifier and Type | Method and Description |
|---|---|
void |
abandon(UUID lockToken)
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. |
void |
abandon(UUID lockToken,
TransactionContext transaction)
Abandon
Message with lock token. |
CompletableFuture<Void> |
abandonAsync(UUID lockToken)
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. |
CompletableFuture<Void> |
abandonAsync(UUID lockToken,
TransactionContext transaction)
Asynchronously abandon
Message with lock token. |
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,
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. |
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,
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,
String deadLetterReason,
String deadLetterErrorDescription,
TransactionContext transaction)
Moves a
Message to the deadletter sub-queue with deadletter reason and error description. |
void |
deadLetter(UUID lockToken,
TransactionContext transaction)
Moves a
Message to the deadletter sub-queue. |
CompletableFuture<Void> |
deadLetterAsync(UUID lockToken)
Asynchronously moves a
Message to the deadletter sub-queue with deadletter. |
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. |
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,
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,
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,
TransactionContext transaction)
Asynchronously moves a
Message to the deadletter sub-queue with deadletter. |
void |
defer(UUID lockToken)
Defers a
Message using its lock token. |
void |
defer(UUID lockToken,
Map<String,Object> propertiesToModify)
Defers a
Message using its lock token with modified message property. |
void |
defer(UUID lockToken,
Map<String,Object> propertiesToModify,
TransactionContext transaction)
Defers a
Message using its lock token with modified message property. |
void |
defer(UUID lockToken,
TransactionContext transaction)
Defers a
Message using its lock token. |
CompletableFuture<Void> |
deferAsync(UUID lockToken)
Asynchronously defers a
Message using its lock token. |
CompletableFuture<Void> |
deferAsync(UUID lockToken,
Map<String,Object> propertiesToModify)
Asynchronously defers a
Message using its lock token with modified message propert. |
CompletableFuture<Void> |
deferAsync(UUID lockToken,
Map<String,Object> propertiesToModify,
TransactionContext transaction)
Asynchronously defers a
Message using its lock token with modified message propert. |
CompletableFuture<Void> |
deferAsync(UUID lockToken,
TransactionContext transaction)
Asynchronously defers a
Message using its lock token. |
String |
getEntityPath()
Gets the path of the entity this client is sending messages to or receiving messages from.
|
protected CoreMessageReceiver |
getInternalReceiver() |
Instant |
getLockedUntilUtc() |
int |
getPrefetchCount()
Get the prefetch value set.
|
ReceiveMode |
getReceiveMode()
Get current receiver's
ReceiveMode. |
protected String |
getRequestedSessionId() |
String |
getSessionId() |
byte[] |
getState()
Gets the session state.
|
CompletableFuture<byte[]> |
getStateAsync()
Asynchronously gets the session state.
|
protected boolean |
isBrowsableSession() |
protected boolean |
isSessionReceiver() |
protected CompletableFuture<Void> |
onClose() |
IMessage |
peek()
reads next the active message without changing the state of the receiver or the message source.
|
IMessage |
peek(long fromSequenceNumber)
Reads next the active message without changing the state of the receiver or the message source.
|
CompletableFuture<IMessage> |
peekAsync()
Asynchronously reads the active messages without changing the state of the receiver or the message source.
|
CompletableFuture<IMessage> |
peekAsync(long fromSequenceNumber)
Asynchronously reads next the active message without changing the state of the receiver or the message source.
|
Collection<IMessage> |
peekBatch(int messageCount)
Reads next batch of the active messages without changing the state of the receiver or the message source.
|
Collection<IMessage> |
peekBatch(long fromSequenceNumber,
int messageCount)
Reads next batch of the active messages without changing the state of the receiver or the message source.
|
CompletableFuture<Collection<IMessage>> |
peekBatchAsync(int messageCount)
Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.
|
CompletableFuture<Collection<IMessage>> |
peekBatchAsync(long fromSequenceNumber,
int messageCount)
Asynchronously reads the next batch of active messages without changing the state of the receiver or the message source.
|
IMessage |
receive()
Receives a
Message with default server wait time. |
IMessage |
receive(Duration serverWaitTime)
Receives a
Message with specified server wait time. |
CompletableFuture<IMessage> |
receiveAsync()
Receives a
Message from Azure Service Bus. |
CompletableFuture<IMessage> |
receiveAsync(Duration serverWaitTime)
Receives a
Message from Azure Service Bus with server wait time. |
Collection<IMessage> |
receiveBatch(int maxMessageCount)
Receives a maximum of maxMessageCount
Message from Azure Service Bus. |
Collection<IMessage> |
receiveBatch(int maxMessageCount,
Duration serverWaitTime)
Receives a maximum of maxMessageCount
Message from Azure Service Bus with server wait time. |
CompletableFuture<Collection<IMessage>> |
receiveBatchAsync(int maxMessageCount)
Asynchronously receives a maximum of maxMessageCount
Message from the entity. |
CompletableFuture<Collection<IMessage>> |
receiveBatchAsync(int maxMessageCount,
Duration serverWaitTime)
Asynchronously receives a maximum of maxMessageCount
Message from Azure Service Bus with server wait time. |
IMessage |
receiveDeferredMessage(long sequenceNumber)
Receives a deferred
Message. |
CompletableFuture<IMessage> |
receiveDeferredMessageAsync(long sequenceNumber)
Asynchronously receives a specific deferred
Message identified by sequence number. |
Collection<IMessage> |
receiveDeferredMessageBatch(Collection<Long> sequenceNumbers)
Receives a batch of deferred
Message. |
CompletableFuture<Collection<IMessage>> |
receiveDeferredMessageBatchAsync(Collection<Long> sequenceNumbers)
Asynchronously receives a set of deferred
Message from the entity. |
Instant |
renewMessageLock(IMessage message)
Renews the lock on the message specified by the lock token.
|
Instant |
renewMessageLock(UUID lockToken)
Renews the lock on the message specified by the lock token.
|
CompletableFuture<Instant> |
renewMessageLockAsync(IMessage message)
Asynchronously renews the lock on the message specified by the lock token.
|
CompletableFuture<Instant> |
renewMessageLockAsync(UUID lockToken)
Renews the lock on the message specified by the lock token.
|
Collection<Instant> |
renewMessageLockBatch(Collection<? extends IMessage> messages) |
CompletableFuture<Collection<Instant>> |
renewMessageLockBatchAsync(Collection<? extends IMessage> messages) |
void |
renewSessionLock()
Renews the lock on the session specified by the
IMessageSession.getSessionId(). |
CompletableFuture<Void> |
renewSessionLockAsync()
Renews the lock on the session specified by the
IMessageSession.getSessionId(). |
void |
setPrefetchCount(int prefetchCount)
Set the prefetch count of the receiver.
|
void |
setState(byte[] sessionState)
Set a custom state on the session which can be later retrieved using
IMessageSession.getState(). |
CompletableFuture<Void> |
setStateAsync(byte[] sessionState)
Asynchronously set a custom state on the session which can be later retrieved using
IMessageSession.getState(). |
close, closeAsync, finalize, getClientId, getIsClosed, getIsClosingOrClosed, setClosed, setClosing, throwIfClosedclone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitabandon, abandon, abandon, abandon, abandonAsync, abandonAsync, abandonAsync, abandonAsync, complete, complete, completeAsync, completeAsync, deadLetter, deadLetter, deadLetter, deadLetter, deadLetter, deadLetter, deadLetter, deadLetter, deadLetterAsync, deadLetterAsync, deadLetterAsync, deadLetterAsync, deadLetterAsync, deadLetterAsync, deadLetterAsync, deadLetterAsync, defer, defer, defer, defer, deferAsync, deferAsync, deferAsync, deferAsync, getPrefetchCount, getReceiveMode, receive, receive, receiveAsync, receiveAsync, receiveBatch, receiveBatch, receiveBatchAsync, receiveBatchAsync, receiveDeferredMessage, receiveDeferredMessageAsync, receiveDeferredMessageBatch, receiveDeferredMessageBatchAsync, renewMessageLock, renewMessageLock, renewMessageLockAsync, renewMessageLockAsync, setPrefetchCountgetEntityPathclose, closeAsyncpeek, peek, peekAsync, peekAsync, peekBatch, peekBatch, peekBatchAsync, peekBatchAsyncprotected final boolean isSessionReceiver()
protected boolean isBrowsableSession()
protected String getRequestedSessionId()
public Instant getLockedUntilUtc()
getLockedUntilUtc in interface IMessageSessionIMessageSession.getSessionId() is locked until for this client.public void renewSessionLock()
throws InterruptedException,
ServiceBusException
IMessageSessionIMessageSession.getSessionId(). The lock will be renewed based on the setting specified on the entity.
When you accept a session, the session is locked for this client instance by the service for a duration as specified during the Queue/Subscription creation. If processing of the session requires longer than this duration, the session-lock needs to be renewed. For each renewal, the session-lock is renewed by the entity's LockDuration.
Renewal of session renews all the messages in the session as well. Each individual message need not be renewed.
renewSessionLock in interface IMessageSessionInterruptedException - if the current thread was interrupted while waitingServiceBusException - if the renew failed.public CompletableFuture<Void> renewSessionLockAsync()
IMessageSessionIMessageSession.getSessionId(). The lock will be renewed based on the setting specified on the entity.renewSessionLockAsync in interface IMessageSessionIMessageSession.renewSessionLock()public void setState(byte[] sessionState)
throws InterruptedException,
ServiceBusException
IMessageSessionIMessageSession.getState().setState in interface IMessageSessionsessionState - The session state.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if the set state failed.public CompletableFuture<Void> setStateAsync(byte[] sessionState)
IMessageSessionIMessageSession.getState().setStateAsync in interface IMessageSessionsessionState - The session state.IMessageSession.setState(byte[])public byte[] getState()
throws InterruptedException,
ServiceBusException
IMessageSessiongetState in interface IMessageSessionInterruptedException - if the current thread was interrupted while waitingServiceBusException - if get state failed.public CompletableFuture<byte[]> getStateAsync()
IMessageSessiongetStateAsync in interface IMessageSessionIMessageSession.getState()public String getSessionId()
getSessionId in interface IMessageSessionprotected final CoreMessageReceiver getInternalReceiver()
public String getEntityPath()
IMessageEntityClientgetEntityPath in interface IMessageEntityClientpublic ReceiveMode getReceiveMode()
IMessageReceiverReceiveMode.getReceiveMode in interface IMessageReceiverReceiveModepublic void abandon(UUID lockToken) throws InterruptedException, ServiceBusException
IMessageReceiverMessage with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the messageabandon in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic void abandon(UUID lockToken, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the messageabandon in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic void abandon(UUID lockToken, Map<String,Object> propertiesToModify) throws InterruptedException, ServiceBusException
IMessageReceiverMessage 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 messageabandon in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic void abandon(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage 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 messageabandon in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic CompletableFuture<Void> abandonAsync(UUID lockToken)
IMessageReceiverMessage with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.abandonAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()public CompletableFuture<Void> abandonAsync(UUID lockToken, TransactionContext transaction)
IMessageReceiverMessage with lock token. This will make the message available again for processing. Abandoning a message will increase the delivery count on the message.abandonAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.public CompletableFuture<Void> abandonAsync(UUID lockToken, Map<String,Object> propertiesToModify)
IMessageReceiverMessage 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.abandonAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.public CompletableFuture<Void> abandonAsync(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)
IMessageReceiverMessage 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.abandonAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.public void complete(UUID lockToken) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token. This will delete the message from the service.complete in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic void complete(UUID lockToken, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token. This will delete the message from the service.complete in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if abandon failedpublic CompletableFuture<Void> completeAsync(UUID lockToken)
IMessageReceiverMessage using its lock token. This will delete the message from the service.completeAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()public CompletableFuture<Void> completeAsync(UUID lockToken, TransactionContext transaction)
IMessageReceiverMessage using its lock token. This will delete the message from the service.completeAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.public void defer(UUID lockToken) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token. This will move message into deferred subqueue.defer in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()InterruptedException - if the current thread was interrupted while waitingServiceBusException - if defer failedpublic void defer(UUID lockToken, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token. This will move message into deferred subqueue.defer in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if defer failedpublic void defer(UUID lockToken, Map<String,Object> propertiesToModify) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token with modified message property. This will move message into deferred subqueue.defer in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if defer failedpublic void defer(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage using its lock token with modified message property. This will move message into deferred subqueue.defer in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if defer failedpublic CompletableFuture<Void> deferAsync(UUID lockToken)
IMessageReceiverMessage using its lock token. This will move message into deferred subqueue.deferAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()public CompletableFuture<Void> deferAsync(UUID lockToken, TransactionContext transaction)
IMessageReceiverMessage using its lock token. This will move message into deferred subqueue.deferAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.public CompletableFuture<Void> deferAsync(UUID lockToken, Map<String,Object> propertiesToModify)
IMessageReceiverMessage using its lock token with modified message propert. This will move message into deferred subqueue.deferAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.public CompletableFuture<Void> deferAsync(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)
IMessageReceiverMessage using its lock token with modified message propert. This will move message into deferred subqueue.deferAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.public void deadLetter(UUID lockToken) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, Map<String,Object> propertiesToModify) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with modified message properties.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with modified message properties.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.transaction - TransactionContext which this operation should enlist to.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description and modified properties.deadLetter in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.propertiesToModify - Message properties to modify.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic void deadLetter(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify, TransactionContext transaction) throws InterruptedException, ServiceBusException
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description and modified properties.deadLetter in interface IMessageReceiverlockToken - 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.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if deadletter failedpublic CompletableFuture<Void> deadLetterAsync(UUID lockToken)
IMessageReceiverMessage to the deadletter sub-queue with deadletter.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()public CompletableFuture<Void> deadLetterAsync(UUID lockToken, TransactionContext transaction)
IMessageReceiverMessage to the deadletter sub-queue with deadletter.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()transaction - TransactionContext which this operation should enlist to.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, Map<String,Object> propertiesToModify)
IMessageReceiverMessage to the deadletter sub-queue with modified properties.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, Map<String,Object> propertiesToModify, TransactionContext transaction)
IMessageReceiverMessage to the deadletter sub-queue with modified properties.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()propertiesToModify - Message properties to modify.transaction - TransactionContext which this operation should enlist to.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription)
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, TransactionContext transaction)
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.transaction - TransactionContext which this operation should enlist to.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify)
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description and modified properties.deadLetterAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()deadLetterReason - The deadletter reason.deadLetterErrorDescription - The deadletter error description.propertiesToModify - Message properties to modify.public CompletableFuture<Void> deadLetterAsync(UUID lockToken, String deadLetterReason, String deadLetterErrorDescription, Map<String,Object> propertiesToModify, TransactionContext transaction)
IMessageReceiverMessage to the deadletter sub-queue with deadletter reason and error description and modified properties.deadLetterAsync in interface IMessageReceiverlockToken - 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.public IMessage receive() throws InterruptedException, ServiceBusException
IMessageReceiverMessage with default server wait time.receive in interface IMessageReceiverMessage or null if there is no message.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if receive failedpublic IMessage receive(Duration serverWaitTime) throws InterruptedException, ServiceBusException
IMessageReceiverMessage with specified server wait time.receive in interface IMessageReceiverserverWaitTime - The server wait timeMessage or null if there is no message.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if receive failedpublic IMessage receiveDeferredMessage(long sequenceNumber) throws ServiceBusException, InterruptedException
IMessageReceiverMessage. Deferred messages can only be received by using sequence number.receiveDeferredMessage in interface IMessageReceiversequenceNumber - The Message.getSequenceNumber().Message or null if there is no message for given sequence number.ServiceBusException - if receive failedInterruptedException - if the current thread was interrupted while waitingpublic Collection<IMessage> receiveBatch(int maxMessageCount) throws InterruptedException, ServiceBusException
IMessageReceiverMessage from Azure Service Bus.receiveBatch in interface IMessageReceivermaxMessageCount - The maximum number of messages that will be received.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if receive failedpublic Collection<IMessage> receiveBatch(int maxMessageCount, Duration serverWaitTime) throws InterruptedException, ServiceBusException
IMessageReceiverMessage from Azure Service Bus with server wait time.receiveBatch in interface IMessageReceivermaxMessageCount - The maximum number of messages that will be received.serverWaitTime - The time the client waits for receiving a message before it times out.InterruptedException - if the current thread was interrupted while waitingServiceBusException - if receive failedpublic Collection<IMessage> receiveDeferredMessageBatch(Collection<Long> sequenceNumbers) throws ServiceBusException, InterruptedException
IMessageReceiverMessage.receiveDeferredMessageBatch in interface IMessageReceiversequenceNumbers - The sequence numbers of desired deferred messages.ServiceBusException - if receive failedInterruptedException - if the current thread was interrupted while waitingpublic CompletableFuture<IMessage> receiveAsync()
IMessageReceiverMessage from Azure Service Bus.receiveAsync in interface IMessageReceiverpublic CompletableFuture<IMessage> receiveAsync(Duration serverWaitTime)
IMessageReceiverMessage from Azure Service Bus with server wait time.receiveAsync in interface IMessageReceiverserverWaitTime - The time the client waits for receiving a message before it times out.public CompletableFuture<Collection<IMessage>> receiveBatchAsync(int maxMessageCount)
IMessageReceiverMessage from the entity.receiveBatchAsync in interface IMessageReceivermaxMessageCount - The maximum number of messages that will be received.public CompletableFuture<Collection<IMessage>> receiveBatchAsync(int maxMessageCount, Duration serverWaitTime)
IMessageReceiverMessage from Azure Service Bus with server wait time.receiveBatchAsync in interface IMessageReceivermaxMessageCount - The maximum number of messages that will be received.serverWaitTime - The time the client waits for receiving a message before it times out.public CompletableFuture<IMessage> receiveDeferredMessageAsync(long sequenceNumber)
IMessageReceiverMessage identified by sequence number.receiveDeferredMessageAsync in interface IMessageReceiversequenceNumber - The sequence number of the message that will be received.public CompletableFuture<Collection<IMessage>> receiveDeferredMessageBatchAsync(Collection<Long> sequenceNumbers)
IMessageReceiverMessage from the entity.receiveDeferredMessageBatchAsync in interface IMessageReceiversequenceNumbers - The sequence numbers of the message that will be received.protected CompletableFuture<Void> onClose()
onClose in class ClientEntitypublic int getPrefetchCount()
IMessageReceivergetPrefetchCount in interface IMessageReceiverpublic void setPrefetchCount(int prefetchCount)
throws ServiceBusException
IMessageReceiverThe value cannot be set until the receiver is created.
setPrefetchCount in interface IMessageReceiverprefetchCount - The desired prefetch count.ServiceBusException - if sets the value failedpublic CompletableFuture<Instant> renewMessageLockAsync(IMessage message)
IMessageReceiverReceiveMode.PEEKLOCK mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration).
If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, the lock is reset to
the entity's LockDuration value.renewMessageLockAsync in interface IMessageReceivermessage - The Message to be renewedpublic CompletableFuture<Instant> renewMessageLockAsync(UUID lockToken)
IMessageReceiverReceiveMode.PEEKLOCK mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration).
If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, the lock is reset to
the entity's LockDuration value.
Note - calling this will not update Message.getLockedUntilUtc() and updated lockedUntilUtc must be tracked by the application.renewMessageLockAsync in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()public CompletableFuture<Collection<Instant>> renewMessageLockBatchAsync(Collection<? extends IMessage> messages)
public Collection<Instant> renewMessageLockBatch(Collection<? extends IMessage> messages) throws InterruptedException, ServiceBusException
public Instant renewMessageLock(IMessage message) throws InterruptedException, ServiceBusException
IMessageReceiverReceiveMode.PEEKLOCK mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration).
If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, the lock is reset to
the entity's LockDuration value.renewMessageLock in interface IMessageReceivermessage - The Message to be renewedInterruptedException - if the current thread was interrupted while waitingServiceBusException - if renew failedpublic Instant renewMessageLock(UUID lockToken) throws InterruptedException, ServiceBusException
IMessageReceiverReceiveMode.PEEKLOCK mode, the message is locked on the server for this
receiver instance for a duration as specified during the Queue/Subscription creation (LockDuration).
If processing of the message requires longer than this duration, the lock needs to be renewed. For each renewal, the lock is reset to
the entity's LockDuration value.
Note - calling this will not update Message.getLockedUntilUtc() and updated lockedUntilUtc must be tracked by the application.renewMessageLock in interface IMessageReceiverlockToken - Message lock token Message.getLockToken()InterruptedException - if the current thread was interrupted while waitingServiceBusException - if renew failedpublic IMessage peek() throws InterruptedException, ServiceBusException
IMessageBrowserIMessageBrowser.peek() fetches the first active message for this receiver.
Each subsequent call fetches the subsequent message in the entity.peek in interface IMessageBrowserMessage peekedInterruptedException - if the current thread was interrupted while waitingServiceBusException - if peek failedpublic IMessage peek(long fromSequenceNumber) throws InterruptedException, ServiceBusException
IMessageBrowserpeek in interface IMessageBrowserfromSequenceNumber - The sequence number from where to read the message.Message peekedInterruptedException - if the current thread was interrupted while waitingServiceBusException - if peek failedpublic Collection<IMessage> peekBatch(int messageCount) throws InterruptedException, ServiceBusException
IMessageBrowserpeekBatch in interface IMessageBrowsermessageCount - The number of messages.Message peekedInterruptedException - if the current thread was interrupted while waitingServiceBusException - if peek failedpublic Collection<IMessage> peekBatch(long fromSequenceNumber, int messageCount) throws InterruptedException, ServiceBusException
IMessageBrowserpeekBatch in interface IMessageBrowserfromSequenceNumber - The sequence number from where to read the message.messageCount - The number of messages.Message peekedInterruptedException - if the current thread was interrupted while waitingServiceBusException - if peek failedpublic CompletableFuture<IMessage> peekAsync()
IMessageBrowserpeekAsync in interface IMessageBrowserMessage peekedpublic CompletableFuture<IMessage> peekAsync(long fromSequenceNumber)
IMessageBrowserpeekAsync in interface IMessageBrowserfromSequenceNumber - The sequence number from where to read the message.Message peeked.public CompletableFuture<Collection<IMessage>> peekBatchAsync(int messageCount)
IMessageBrowserpeekBatchAsync in interface IMessageBrowsermessageCount - The number of messages.Message peeked.public CompletableFuture<Collection<IMessage>> peekBatchAsync(long fromSequenceNumber, int messageCount)
IMessageBrowserpeekBatchAsync in interface IMessageBrowserfromSequenceNumber - The sequence number from where to read the message.messageCount - The number of messages.Message peeked.Copyright © 2019 Microsoft Corporation. All rights reserved.