THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
Archive Content
Please note this page is present for reference only. QMan has been removed and is no longer a released component.
QueryResourceProperties
Description
This interface allows a requestor to query the resource properties document of a managed resource using a query expression.
The given expression is evaluated against the resource properties document of the target resource.
Note that although this request allows to declare a dialect for the given expression, only the XPath 1.0 dialect is supported at the moment.
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/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/QueryResourceProperties/QueryResourcePropertiesRequest 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:QueryResourceProperties> 21. <wsrf-rp:QueryExpression Dialect="http://www.w3.org/TR/1999/REC-xpath-19991116" > 22. boolean(/*/MgtPubInterval > 100 and /*/MsgTotalEnqueues > 56272) 23. </wsrf-rp:QueryExpression> 24. </wsrf-rp:QueryResourceProperties> </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 QueryResourceProperties 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 - 22 |
The QueryResourceProperties request. |
22 |
The XPath expression that will be evaluated against the resource properties document of the target resource. |
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/wsrf/rpw-2/QueryResourceProperties/QueryResourcePropertiesResponse 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:QueryResourcePropertiesResponse xmlns:wsrf-rp="http://docs.oasis-open.org/wsrf/rp-2"> 22. true 23. </wsrf-rp:QueryResourcePropertiesResponse> </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 QueryResourceProperties 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 - 23 |
This is the QuertyResourceProperties response element which contains the result of the evaluated query. |
22 |
This element represents the requested property. 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.
- UnknownQueryExpressionDialectFault : Remember that only XPath 1.0 is supported. This fault is thrown if another dialect is declared on request message.
- InvalidQueryExpressionFault : The given expression is not valid according to the corresponding dialect (XPath).
- QueryEvaluationErrorFault : The evaluation of the given expression thrown an exception.