Note | ||
---|---|---|
| ||
Please note this page is present for reference only. QMan has been removed and is no longer a released component. |
GetMultipleResourceProperties
Table of Contents | ||||
---|---|---|---|---|
|
Description
This interface allows a requestor to retrieve the values of multiple resource properties of a WS-Resource.
Request
Code Block | ||||
---|---|---|---|---|
| ||||
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/QManWsResource 05. </wsa:To> 06. <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing"> 07. http://docs.oasis-open.org/wsrf/rpw-2/GetMultipleResourceProperties/GetMultipleResourcePropertiesRequest 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:ResourceId xmlns:wsa="http://www.w3.org/2005/08/addressing" wsa:IsReferenceParameter="true" xmlns:qman="http://amqp.apache.org/qpid/management/qman"> 18. 781f4ad7-4c96-4caa-b69d-291461cdb1fc 19. </qman:ResourceId> </soap:Header> <soap:Body> 20. <wsrf-rp:GetMultipleResourceProperties xmlns:wsrf-rp="http://docs.oasis-open.org/wsrf/rp-2" xmlns:qman="http://amqp.apache.org/qpid/management/qman"> 21. <wsrf-rp:ResourceProperty >qman:MgmtPubInterval</wsrf-rp:ResourceProperty> 22. <wsrf-rp:ResourceProperty>qman:Name</wsrf-rp:ResourceProperty> 23. <wsrf-rp:ResourceProperty>qman:MsgTotalEnqueues</wsrf-rp:ResourceProperty> 24. <wsrf-rp:ResourceProperty>qman:Arguments</wsrf-rp:ResourceProperty> 25. <wsrf-rp:ResourceProperty>qman:VhostRef</wsrf-rp:ResourceProperty> 26. <wsrf-rp:ResourceProperty>qman:ExpireTime</wsrf-rp:ResourceProperty> 27. <wsrf-rp:ResourceProperty>qman:Durable</wsrf-rp:ResourceProperty> 28. <wsrf-rp:ResourceProperty>qman:ConsumerCount</wsrf-rp:ResourceProperty> 29. <wsrf-rp:ResourceProperty>qman:Type</wsrf-rp:ResourceProperty> 30. </wsrf-rp:GetMultipleResourceProperties> </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. |
06 - 08 | Indicate this is a GetMultipleResourceProperties 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 of this request. Specifically the line 18 contains the resource identifier. |
20 - 30 | The GetMultipleResourceProperties request. As you can see requested properties are nested children (line 21 - 29). |
21 - 29 | Each wsrf-rp:ResourceProperty contains a resource property QName. |
Response
Code Block | ||||
---|---|---|---|---|
| ||||
<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/wsrf/rpw-2/GetMultipleResourceProperties/GetMultipleResourcePropertiesResponse 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/QManWsResource 16. </wsa:Address> 17. <wsa:ReferenceParameters> <qman:ResourceId xmlns:wsa="http://www.w3.org/2005/08/addressing" wsa:IsReferenceParameter="true" xmlns:qman="http://amqp.apache.org/qpid/management/qman"> 18. 781f4ad7-4c96-4caa-b69d-291461cdb1fc 19. </qman:ResourceId> 20. </wsa:ReferenceParameters> </wsa:From> </soap:Header> <soap:Body> 21. <wsrf-rp:GetMultipleResourcePropertiesResponse xmlns:qman="http://amqp.apache.org/qpid/management/qman" xmlns:wsrf-rp="http://docs.oasis-open.org/wsrf/rp-2"> 22. <qman:MgmtPubInterval>32767</qman:MgmtPubInterval> 23. <qman:Name>Initial Name</qman:Name> 24. <qman:MsgTotalEnqueues>9223372036854775797</qman:MsgTotalEnqueues> 25. <qman:Arguments xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <qman:entry> <qman:key>Key3</qman:key> <qman:value xsi:type="xsd:integer">2147483647</qman:value> </qman:entry> <qman:entry> <qman:key>Key4</qman:key> <qman:value xsi:type="xsd:float">3.4028235E38</qman:value> </qman:entry> <qman:entry> <qman:key>Key1</qman:key> <qman:value xsi:type="xsd:string">aStringValue</qman:value> </qman:entry> <qman:entry> <qman:key>Key2</qman:key> <qman:value xsi:type="xsd:long">-9223372036854775808</qman:value> </qman:entry> 26. </qman:Arguments> 27. <qman:VhostRef>2deef1b3-d2c6-49f3-a8de-51f6a75a1a6b</qman:VhostRef> 28. <qman:ExpireTime>9223372036854775807</qman:ExpireTime> 29. <qman:Durable>true</qman:Durable> 30. <qman:ConsumerCount>-2147483638</qman:ConsumerCount> 31. </wsrf-rp:GetMultipleResourcePropertiesResponse> </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 GetMultipleResourceProperties response. This is done as usual using a wsa:Action that is part of WS-Addressing specification. |
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 - 31 | This is the GetMultipleResourceProperties response element which contains the requested property values as nested child. |
22 - 30 | Each element represents a requested properties. Note that the name of the element is the name of the property. |
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.
- InvalidResourcePropertyQNameFault : One or more of the names (QNames) in the request message doesn't correspond to a property element of the target WS-Resource.