Xbase++

Azure Service Bus - Unlock Message

See more Azure Service Bus Examples

Shows how to unlock a message for processing by other receivers on a specified queue or subscription. This operation deletes the lock object, causing the message to be unlocked.

For more information, see https://docs.microsoft.com/en-us/rest/api/servicebus/unlock-message

Xbase++

LOCAL nSuccess
LOCAL oRest
LOCAL nBAutoReconnect
LOCAL oSbToken
LOCAL cTopicName
LOCAL cSubscriptionName
LOCAL cMessageId
LOCAL cLockToken
LOCAL oSbPath
LOCAL nNumReplaced
LOCAL oSbResponseBody

nSuccess := 0

//  Note: Requires Chilkat v9.5.0.65 or greater.

//  This requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

//  Make the initial connection.
//  A single REST object, once connected, can be used for many Azure Service Bus REST API calls.
//  The auto-reconnect indicates that if the already-established HTTPS connection is closed,
//  then it will be automatically re-established as needed.
oRest := CreateObject("Chilkat.Rest")
nBAutoReconnect := 1
nSuccess := oRest:Connect("<yournamespace>.servicebus.windows.net", 443, 1, nBAutoReconnect)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    RETURN
ENDIF

//  Let's load a previously computed SAS token and use it.
//  See Azure Shared Access Signature for an example to genenerate an Azure SAS token.
oSbToken := CreateObject("Chilkat.StringBuilder")
oSbToken:LoadFile("qa_data/tokens/serviceBusSas.txt", "utf-8")

//  Tell the REST object to use the Azure Shared Access Signature for authorization.
oSbToken:Prepend("SharedAccessSignature ")
oRest:AddHeader("Authorization", oSbToken:GetAsString())

//  ----------------------------------------------------------------------------------------------
//  The code above this comment could be placed inside a function/subroutine within the application
//  because the connection does not need to be made for every request.  Once the connection is made
//  the app may send many requests..
//  ----------------------------------------------------------------------------------------------

//  To unlock a message, we'll need either the SequenceNumber or MessageId.
//  When the message was locked, the SequenceNumber and MessageId of the locked message
//  was returned in the HTTP response header named "BrokerProperties, which contained
//  JSON such as the following:

//  	{
//  	  "DeliveryCount": 2,
//  	  "EnqueuedSequenceNumber": 3000003,
//  	  "EnqueuedTimeUtc": "Wed, 07 Dec 2016 17:42:48 GMT",
//  	  "Label": "M2",
//  	  "LockToken": "0a13ee8a-be32-4458-89e0-5e1401caa6a0",
//  	  "LockedUntilUtc": "Wed, 07 Dec 2016 18:13:12 GMT",
//  	  "MessageId": "7bea513a6ddb49089e07bfbee26d85bd",
//  	  "SequenceNumber": 3,
//  	  "State": "Active",
//  	  "TimeToLive": 922337203685.47754
//  	}

//  The path for unlocking a message is constructed as follows, depending on
//  whether it is a message on a queue or subscription:
//  
//  (for a queue)
//  /{queuePath}/messages/{messageId|sequenceNumber}/{lockToken}
//  
//  (for a subscription)
//  /{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}

//  This example will build a path to unlock a message contained in a subscription.
cTopicName := "gilaMonster"
cSubscriptionName := "feedings"
cMessageId := "7bea513a6ddb49089e07bfbee26d85bd"
cLockToken := "0a13ee8a-be32-4458-89e0-5e1401caa6a0"

//  Build the path..
oSbPath := CreateObject("Chilkat.StringBuilder")
oSbPath:Append("/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}")
nNumReplaced := oSbPath:Replace("{topicPath}", cTopicName)
nNumReplaced := oSbPath:Replace("{subscriptionName}", cSubscriptionName)
nNumReplaced := oSbPath:Replace("{messageId|sequenceNumber}", cMessageId)
nNumReplaced := oSbPath:Replace("{lockToken}", cLockToken)

//  Add a timeout parameter.
oRest:AddQueryParam("timeout", "20")

//  Use the PUT HTTP verb to unlock the message.
oSbResponseBody := CreateObject("Chilkat.StringBuilder")
nSuccess := oRest:FullRequestNoBodySb("PUT", oSbPath:GetAsString(), oSbResponseBody)
IF (nSuccess != 1)
    ? oRest:LastErrorText
    oRest:destroy()
    oSbToken:destroy()
    oSbPath:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

? "Response Status Code = " + Str(oRest:ResponseStatusCode)

//  Check for a success response.
IF (oRest:ResponseStatusCode != 200)
    ? oRest:LastRequestStartLine
    ? oRest:LastRequestHeader
    ? oSbResponseBody:GetAsString()
    ? "Failed."
    oRest:destroy()
    oSbToken:destroy()
    oSbPath:destroy()
    oSbResponseBody:destroy()
    RETURN
ENDIF

//  If successful, the response body would be empty..
? "Success."

oRest:destroy()
oSbToken:destroy()
oSbPath:destroy()
oSbResponseBody:destroy()