[CONF] Apache Qpid: PauseSubscription (page edited)

Fri, 27 Feb 2009 05:28:37 -0800

Page Edited : qpid : PauseSubscription

PauseSubscription has been edited by Andrea Gazzarini (Feb 27, 2009).

(View changes)

Content:

Pause Subscription

Description

This interface allows a requestor to temporarily suspend an existing subscription. After successful processing the pause request the subscription is in the paused state. Production of further notifications can be resumed using a ResumeSubscription request.
In order to be able to send a pause subscription request, the consumer must have a valid subscription reference like this :

<wsnt:SubscribeResponse xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2">
  <wsnt:SubscriptionReference>
    <wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">
	http://localhost:8080/qman/services/SubscriptionManager
    </wsa:Address>
    <wsa:ReferenceParameters xmlns:wsa="http://www.w3.org/2005/08/addressing">
        <qman-wsa:ResourceId>
	    282f28e6-4396-4000-a19d-87a03978e8a0
	</qman-wsa:ResourceId>
    </wsa:ReferenceParameters>
  </wsnt:SubscriptionReference>
  <wsnt:CurrentTime>2009-02-27T13:51:56+01:00</wsnt:CurrentTime>
</wsnt:SubscribeResponse>




A pause request has no effect on an already resumed subscription.



Request





01.	<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
02.		<soap:Header>
03.			<wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">
04.				http://localhost:8080/qman/services/SubscriptionManager
05.			</wsa:To>
06.     	        <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">
07.				http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/PauseSubscriptionRequest
08.			</wsa:Action>
09.     	        <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">
10.				uuid:0cdb5112-09e0-ac39-06ba-393843f06e42
11.			</wsa:MessageID>
12.			<wsa:From xmlns:wsa="http://www.w3.org/2005/08/addressing">
13.     		        <wsa:Address>
14.					http://www.w3.org/2005/08/addressing/role/anonymous
15.				</wsa:Address>
16.			</wsa:From>
17.			<qman-wsa:ResourceId
				xmlns:wsa="http://www.w3.org/2005/08/addressing"
				wsa:IsReferenceParameter="true"
				xmlns:qman-wsa="http://amqp.apache.org/qpid/management/qman/addressing">
18.				282f28e6-4396-4000-a19d-87a03978e8a0
19.			</qman-wsa:ResourceId>
		</soap:Header>
		<soap:Body xmlns:qman="http://amqp.apache.org/qpid/management/qman">
20.			<wsnt:PauseSubscription xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"/>
		</soap:Body>
	</soap:Envelope>







 Line(s) 
 Description 




 01 
 The SOAP <Envelope> is the root element in every SOAP message, and contains two child elements, <Header> and <Body>. 




 02 
 The SOAP Header will contain all metadata used for identifying the conversation participants (requestor and provider). 




 03 - 05 
 Convey the target endpoint also known (in the request phase) as service provider. In this case that's the Subscription Manager WS-Resource. 




 06 - 08 
 Indicate this is a PauseSubscription request. 




 09 - 11 
 Convey a unique identifier associated with the current message. This will be used for request / response messages correlation. 




 12 - 15 
 Provide the address of the source endpoint also known (in the request phase) as service requestor. 




 17 - 19 
 This indicates the target resource (subscription) of this request. Specifically the line 18 contains the subscription identifier previously mentioned. 




 20 
 The pause subscription body. As you can see there are no parameters for this kind of request. 






Response





<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope">
		<soap:Header>
01.			<wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing">
02.				http://www.w3.org/2005/08/addressing/role/anonymous
03.			</wsa:To>
04.			<wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">
05.				http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/PauseSubscriptionResponse
06.			</wsa:Action>
07.			<wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">
08.				uuid:980617c8-e3a0-ebf1-8f5a-2b43d3d6d416
09.			</wsa:MessageID>
10.			<wsa:RelatesTo RelationshipType="wsa:Reply" xmlns:wsa="http://www.w3.org/2005/08/addressing">
11.				uuid:0cdb5112-09e0-ac39-06ba-393843f06e42
12.			</wsa:RelatesTo>
13.			<wsa:From xmlns:wsa="http://www.w3.org/2005/08/addressing">
14.				<wsa:Address>
15.					http://localhost:8080/qman/services/SubscriptionManager
16.				</wsa:Address>
17.				<wsa:ReferenceParameters>
					<qman-wsa:ResourceId
						xmlns:wsa="http://www.w3.org/2005/08/addressing"
						wsa:IsReferenceParameter="true"
						xmlns:qman-wsa="http://amqp.apache.org/qpid/management/qman/addressing">
18.						282f28e6-4396-4000-a19d-87a03978e8a0
19.					</qman-wsa:ResourceId>
20.                             </wsa:ReferenceParameters>
			</wsa:From>
		</soap:Header>
		<soap:Body>
21.			<wsnt:PauseSubscriptionResponse xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"/>
		</soapBody>
	</soap:Envelope>







 Line(s) 
 Description 




 01 - 03 
 Convey the recipient of the response message. Note that this time we are talking about the service requestor; The address matches the <wsa:From> previously found in the corresponding request. 




 04 - 06 
 Indicate this is a PauseSubscription response. 




 07 - 09 
 Convey a unique identifier associated with the current response message. 




 10 - 12 
 This element provides the identifier of the correlated (request) message. 




 13 
 The <wsa:From> element (part of WS-Addressing specs too) identifies the source endpoint, the originator of this response message. 




 14 - 16 
 This is the address of the source service endpoint. As said for lines 01-03 this time this is referred to service provider (the message originator). 




 17 - 20 
 As part of wsa:From element, this contains (specifically on line 18) additional information needed for identifying the originator of this message. 




 21 
 This is the response body indicating that the subscription has been successfully suspended. 






Faults



    
	
  • ResourceUnknownFault : There's no resource on QMan associated with the given reference information (soap address and identifier).
    • 
	
  • ResourceUnavailableFault : The requested resource is unavailable. This fault should indicate a transient condition. That means a requester might resend the message.
    • 
	
  • PauseFailedFault : The subscription has not been suspended.
    • 





Quick links



Web Services Resource 

Web Services Base Notification

Powered by Atlassian Confluence (Version: 2.2.9 Build:#527 Sep 07, 2006) - Bug/feature request

Unsubscribe or edit your notifications preferences
--------------------------------------------------------------------- Apache Qpid - AMQP Messaging Implementation Project: http://qpid.apache.org Use/Interact: mailto:[email protected]

Reply via email to