PowerBuilder

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

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Rest
integer li_BAutoReconnect
oleobject loo_SbToken
string ls_TopicName
string ls_SubscriptionName
string ls_MessageId
string ls_LockToken
oleobject loo_SbPath
integer li_NumReplaced
oleobject loo_SbResponseBody

li_Success = 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.
loo_Rest = create oleobject
li_rc = loo_Rest.ConnectToNewObject("Chilkat.Rest")
if li_rc < 0 then
    destroy loo_Rest
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_BAutoReconnect = 1
li_Success = loo_Rest.Connect("<yournamespace>.servicebus.windows.net",443,1,li_BAutoReconnect)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    return
end if

// 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.
loo_SbToken = create oleobject
li_rc = loo_SbToken.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbToken.LoadFile("qa_data/tokens/serviceBusSas.txt","utf-8")

// Tell the REST object to use the Azure Shared Access Signature for authorization.
loo_SbToken.Prepend("SharedAccessSignature ")
loo_Rest.AddHeader("Authorization",loo_SbToken.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.
ls_TopicName = "gilaMonster"
ls_SubscriptionName = "feedings"
ls_MessageId = "7bea513a6ddb49089e07bfbee26d85bd"
ls_LockToken = "0a13ee8a-be32-4458-89e0-5e1401caa6a0"

// Build the path..
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}")
li_NumReplaced = loo_SbPath.Replace("{topicPath}",ls_TopicName)
li_NumReplaced = loo_SbPath.Replace("{subscriptionName}",ls_SubscriptionName)
li_NumReplaced = loo_SbPath.Replace("{messageId|sequenceNumber}",ls_MessageId)
li_NumReplaced = loo_SbPath.Replace("{lockToken}",ls_LockToken)

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

// Use the PUT HTTP verb to unlock the message.
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Rest.FullRequestNoBodySb("PUT",loo_SbPath.GetAsString(),loo_SbResponseBody)
if li_Success <> 1 then
    Write-Debug loo_Rest.LastErrorText
    destroy loo_Rest
    destroy loo_SbToken
    destroy loo_SbPath
    destroy loo_SbResponseBody
    return
end if

Write-Debug "Response Status Code = " + string(loo_Rest.ResponseStatusCode)

// Check for a success response.
if loo_Rest.ResponseStatusCode <> 200 then
    Write-Debug loo_Rest.LastRequestStartLine
    Write-Debug loo_Rest.LastRequestHeader
    Write-Debug loo_SbResponseBody.GetAsString()
    Write-Debug "Failed."
    destroy loo_Rest
    destroy loo_SbToken
    destroy loo_SbPath
    destroy loo_SbResponseBody
    return
end if

// If successful, the response body would be empty..
Write-Debug "Success."


destroy loo_Rest
destroy loo_SbToken
destroy loo_SbPath
destroy loo_SbResponseBody