com.azure.messaging.servicebus

Interface MessageLockToken

All Known Implementing Classes:

ServiceBusReceivedMessage

public interface MessageLockToken

Type representing the lock-token. The lock token is a reference to the lock that is being held by the Service Bus in ReceiveMode.PEEK_LOCK mode.

Method Summary

Modifier and Type	Method and Description
static MessageLockToken	fromString(String lockToken) Created the MessageLockToken given a String.
String	getLockToken() Gets the lock token.

Method Detail

getLockToken

String getLockToken()

Gets the lock token.

Returns:

Lock token for the message.

fromString

static MessageLockToken fromString(String lockToken)

Created the MessageLockToken given a String.

Parameters:

lockToken - String for creating MessageLockToken instance;

Returns:

The created MessageLockToken object.

Throws:

NullPointerException - if lockToken is null.

IllegalArgumentException - if lockToken is empty or invalid.