(SQL Server) 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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- 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.
    DECLARE @rest int
    -- Use "Chilkat_9_5_0.Rest" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Rest', @rest OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    DECLARE @success int
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, '<yournamespace>.servicebus.windows.net', 443, 1, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    -- 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.
    DECLARE @sbToken int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbToken OUT

    EXEC sp_OAMethod @sbToken, 'LoadFile', @success OUT, 'qa_data/tokens/serviceBusSas.txt', 'utf-8'

    -- Tell the REST object to use the Azure Shared Access Signature for authorization.
    EXEC sp_OAMethod @sbToken, 'Prepend', @success OUT, 'SharedAccessSignature '
    EXEC sp_OAMethod @sbToken, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Authorization', @sTmp0

    -- ----------------------------------------------------------------------------------------------
    -- 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.
    DECLARE @topicName nvarchar(4000)
    SELECT @topicName = 'gilaMonster'
    DECLARE @subscriptionName nvarchar(4000)
    SELECT @subscriptionName = 'feedings'
    DECLARE @messageId nvarchar(4000)
    SELECT @messageId = '7bea513a6ddb49089e07bfbee26d85bd'
    DECLARE @lockToken nvarchar(4000)
    SELECT @lockToken = '0a13ee8a-be32-4458-89e0-5e1401caa6a0'

    -- Build the path..
    DECLARE @sbPath int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPath OUT

    EXEC sp_OAMethod @sbPath, 'Append', @success OUT, '/{topicPath}/subscriptions/{subscriptionName}/messages/{messageId|sequenceNumber}/{lockToken}'
    DECLARE @numReplaced int
    EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, '{topicPath}', @topicName
    EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, '{subscriptionName}', @subscriptionName
    EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, '{messageId|sequenceNumber}', @messageId
    EXEC sp_OAMethod @sbPath, 'Replace', @numReplaced OUT, '{lockToken}', @lockToken

    -- Add a timeout parameter.
    EXEC sp_OAMethod @rest, 'AddQueryParam', @success OUT, 'timeout', '20'

    -- Use the PUT HTTP verb to unlock the message.
    DECLARE @sbResponseBody int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT

    EXEC sp_OAMethod @sbPath, 'GetAsString', @sTmp0 OUT
    EXEC sp_OAMethod @rest, 'FullRequestNoBodySb', @success OUT, 'PUT', @sTmp0, @sbResponseBody
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbToken
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END


    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    PRINT 'Response Status Code = ' + @iTmp0

    -- Check for a success response.
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
    IF @iTmp0 <> 200
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastRequestStartLine', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAGetProperty @rest, 'LastRequestHeader', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed.'
        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @sbToken
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @sbResponseBody
        RETURN
      END

    -- If successful, the response body would be empty..

    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @sbToken
    EXEC @hr = sp_OADestroy @sbPath
    EXEC @hr = sp_OADestroy @sbResponseBody


END
GO