MessageSession Class

Package:

com.microsoft.azure.servicebus

Maven Artifact:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.primitives.ClientEntity
  • • com.microsoft.azure.servicebus.InitializableEntity
    • • com.microsoft.azure.servicebus.MessageReceiver
      • • com.microsoft.azure.servicebus.MessageSession

Implements

IMessageSession

public class MessageSession
extends com.microsoft.azure.servicebus.MessageReceiver
implements IMessageSession

Method Summary

Modifier and Type	Method and Description
Instant	getLockedUntilUtc()
protected String	getRequestedSessionId()
String	getSessionId()
byte[]	getState() Gets the session state.
CompletableFuture<byte[]>	getStateAsync() Asynchronously gets the session state.
protected boolean	isBrowsableSession()
protected final boolean	isSessionReceiver()
void	renewSessionLock() Renews the lock on the session specified by the getSessionId().
CompletableFuture<Void>	renewSessionLockAsync() Renews the lock on the session specified by the getSessionId().
void	setState(byte[] sessionState) Set a custom state on the session which can be later retrieved using getState().
CompletableFuture<Void>	setStateAsync(byte[] sessionState) Asynchronously set a custom state on the session which can be later retrieved using getState().

Methods inherited from com.microsoft.azure.servicebus.MessageReceiver

com.microsoft.azure.servicebus.MessageReceiver.abandon com.microsoft.azure.servicebus.MessageReceiver.abandon com.microsoft.azure.servicebus.MessageReceiver.abandon com.microsoft.azure.servicebus.MessageReceiver.abandon com.microsoft.azure.servicebus.MessageReceiver.abandonAsync com.microsoft.azure.servicebus.MessageReceiver.abandonAsync com.microsoft.azure.servicebus.MessageReceiver.abandonAsync com.microsoft.azure.servicebus.MessageReceiver.abandonAsync com.microsoft.azure.servicebus.MessageReceiver.complete com.microsoft.azure.servicebus.MessageReceiver.complete com.microsoft.azure.servicebus.MessageReceiver.completeAsync com.microsoft.azure.servicebus.MessageReceiver.completeAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetter com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.deadLetterAsync com.microsoft.azure.servicebus.MessageReceiver.defer com.microsoft.azure.servicebus.MessageReceiver.defer com.microsoft.azure.servicebus.MessageReceiver.defer com.microsoft.azure.servicebus.MessageReceiver.defer com.microsoft.azure.servicebus.MessageReceiver.deferAsync com.microsoft.azure.servicebus.MessageReceiver.deferAsync com.microsoft.azure.servicebus.MessageReceiver.deferAsync com.microsoft.azure.servicebus.MessageReceiver.deferAsync com.microsoft.azure.servicebus.MessageReceiver.getEntityPath com.microsoft.azure.servicebus.MessageReceiver.getInternalReceiver com.microsoft.azure.servicebus.MessageReceiver.getPrefetchCount com.microsoft.azure.servicebus.MessageReceiver.getReceiveMode com.microsoft.azure.servicebus.MessageReceiver.getRequestedSessionId com.microsoft.azure.servicebus.MessageReceiver.isBrowsableSession com.microsoft.azure.servicebus.MessageReceiver.isSessionReceiver com.microsoft.azure.servicebus.MessageReceiver.onClose com.microsoft.azure.servicebus.MessageReceiver.peek com.microsoft.azure.servicebus.MessageReceiver.peek com.microsoft.azure.servicebus.MessageReceiver.peekAsync com.microsoft.azure.servicebus.MessageReceiver.peekAsync com.microsoft.azure.servicebus.MessageReceiver.peekBatch com.microsoft.azure.servicebus.MessageReceiver.peekBatch com.microsoft.azure.servicebus.MessageReceiver.peekBatchAsync com.microsoft.azure.servicebus.MessageReceiver.peekBatchAsync com.microsoft.azure.servicebus.MessageReceiver.receive com.microsoft.azure.servicebus.MessageReceiver.receive com.microsoft.azure.servicebus.MessageReceiver.receiveAsync com.microsoft.azure.servicebus.MessageReceiver.receiveAsync com.microsoft.azure.servicebus.MessageReceiver.receiveBatch com.microsoft.azure.servicebus.MessageReceiver.receiveBatch com.microsoft.azure.servicebus.MessageReceiver.receiveBatchAsync com.microsoft.azure.servicebus.MessageReceiver.receiveBatchAsync com.microsoft.azure.servicebus.MessageReceiver.receiveDeferredMessage com.microsoft.azure.servicebus.MessageReceiver.receiveDeferredMessageAsync com.microsoft.azure.servicebus.MessageReceiver.receiveDeferredMessageBatch com.microsoft.azure.servicebus.MessageReceiver.receiveDeferredMessageBatchAsync com.microsoft.azure.servicebus.MessageReceiver.renewMessageLock com.microsoft.azure.servicebus.MessageReceiver.renewMessageLock com.microsoft.azure.servicebus.MessageReceiver.renewMessageLockAsync com.microsoft.azure.servicebus.MessageReceiver.renewMessageLockAsync com.microsoft.azure.servicebus.MessageReceiver.renewMessageLockBatch(java.util.Collection< com.microsoft.azure.servicebus.MessageReceiver.renewMessageLockBatchAsync(java.util.Collection< com.microsoft.azure.servicebus.MessageReceiver.setPrefetchCount

Methods inherited from ClientEntity

close closeAsync finalize getClientId getIsClosed getIsClosingOrClosed setClosed setClosing throwIfClosed

Methods inherited from java.lang.Object

clone equals getClass hashCode notify notifyAll toString wait wait wait

Method Details

getLockedUntilUtc

public Instant getLockedUntilUtc()

getRequestedSessionId

protected String getRequestedSessionId()

Overrides:

MessageSession.getRequestedSessionId()

getSessionId

public String getSessionId()

getState

public byte[] getState()

Gets the session state.

Throws:

InterruptedException

ServiceBusException

getStateAsync

public CompletableFuture getStateAsync()

Asynchronously gets the session state.

isBrowsableSession

protected boolean isBrowsableSession()

Overrides:

MessageSession.isBrowsableSession()

isSessionReceiver

protected final boolean isSessionReceiver()

Overrides:

MessageSession.isSessionReceiver()

renewSessionLock

public void renewSessionLock()

Renews the lock on the session specified by the 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.

Throws:

InterruptedException

ServiceBusException

renewSessionLockAsync

public CompletableFuture renewSessionLockAsync()

Renews the lock on the session specified by the getSessionId(). The lock will be renewed based on the setting specified on the entity.

setState

public void setState(byte[] sessionState)

Set a custom state on the session which can be later retrieved using getState().

Parameters:

sessionState

Throws:

InterruptedException

ServiceBusException

setStateAsync

public CompletableFuture setStateAsync(byte[] sessionState)

Asynchronously set a custom state on the session which can be later retrieved using getState().

Parameters:

sessionState