Archive Content

Please note this page is present for reference only. QMan has been removed and is no longer a released component.

GetResourceMembers

Description

This interface allows a requestor to retrieve the catalogue of all managed resources.
Note that there's no a "GetResourceMembers" request on WSRF specification. That request is actually a GetResourceProperty for wsrf-sg:Entry adapter property.
For each managed resource a dedicated entry will be returned on the corresponding response.

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/adapter
05.			</wsa:To>
06.     	        <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing">
07.				http://docs.oasis-open.org/wsrf/rpw-2/GetResourceProperty/GetResourcePropertyRequest
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>
		</soap:Header>
		<soap:Body>
17.			<wsrf-rp:GetResourceProperty
				xmlns:wsrf-rp="http://docs.oasis-open.org/wsrf/rp-2"
				xmlns:wsrf-sg="http://docs.oasis-open.org/wsrf/sg-2">
18.				wsrf-sg:Entry
19.			</wsrf-rp:GetResourceProperty>
		</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 GetResourceProperty request. In fact, the GetResourceMember is a GetResourceProperty request where a requestor ask to the adapter resource the value of wsrf-sg:Entry property value.

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

The GetResourceProperty request. Subsequent child specifies requested property name.

18

This adapeter property is basically the list of all managed resources that are currently under QMan management domain.

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/GetResourceProperty/GetResourcePropertyResponse
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/adapter
16.				</wsa:Address>
			</wsa:From>
		</soap:Header>
		<soap:Body>
17.				<wsrf-sg:Entry xmlns:wsrf-sg="http://docs.oasis-open.org/wsrf/sg-2">
18.					<wsrf-sg:ServiceGroupEntryEPR>
19.						<wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">
20.							http://localhost:8080/qman/services/ServiceGroupEntry
						</wsa:Address>
						<wsa:ReferenceParameters xmlns:wsa="http://www.w3.org/2005/08/addressing">
							<qman:ResourceId xmlns:qman="http://amqp.apache.org/qpid/management/qman">
21.								1d01b4ee-7d23-3a30-342e-62fc49984fe6
							</qman:ResourceId>
22.						</wsa:ReferenceParameters>
23.					</wsrf-sg:ServiceGroupEntryEPR>
24.					<wsrf-sg:MemberServiceEPR>
						<wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">
25.							http://localhost:8080/qman/services/QManWsResource
						</wsa:Address>
						<wsa:ReferenceParameters xmlns:wsa="http://www.w3.org/2005/08/addressing">
26.							<qman:ResourceId
								xmlns:qman="http://amqp.apache.org/qpid/management/qman">
								a3759467-bede-476d-8dde-169f1a652191
27.							</qman:ResourceId>
						</wsa:ReferenceParameters>
28.					</wsrf-sg:MemberServiceEPR>
29.					<wsrf-sg:Content/>
				</wsrf-sg:Entry>
33.				<wsrf-sg:Entry xmlns:wsrf-sg="http://docs.oasis-open.org/wsrf/sg-2">
				...
				</wsrf-sg:Entry>
				<wsrf-sg:Entry xmlns:wsrf-sg="http://docs.oasis-open.org/wsrf/sg-2">
				...
34.				</wsrf-sg:Entry>
			</wsrf-rp:GetResourcePropertyResponse>
		</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 GetResourceProperty 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

This element represent a single resource as part of QMan management domain.

18 - 22

The "group" membership information for a specific resource are detailed using a SericeGroupEntry which is separated from the WS-Resource itself.
In fact, the service group entry is a WS-Resource itself which has its own address (line 20) and identifier (line 21). That means we could have properties belonging to group membership of WS-Resource, not to WS-Resource itself.

24 - 28

The resource member that is part of QMan management group. This element contains all what is needed for identifying and addressing the WS-Resource.

25

This is the resource soap:address (as declared on its WSDL)

26 - 27

The WS-Resource identifier. This is the most important information about resource. Subsequent requests directed to resource will contain this identifier.

29

Additional (optional) management group information.

33 - 34

Those are two additional entry summaries. Note that for each resource there's a dedicated wsrf-sg:Entry.

Faults

No specific fault are thrown by this operation. A general Soap fault could be returned if, for example, the adapter is not running or is not working.

Web Services Service Group specification
Web Services Resource
Web Services Resource Properties

  • No labels