1
3
Web Services Resource Properties 1.2
(WS-ResourceProperties)
4
Working Draft 04, 10 June 2004
5
6
Document identifier:
wsrf-WS-ResourceProperties-1.2-draft-04
7
8
Location:
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties-1.2-draft-04.pdf
2
9
10
11
Editors:
Steve Graham, IBM <sggraham@us.ibm.com>
Jem Treadwell, Hewlett-Packard Company <Jem.Treadwell@hp.com>
12
13
14
15
16
17
18
Abstract:
The relationship between Web services and stateful resources is defined in [State Paper].
This relationship is described as the implied resource pattern. In the implied resource
pattern, messages to a Web service may include a component that identifies a stateful
resource to be used in the execution of the message. We refer to the composition of a
stateful resource and a Web service under the implied resource pattern as a WSResource.
19
20
21
22
23
24
This document standardizes the means by which the definition of the properties of a WSResource may be declared as part of a Web service interface. The declaration of the WSResource’s properties represents a projection of or a view on the WS-Resource’s state.
This projection is defined in terms of a resource properties document. This resource
properties document serves to define a basis for access to the resource properties
through Web service interfaces.
25
26
27
28
This specification also defines a standard set of message exchanges that allow a
requestor to query or update the property values of the WS-Resource. The set of
properties defined in the resource properties document associated with the service
interface defines the constraints on the valid contents of these message exchanges.
29
30
31
32
33
34
35
Status:
This document and associated schema are published by this TC as "working drafts" and
represent the starting point for our standardization process. It is possible that they may
change significantly during this process, but should nonetheless provide a stable
reference for discussion and early adopters' implementations.
Committee members should send comments on this specification to the wsrf@lists.oasisopen.org list. Others should subscribe to and send comments to the wsrfwsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 1 of 52
36
37
38
comment@lists.oasis-open.org list. To subscribe, send an email message to wsrfcomment-request@lists.oasis-open.org with the word "subscribe" as the body of the
message.
39
40
41
42
For information on whether any patents have been disclosed that may be essential to
implementing this specification, and any offers of patent licensing terms, please refer to
the Intellectual Property Rights section of the WSRF TC web page (http://www.oasisopen.org/committees/wsrf/).
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 2 of 52
43
Table of Contents
44
1
Introduction........................................................................................................................... 4
1.1
45
Goals and Requirements ............................................................................................. 4
46
1.1.1
Requirements .......................................................................................................... 4
47
1.1.2
Non-Goals ............................................................................................................... 5
48
1.2
Terminology ................................................................................................................. 5
49
1.3
Namespaces................................................................................................................ 5
50
2
Terminology and Concepts................................................................................................... 7
51
3
Example ............................................................................................................................... 9
52
4
Declaring Resource Properties........................................................................................... 11
53
4.1
Resource Properties Document ................................................................................. 11
54
4.2
Resource Properties Document Type ........................................................................ 11
55
4.3
Declaring the Resource Properties Document Type in WSDL ................................... 12
56
4.4
Resource Properties and Interface Aggregation ........................................................ 12
57
5
Operations on Resource Properties.................................................................................... 15
5.1
58
5.1.1
59
5.2
60
GetResourceProperty ................................................................................................ 15
Example SOAP Encoding of the GetResourceProperty Message Exchange......... 16
GetMultipleResourceProperties ................................................................................. 17
5.2.1 Example SOAP Encoding of the GetMultipleResourceProperties Message
Exchange ........................................................................................................................... 19
61
62
5.3
63
5.3.1
64
5.4
65
5.4.1
66
SetResourceProperties .............................................................................................. 20
Example SOAP Encoding of the SetResourceProperties Message Exchange ...... 23
QueryResourceProperties.......................................................................................... 25
Example SOAP Encoding of the QueryResourceProperties Message Exchange .. 26
67
6
Subscription........................................................................................................................ 29
68
7
ACID Properties of Operations on WS-Resources ............................................................. 32
69
8
Security Considerations...................................................................................................... 33
70
8.1
Securing the message exchanges ............................................................................. 33
71
8.2
Securing Resource Properties ................................................................................... 34
72
9
References ......................................................................................................................... 36
73
9.1
Normative .................................................................................................................. 36
74
9.2
Non-Normative........................................................................................................... 36
75
Appendix A. Acknowledgments................................................................................................... 37
76
Appendix B. XML Schema .......................................................................................................... 38
77
Appendix C. WSDL 1.1 ............................................................................................................... 41
78
Appendix D. Revision History...................................................................................................... 51
79
Appendix E. Notices.................................................................................................................... 52
80
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 3 of 52
81
1 Introduction
82
83
84
85
86
The relationship between Web services and stateful resources is defined in [State Paper]. This
relationship is described as the implied resource pattern. In the implied resource pattern,
messages to a Web service include a component that identifies a stateful resource to be used in
the execution of the message exchange. We refer to the composition of a stateful resource and a
Web service under the implied resource pattern as a WS-Resource.
87
88
89
90
91
92
This specification standardizes the means by which the definition of the properties of a WSResource may be declared as part of the Web service interface. The declaration of the WSResource’s properties represents a projection of or a view on the WS-Resource’s state. The
projection is defined in terms of a resource properties document. This resource properties
document serves to define a basis for access to the resource properties through the Web service
interface.
93
94
95
96
This specification also defines a standard set of message exchanges that allow a requestor to
query or update the property values of the implied resource. The set of properties defined in the
resource properties document, and associated with the service interface, defines the constraints
on the valid contents of these message exchanges.
97
98
99
100
101
102
In this document, we outline the goals and requirements for resource properties. We define the
means to declare resource properties as part of a Web service description. Following this, we
define the message exchanges for querying and updating resource property values. The
document concludes with a discussion of security considerations, including a discussion of
security considerations associated with resource properties. As an appendix, we provide
normative XML and WSDL descriptions of resource properties.
103
104
WS-ResourceProperties is inspired by a portion of the Global Grid Forum’s “Open Grid
Services Infrastructure (OGSI) Version 1.0” specification [OGSI].
105
1.1 Goals and Requirements
106
107
108
109
The goal of WS-ResourceProperties is to standardize the terminology, concepts, operations,
WSDL and XML needed to express the resource properties projection, its association with the
Web service interface, and the messages defining the query and update capability against the
properties of a WS-Resource.
110
1.1.1 Requirements
111
In meeting this goal, the specification must address the following specific requirements:
112
This specification MUST:
113
•
Define the term “resource property” and its relationship to Web services and WS-Resources.
114
115
•
Define the means by which a designer decorates a Web service description with the names
and types of properties associated with a WS-Resource.
116
•
Define the means by which a requestor can:
117
•
Retrieve the values of one or more properties of a WS-Resource
118
•
Update the values of one or more properties of a WS-Resource
119
•
Query across the values of one or more properties of a WS-Resource
120
121
•
Subscribe for notification [WS-Notification] when the value of a WS-Resource property
changes.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 4 of 52
122
123
124
125
126
The means by which resource property values are retrieved and updated SHOULD reflect a
document-oriented style and MUST provide the means to perform batched query and update
against the implied resource in a single message exchange. This will facilitate improved
performance over approaches requiring a separate request message exchange for each
individual resource property access.
127
128
129
130
131
132
133
134
135
136
Web services are often described using a collection of message exchange sets (e.g. WSDL 1.1
portTypes). These message exchange sets may be aggregated (using manual cut-and-paste in
WSDL 1.1) to form the “final” composed interface definition for the Web service. The requestor’s
exposure to and interpretation of the Web service interface may be defined by a partial subset of
the constituent message exchange sets in the overall interface composition. Therefore, a
requestor will form resource property-related message requests based on this potentially partial
understanding of the overall composed interface to the Web service. It MUST be possible for a
requestor, having partial knowledge of the composed service interface, to form correct and
consistent resource property access message requests that execute properly on a Web service
that implements an extended message exchange set.
137
1.1.2 Non-Goals
138
The following topics are outside the scope of this specification:
139
140
141
General purpose XML document query and update: This specification is not meant to be used for
querying and updating generic XML documents, or to be used outside the context of modeling
stateful resources with Web services.
142
1.2 Terminology
143
144
145
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
interpreted as described in [RFC 2119].
146
147
148
When describing abstract data models, this specification uses the notational convention used by
the [XML Infoset]. Specifically, abstract property names always appear in square brackets (e.g.,
[some property]).
149
150
151
152
153
When describing concrete XML schemas, this specification uses the notational convention of
[WS-Security]. Specifically, each member of an element’s [children] or [attributes] property is
described using an XPath-like notation (e.g., /x:MyHeader/x:SomeProperty/@value1). The use of
{any} indicates the presence of an element wildcard (<xsd:any/>). The use of @{any} indicates
the presence of an attribute wildcard (<xsd:anyAttribute/>).
154
1.3 Namespaces
155
The following namespaces are used in this document:
Prefix
Namespace
s12
http://www.w3.org/2003/05/soap-envelope
xsd
http://www.w3.org/2001/XMLSchema
wsp
http://schemas.xmlsoap.org/ws/2002/12/policy
wsa
http://schemas.xmlsoap.org/ws/2003/02/addressing
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 5 of 52
wsrp
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties-1.2draft-01.xsd
wsrpw
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties-1.2draft-01.wsdl
wsbf
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2-draft01.xsd
wsbfw
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2-draft01.wsdl
wsnt
http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2draft-01.xsd
wsntw
http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2draft-01.wsdl
156
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 6 of 52
157
2 Terminology and Concepts
158
159
The following definitions outline the terminology and usage in this specification. This section gives
only brief description of these terms.
160
WS-Resource:
161
162
163
164
165
o
A Web service having an association with a stateful resource, where the stateful resource
is defined by a resource properties document type and the association is expressed by
annotating a WSDL portType with the type definition of the resource properties
document.
Implied Resource Pattern:
166
167
o
The way WS-Addressing must be used to designate the stateful resource component of
the WS-Resource to be used in the execution of message exchanges.
168
169
170
171
o
An EndpointReference that follows the implied resource pattern may include a
ReferenceProperties child element that identifies the stateful resource component of the
WS-Resource to be used in the execution of all message exchanges performed using
this EndpointReference.
172
173
174
175
176
o
A message that follows the implied resource pattern MUST be sent to a Web service
referred to by an EndpointReference that follows the implied resource pattern, and MUST
conform to the WS-Addressing requirements on that message including adding the
ReferenceProperties information, if present, from that EndpointReference to the
message.
177
178
179
180
o
A Web service that follows the implied resource pattern MAY use the
ReferenceProperties information from a message that follows the implied resource
pattern in order to identify the stateful resource to be used in the execution requested by
that message.
181
WS-Resource Qualified Endpoint Reference:
182
183
o
An Endpoint Reference used to refer to a WS-Resource composed of a Web service and
a stateful resource.
184
185
o
A stateful resource identifier MAY be contained within the ReferenceProperties element
of the Endpoint Reference.
186
187
o
The address of the Web service associated with the WS-Resource MUST be contained in
the Address element of the Endpoint Reference.
188
Resource Property:
189
190
o
A resource property is a piece of information defined as part of the state model of a WSResource.
191
192
o
A resource property may reflect a part of the resource’s state, meta-data, manageability
information, etc.
193
Resource Properties Document:
194
195
196
o
The XML document representing a logical composition of resource property elements.
The resource properties document defines a particular view or projection of the state data
implemented by the WS-Resource.
197
198
199
o
The type (e.g. the XML Schema definition of the root element) of a resource properties
document is associated with the WSDL portType defining the Web service interface. This
association is the basis of the WS-Resource definition. Each instance of a particular WS-
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 7 of 52
200
201
202
Resource type MUST implement a logical resource properties document of the type
declared in the WSDL portType.
Resource Property Element:
203
o
The XML representation of a resource property.
204
205
o
A resource property element must appear as the immediate child of the root element of a
resource properties document.
206
207
o
A resource property element must be an XML global element definition (GED), and is
uniquely identified by QName.
208
209
Resource Property Value:
o
The value(s) associated with a resource property.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 8 of 52
210
3 Example
211
212
213
The simple example below defines the GenericDiskDrive portType and the resource properties
document associated with GenericDiskDrive. The association of the resource properties
document with the portType defines the type of the WS-Resource.
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
<wsdl:definitions … xmlns:tns="http://example.com/diskDrive" …>
…
<wsdl:types>
<xsd:schema targetNamespace="http://example.com/diskDrive" ... >
<!-- Resource property element declarations -->
<xsd:element name="NumberOfBlocks" type="xsd:integer"/>
<xsd:element name="BlockSize" type="xsd:integer" />
<xsd:element name="Manufacturer" type="xsd:string" />
<!-- Resource properties document declaration -->
<xsd:element name="GenericDiskDriveProperties">
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="tns:NumberOfBlocks"/>
<xsd:element ref="tns:BlockSize" />
<xsd:element ref="tns:Manufacturer" />
<xsd:any minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
…
</xsd:schema>
</wsdl:types>
…
<!-- Association of resource properties document to a portType -->
<wsdl:portType name="GenericDiskDrive"
wsrp:ResourceProperties="tns:GenericDiskDriveProperties" >
<operation name="start" …/>
<operation name="stop" …/>
…
</wsdl:portType>
…
</wsdl:definitions>
The following represents the request message used to retrieve two resource property elements
from the WS-Resource that implements the GenericDiskDrive portType:
…
<wsrp:GetMultipleResourceProperties
xmlns:tns="http://example.com/diskdrive" …>
<wsrp:ResourceProperty>tns:NumberOfBlocks</wsrp:ResourceProperty>
<wsrp:ResourceProperty>tns:BlockSize</wsrp:ResourceProperty>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 9 of 52
256
257
258
259
260
261
262
263
264
265
</wsrp:GetMultipleResourceProperties>
…
The following is a sample response to the simple get request:
…
<wsrp:GetMultipleResourcePropertiesResponse
xmlns:ns1="http://example.com/diskdrive" …>
<ns1:NumberOfBlocks>22</ns1:NumberOfBlocks>
<ns1:BlockSize>1024</ns1:BlockSize>
</wsrp:GetMultipleResourcePropertiesResponse>
…
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 10 of 52
266
4 Declaring Resource Properties
267
4.1 Resource Properties Document
268
269
270
271
272
273
The resource properties document type associated with a Web service’s WSDL 1.1 portType
definition provides the declaration of the exposed resource properties of the WS-Resource. It
represents a particular composed structural view or projection of the resource properties of the
WS-Resource, essentially exposing the stateful resource component within the WS-Resource
composition. This may be used by a service requestor to form an XML-based query or update
expression on the WS-Resource.
274
275
276
277
278
279
280
281
This specification does not dictate the means by which a service implements a resource
properties document. A given service implementation may choose to realize its implementation of
the resource properties document as an actual XML instance document, stored in memory, in the
file system, in a database or in some XML Repository. Other service implementations may
dynamically construct the resource property elements and their values, from data held in
programming language objects (such as a J2EE EJB Entity Bean) or by executing a command on
a private communications channel to a physical resource. Yet another implementation possibility
is a mapping layer to a standard management interface (such as CIM or SNMP).
282
283
284
285
286
287
There is an explicit relationship between the resource properties document and the message
exchanges defined in Section 5. Any Web service that implements an interface that includes a
resource properties document type declaration is a WS-Resource. A WS-Resource MUST accept
message requests declared by the GetResourceProperty message exchange defined in Section
5. Similarly, such a Web service MAY accept message requests declared by the other message
exchanges defined in Section 5.
288
289
290
291
292
293
294
295
296
However, there is no relationship, intended or implied by this specification, between the resource
properties defined in the resource properties document and any other message exchanges that
may be introduced as part of the Web service interface. Any relationships between the resource
properties and messages that comprise an interface are entirely under the purview of the
designer of that interface. For example, using the resource properties document described above
in Section 3, it would be legal for an interface designer to introduce a “getNumberOfBlocks”
message exchange. However, with respect to this specification, there is no relationship either
required or prohibited between such an operation and the properties declared in the resource
properties document.
297
4.2 Resource Properties Document Type
298
A resource properties document MUST be defined using the following rules:
299
300
301
1. The resource properties document MUST be a global element declaration (GED) in some
XML namespace. This GED defines the type of the root element of a resource properties
document and hence the type of the resource properties document itself.
302
2. The resource properties document MUST be uniquely identified by a QName.
303
304
305
306
3. The complexType defining the resource properties document MUST define element
children only; it MUST NOT define attributes. The child elements MUST be aggregated
using xsd:sequence or xsd:all. The order of appearance of the resource properties within
the resource properties document does not matter to WS-ResourceProperties.
307
308
4. The complexType defining the resource properties document MUST define a sequence
of one or more child elements, called resource property elements.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 11 of 52
309
a) Child elements MUST be defined using XML schema element reference (@ref).
310
311
312
b) This specification defines no additional restriction on the use of @minOccurs or
@maxOccurs or other information elements associated with the XML Schema
element definition.
313
314
5. The complexType defining the resource properties document MAY allow open element
content (xsd:any).
315
4.3 Declaring the Resource Properties Document Type in WSDL
316
317
The resource properties document definition is associated with a Web service WSDL 1.1
portType in the following manner:
318
319
320
321
322
<wsdl:defintions …>
<wsdl:portType …
wsrp:ResourceProperties=”xsd:QName”? … >
…
</wsdl:portType>
323
This definition is further constrained as follows:
324
/wsdl:portType/@wsrp:ResourceProperties
325
326
327
328
If this attribute appears on a WSDL 1.1 portType element (using attribute extensibility
available in the WSDL 1.1 XML schema definition for the portType element) its value
MUST be a QName referring to a resource properties document as defined in Section
4.2.
329
330
331
332
Any service that implements a portType annotated with @wsrp:ResourceProperties MUST be a
component of a WS-Resource and MUST provide the interface to resource properties via a
document whose root element is defined by the XML global element declaration associated with
the portType.
333
4.4 Resource Properties and Interface Aggregation
334
335
336
337
338
339
340
341
342
Web service interface designers MAY define a collection of discrete interfaces (portTypes), each
of which defines a set of message exchange patterns (operations). A common design scenario is
one in which the designer combines these discrete interfaces to form a composed, most-derived
interface of a Web service. Examples of independently-specified interfaces designed for purposes
of aggregation into a most-derived interface include WS-Notification [WS-Notification], WSResourceLifetime [WS-ResourceLifetime], and a large number of general-purpose or applicationdomain-specific management interfaces. Further, there may be various dependencies between
these interfaces. That is, the messages defined by interface A may only be useful in a service
implementation when combined with those of interface B.
343
344
345
Within WSDL 1.1, there is no formally-defined interface extension mechanism1. In WSDL 1.1 we
expect service designers to copy-and-paste operations from the various constituent interfaces
into a single, flat, most-derived service interface. In addition, we expect the service interface
1
WSDL 2.0 is expected to define a mechanism to formally model interface
aggregation /interface/@extends [WSDL 2.0].
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 12 of 52
346
347
348
designer to compose a resource property document for the most-derived Web service interface
that consists of all of the resource property element declarations from each of the constituent
interfaces used in the composition.
349
350
Consider the following example, wherein a designer extends the “GenericDiskDrive” WSResource interface in a vendor-specific fashion.
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
<wsdl:definitions …
xmlns:gen="http://example.com/diskDrive"
xmlns:ven="http://vendor.com/diskDrive"
…>
…
<wsdl:types>
<xsd:schema targetNamespace="http://vendor.com/diskDrive" ... >
<!-- Resource property element declarations -->
<xsd:element name="VendorExtension" type="xsd:string" />
<!-- Resource properties document declaration -->
<xsd:element name=“VendorDiskDriveProperties“>
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="gen:NumberOfBlocks"/>
<xsd:element ref="gen:BlockSize" />
<xsd:element ref="gen:Manufacturer" />
<xsd:element ref="ven:VendorExtension" />
<xsd:any minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
…
</xsd:schema>
</wsdl:types>
…
<!-- Association of resource properties document to a portType -->
<wsdl:portType name=”VendorDiskDrive”
wsrp:ResourceProperties=”ven:VendorDiskDriveProperties” >
<operation name=”…
…
<!-- copy/paste operations from genericDiskDrive -->
<operation name="start" …/>
<operation name="stop" …/>
…
<!-- define Vendor-specific operations -->
<operation name="reset" …/>
…
</wsdl:portType>
…
</wsdl:definitions>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 13 of 52
394
395
396
The VendorDiskDrive portType is an example of manual interface aggregation in WSDL 1.1 using
copy-and-paste. In this example, the designer of the VendorDiskDrive portType wishes to extend
the GenericDiskDrive portType.
397
398
WS-ResourceProperties specifies that this style of extension MUST be carried out in the following
fashion:
399
1. Define the new portType.
400
401
In this example the new portType is named “VendorDiskDrive”. This portType extends
“GenericDiskDrive”.
402
403
404
2. Copy all of the operation child elements from the portType being extended, and paste
them as child elements of the new portType; the order of the operations SHOULD be
preserved.
405
406
407
408
409
410
411
In this example, the “start” and “stop” operations are copied from the GenericDiskDrive
portType and pasted as child elements of the VendorDiskDrive portType.
3. Define additional, vendor-specific operations as child elements of the new portType.
In this example, the “reset” operation is a new operation defined by the VendorDiskDrive
portType.
4. Define a new resource properties document, as an XML global element declaration,
following the requirements defined in Section 4.2.
412
413
In this example, the element is named “VendorDiskDriveProperties” and defined in the
“http://vendor.com/diskDrive” namespace.
414
415
416
417
418
5. Copy all of the child elements (@ref and xsd:any) from the resource properties document
of the portType being extended, and paste them as child elements of the new resource
properties document; the order of the elements SHOULD be preserved. This step MUST
be repeated for each portType that is being extended by this new portType. Any duplicate
child elements MUST be removed.
419
420
421
422
In this example, the elements that reference (@ref) “gen:NumberOfBlocks”,
“gen:Blocksize”, and “gen:Manufacturer” and the “xsd:any” are copied from the
GenericDiskDriveProperties declaration and pasted to the VendorDiskDriveProperties
declaration.
423
424
425
426
6. Define any additional resource property elements that are specific to the newly-defined
resource properties document type.
In this example, VendorDiskDriveProperties resource document defines an additional
resource property named VendorExtension.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 14 of 52
427
5 Operations on Resource Properties
428
429
430
This section defines a collection of message exchanges that standardize the means by which a
requestor can retrieve values of resource properties, update values of resource properties, and
issue queries against resource properties.
431
432
433
434
435
Any interface that includes a resource properties document type declaration
(/wsdl:portType/@ResourceProperties) MUST also include the GetResourceProperty message
exchange (operation) defined in this section. Any Web service that implements an interface that
includes a resource properties document type declaration MAY also support the other message
exchanges defined in this section.
436
5.1 GetResourceProperty
437
438
439
440
A Web service that implements a portType that includes the resource properties document type
declaration (/wsdl:portType/@ResourceProperties) is a component of a WS-Resource, and
MUST support the message exchange defined in this section that allows a requestor to retrieve
the value of a single resource property of a WS-Resource.
441
The format of this request message MUST be:
442
443
444
445
446
<wsrp:GetResourceProperty>
QName
</wsrp:GetResourceProperty>
447
448
The GetResourceProperty request message MUST follow the implied resource pattern, as
defined in Section 2.
449
The components of the GetResourceProperty request message are further described as follows:
450
/wsrp:GetResourceProperty/QName
451
452
This MUST correspond to the QName of a resource property element defined as a child
of the root of the WS-Resource’s resource properties document.
453
The response of the GetResourceProperty request message is a message of the following form:
454
455
456
457
458
<wsrp:GetResourcePropertyResponse>
{any}*
</wsrp:GetResourcePropertyResponse>
459
The contents of the GetResourceProperty response message are further described as follows:
460
/wsrp:GetResourcePropertyResponse/{any}
461
462
463
464
465
The resource property value, as an XML element, that corresponds to the QName in the
GetResourceProperty request. Note: in the case where the resource property element is
defined with minOccurs=”0” and the resource properties document does not contain any
value for that resource property, the response MUST be an empty
wsrpw:GetResourcePropertyResponse element.
466
467
468
If the WS-Resource does not respond to the GetResourceProperty request message with the
GetResourcePropertyResponse message, then it MUST send one of the following fault
messages:
469
•
ResourceUnknownFault
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 15 of 52
470
471
472
473
474
o
•
The resource identified in the message (which follows the implied resource pattern) is
not known to the Web service.
InvalidResourcePropertyQName
o
The QName in the request message did not correspond to a resource property
element of the WS-Resource referred to in the request message.
475
OtherFaults: tbd
476
477
Note: All faults generated must be compliant with the WS-BaseFaults [WS-BaseFaults]
specification.
478
5.1.1 Example SOAP Encoding of the GetResourceProperty Message
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
Exchange
Consider the following resource properties document defining resource properties for a WSResource defined by the GenericDiskDrive portType:
<GenericDiskDriveProperties xmlns:tns="http://example.com/diskDrive" >
<tns:NumberOfBlocks>22</tns:NumberOfBlocks>
<tns:BlockSize>1024</tns:BlockSize>
<tns:Manufacturer>DrivesRUs</tns:Manufacturer>
</GenericDiskDriveProperties>
The following is a non-normative example of a GetResourceProperty request message using
SOAP 1.2 [SOAP 1.2]:
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:ex="http://example.com/exampleNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/GetResourceProperty
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.provider.org/ProviderEndpoint
</wsa:To>
<ex:ResourceDisambiguator>
uuid:84decd55-7d3f-65ad-ac44-675d9fce5d22
</ex:ResourceDisambiguator>
</s12:Header>
<s12:Body>
<wsrp:GetResourceProperty
xmlns:tns="http://example.com/diskDrive">
tns:NumberOfBlocks
</wsrp: GetResourceProperty>
</s12:Body>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 16 of 52
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
</s12:Envelope>
The following is an example GetResourcePropertyResponse message using SOAP 1.2 [SOAP
1.2]:
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WSResourceProperties-1.2-draft-01.xsd"
xmlns:resp="http://www.other.org/otherNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/GetResourcePropertyResponse
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.requestor.org/someEndpoint
</wsa:To>
<resp:SomeResourceRef>
uuid:9fef5fec-6dc3-44a2-ba32-8680cace43f9
</resp:SomeResourceRef>
</s12:Header>
<s12:Body>
<wsrp:GetResourcePropertyResponse
xmlns:ns1="http://example.com/diskDrive">
<ns1:NumberOfBlocks>22</ns1:NumberOfBlocks>
</wsrp:GetResourcePropertyResponse>
</s12:Body>
</s12:Envelope>
543
5.2 GetMultipleResourceProperties
544
545
546
547
A Web service that implements a portType that includes the resource properties document type
declaration (/wsdl:portType/@ResourceProperties) is a component of a WS-Resource, and MAY
support the message exchange defined in this section that allows a requestor to retrieve the
values of multiple resource properties of a WS-Resource.
548
The format of this request message MUST be:
549
550
551
<wsrp:GetMultipleResourceProperties>
<wsrp:ResourceProperty>QName <wsrp:ResourceProperty>+
</wsrp:GetMultipleResourceProperties>
552
553
The GetMultipleResourceProperties request message MUST follow the implied resource pattern,
as defined in Section 2.
554
555
The components of the GetMultipleResourceProperties request message are further described as
follows:
556
/wsrp:GetMultipleResourceProperties/wsrp:ResourceProperty+
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 17 of 52
557
558
559
560
561
562
This component MAY appear one or more times. Each ResourceProperty element
contains an xsd:QName which MUST correspond to the QName of a resource property
element defined as a child of the root of the WS-Resource’s resource properties
document.
The response of the GetMultipleResourceProperties request message is a message of the
following form:
563
564
565
<wsrp:GetMultipleResourcePropertiesResponse>
{any}*
</wsrp:GetMultipleResourcePropertiesResponse>
566
567
The contents of the GetMultipleResourcePropertiesResponse message are further described as
follows:
568
/wsrp:GetMultipleResourcePropertiesResponse/{any}
569
570
571
572
573
574
575
576
A collection of resource property values, as XML elements that correspond to the
QNames given in the GetMultipleResourceProperties request message. This collection is
formed in the following fashion. For each QName in the request message, the resource
must add to the collection all child elements of the root of the resource properties
document whose name corresponds to that QName. Note: in the case where the
resource property element is defined with minOccurs=”0” and the resource properties
document does not contain any value for that resource property, no child element is
added to the collection for that QName.
577
578
579
If the XML schema definition of the resource properties document root element does not
permit the root element to contain a child element with that QName the processing of the
GetMultipleResourceProperties request message MUST terminate with a fault message.
580
581
582
The collection of resource property values SHOULD be formed in the same order as the
resource property element QNames were specified in the GetMultipleResourceProperties
request message.
583
584
585
If the WS-Resource does not respond to the GetMultipleResourceProperties request message
with the GetMultipleResourcePropertiesResponse message, then it MUST send one of the
following fault messages:
586
•
587
588
589
590
591
ResourceUnknownFault
o
•
The resource identified in the message (which follows the implied resource pattern) is
not known to the Web service.
InvalidResourcePropertyQName
o
One or more of the QNames in the request message did not correspond to a
resource property element of the WS-Resource referred to in the request message.
592
OtherFaults: tbd
593
594
Note: All faults generated must be compliant with the WS-BaseFaults [WS-BaseFaults]
specification.
595
596
597
598
599
Note: the functionality provided by the GetResourceProperty message exchange is a strict subset
of that provided by GetMultipleResourceProperties. WS-ResourceProperties defines two
message exchange sets to provide implementation flexibility. GetResourceProperty is a simple,
required message exchange that allows simple Web service implementations to be compliant
with WS-ResourceProperties. The optional GetMultipleResourceProperties, while more
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 18 of 52
600
601
sophisticated, allows efficient retrieval of multiple resource property values using a single
message exchange.
602
603
604
An example use of the GetMultipleResourceProperties operation is shown in Section 3. Note: it is
the responsibility of the requestor to correlate the elements of the response message that
correspond to the QNames contained in the request message.
605
5.2.1 Example SOAP Encoding of the GetMultipleResourceProperties
606
607
608
Message Exchange
Consider the following resource properties document defining resource properties for a WSResource defined by the GenericDiskDrive portType:
609
610
611
612
613
<GenericDiskDriveProperties xmlns:tns="http://example.com/diskDrive" >
<tns:NumberOfBlocks>22</tns:NumberOfBlocks>
<tns:BlockSize>1024</tns:BlockSize>
<tns:Manufacturer>DrivesRUs</tns:Manufacturer>
</GenericDiskDriveProperties>
614
615
The following is a non-normative example of a GetMultipleResourceProperties request message
using SOAP 1.2 [SOAP 1.2]:
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WSResourceProperties-1.2-draft-01.xsd"
xmlns:ex="http://example.com/exampleNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/GetMultipleResourceProperties
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.provider.org/ProviderEndpoint
</wsa:To>
<ex:ResourceDisambiguator>
uuid:84decd55-7d3f-65ad-ac44-675d9fce5d22
</ex:ResourceDisambiguator>
</s12:Header>
<s12:Body>
<wsrp:GetMultipleResourceProperties
xmlns:tns="http://example.com/diskdrive">
<wsrp:ResourceProperty>tns:NumberOfBlocks</wsrp:ResourceProperty>
<wsrp:ResourceProperty>tns:BlockSize</wsrp:ResourceProperty>
</wsrp:GetMultipleResourceProperties>
</s12:Body>
</s12:Envelope>
643
644
The following is an example GetMultipleResourcePropertiesResponse message using SOAP 1.2
[SOAP 1.2]:
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 19 of 52
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WSResourceProperties-1.2-draft-01.xsd"
xmlns:resp="http://www.other.org/otherNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/GetMultipleResourcePropertiesResponse
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.requestor.org/someEndpoint
</wsa:To>
<resp:SomeResourceRef>
uuid:9fef5fec-6dc3-44a2-ba32-8680cace43f9
</resp:SomeResourceRef>
</s12:Header>
<s12:Body>
<wsrp:GetMultipleResourcePropertiesResponse
xmlns:ns1="http://example.com/diskdrive" …>
<ns1:NumberOfBlocks>22</ns1:NumberOfBlocks>
<ns1:BlockSize>1024</ns1:BlockSize>
</wsrp:GetMultipleResourcePropertiesResponse>
</s12:Body>
</s12:Envelope>
672
5.3 SetResourceProperties
673
674
675
676
A Web service that implements a portType that includes the resource properties document type
declaration (/wsdl:portType/@ResourceProperties) is a component of a WS-Resource, and MAY
support the message exchange defined in this section that allows a requestor to modify the
values of multiple resource properties of a WS-Resource.
677
678
679
680
The SetResourceProperties message allows the processing of a single request message to make
multiple changes to the resource properties document. There are three types of changes, each
modeled as separate types of component (called SetRequestComponent) of a
SetResourceProperties request message:
681
682
a) Insert: wherein a new resource property element is inserted into the resource properties
document;
683
b) Update: wherein existing resource property element(s) are modified; and
684
c) Delete: wherein existing resource property element(s) are removed.
685
686
687
688
689
The format of this request message MUST be:
<wsrp:SetResourceProperties>
{
<wsrp:Insert >
{any}*
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 20 of 52
690
691
692
693
694
695
696
697
698
</wsrp:Insert> |
<wsrp:Update >
{any}*
</wsrp:Update> |
<wsrp:Delete ResourceProperty=”QName” />
}+
</wsrp:SetResourceProperties>
699
700
The SetResourceProperties request message MUST follow the implied resource pattern, as
defined in Section 2.
701
The contents of the SetResourceProperties request message are further described as follows:
702
/wsrp:SetResourceProperties
703
704
705
706
707
708
709
710
711
This element contains a collection of one or more components called
SetRequestComponents. Each of the SetRequestComponents must be processed
against the WS-Resource’s resource properties document. These
SetRequestComponents MUST appear to be processed in the order in which they are
listed in the request. Each request component MUST be processed to completion in this
conceptual sequence before a subsequent SetRequestComponent is processed. The
result of processing a given SetRequestComponent MUST be observable to the
processing of a subsequent SetRequestComponent, and to subsequent message
exchanges with the same WS-Resources.
712
713
714
715
716
717
718
719
If a service fails to process a SetRequestComponent, it MUST cease processing the
SetResourceProperties request message. The values of the resource properties
associated with this SetRequestComponent MAY reflect partial processing of this
SetRequestComponent. An implementation MAY restore the contents of the resource
properties document to a state as if no processing of the failed SetRequestComponent
had occurred. The implementation MAY additionally choose to restore the resource
properties document as if none of the SetRequestComponents had been processed.
Refer to Section 7 for additional information of resource recovery.
720
721
722
723
724
725
726
727
728
729
730
731
732
733
/wsrp:SetResourceProperties/wsrp:Insert
The intent of this component is to insert the contents of the component into the resource
properties document. The exact placement of the element insertion is implementationdependent. If, as a result of processing the Insert component, the resource properties
document is no longer able to validate, the processing of the component MUST fault. The
implementation may be unable to accept the insertion of an element because it does not
allow the requestor to insert a resource property (or its value) of that given name. In such
circumstances, the resource MUST fault the processing of the component.
/wsrp:SetResourceProperties/wsrp:Insert/{any}
This component identifies the element(s) to be inserted into the resource properties
document. If there are multiple child elements of the Insert component, each MUST have
the same namespace and name (i.e. the same QName). The QName MUST correspond
to the QName of a resource property element associated with the WS-Resource (i.e. an
element that is a valid child element of the root element of the resource properties
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 21 of 52
734
735
736
document). Note, for those resource properties documents that allow open element
content, the set of valid content types can be very large.
/wsrp: SetResourceProperties/wsrp:Update
737
738
739
740
741
742
743
744
745
The intent of this component is to change the value of the resource property by removing
any and all resource property element(s) of the given QName and replacing them with
the contents of this component. If, as a result of processing the Update component, the
resource properties document is no longer able to validate, the processing of the
component MUST fault. The resource may be unable to accept the update of an element
because it does not allow the requestor to update a resource property (or its value) of
that given name. In such circumstances, the resource MUST fault the processing of the
component.
/wsrp: SetResourceProperties/wsrp:Update/{any}
746
747
748
749
750
751
752
753
754
This identifies the element(s) to be inserted into the resource properties document,
replacing all element children of the root of the resource properties document with the
same QName. If there are multiple child elements of the Insert component, each MUST
have the same namespace and name (i.e. the same QName). The QName MUST
correspond to the QName of a resource property element associated with the WSResource (i.e. an element that is a valid child element of the root element of the resource
properties document). Note, for those resource properties documents that allow open
element content, the set of valid content types can be very large.
/wsrp: SetResourceProperties/wsrp:Delete
755
756
757
758
759
760
761
762
763
The intent of this component is to remove all element children of the root of the resource
properties document whose QNames correspond to the value of @ResourceProperty. If
the resource is unable to remove all identified elements, the processing of the component
MUST fault. If, as a result of processing the Delete component, the resource properties
document is no longer able to validate, the processing of the component MUST fail. The
resource may be unable to accept the delete of an element because it does not allow the
requestor to delete a resource property (or its value) of the given name. In such
circumstances, the resource MUST fault the processing of the component.
/wsrp: SetResourceProperties/wsrp:Delete/@ResourceProperty
764
765
This attribute contains the QName of a resource property to be deleted by this
component.
766
767
The response of the SetResourceProperties request message, all of whose components were
successfully processed, MUST be a message of the following form:
768
769
<wsrp:SetResourcePropertiesResponse>
</wsrp:SetResourcePropertiesResponse>
770
771
772
773
If the WS-Resource does not respond to the SetResourceProperties request message with the
SetResourcePropertiesResponse message, then it MUST send one of the following fault
messages. For those faults associated with failure to process a SetResourceProperties request
component, the offending component MUST be identified in the fault message:
774
•
775
776
ResourceUnknownFault
o
•
The resource identified in the message is not known to the Web service.
InvalidSetResourcePropertiesRequestContent:
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 22 of 52
777
778
779
o
•
780
781
782
783
784
785
786
UnableToModifyResourceProperty:
o
•
A resource property identified by one of the SetResourceProperties request
components is read-only.
InvalidResourcePropertyQName:
o
•
The contents of the SetResourceProperties request component causes the resource
properties document to no longer validate.
A resource property QName does not identify a proper number of resource
properties.
SetResourcePropertyRequestFailed
o
One or more components of the SetResourceProperties request failed.
787
OtherFaults: tbd
788
789
Note: All faults generated must be compliant with the WS-BaseFaults [WS-BaseFaults]
specification.
790
791
792
793
The fault message MUST also indicate whether the effects of processing previous components
were restored or not. Note: There is no isolation policy implied, for either modifications to the
resource properties document resulting from the processing of the request or the modifications
implemented by the restore. See Section 7 for more discussion.
794
795
796
797
798
5.3.1 Example SOAP Encoding of the SetResourceProperties
Message Exchange
Consider the following resource properties document defining resource properties for a WSResource defined by the GenericDiskDrive portType:
799
800
801
802
803
<GenericDiskDriveProperties xmlns:tns="http://example.com/diskDrive" >
<tns:NumberOfBlocks>22</tns:NumberOfBlocks>
<tns:BlockSize>1024</tns:BlockSize>
<tns:Manufacturer>DrivesRUs</tns:Manufacturer>
</GenericDiskDriveProperties>
804
805
The following is a non-normative example of a SetResourceProperties request message using
SOAP 1.2 [SOAP 1.2]:
806
807
808
809
810
811
812
813
814
815
816
817
818
819
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WSResourceProperties-1.2-draft-01.xsd"
xmlns:ex="http://example.com/exampleNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/SetResourceProperties
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.provider.org/ProviderEndpoint
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 23 of 52
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
</wsa:To>
<ex:ResourceDisambiguator>
uuid:84decd55-7d3f-65ad-ac44-675d9fce5d22
</ex:ResourceDisambiguator>
</s12:Header>
<s12:Body>
<wsrpw:SetResourceProperties
xmlns:tns="http://example.com/diskdrive">
<wsrp:Update>
<tns:NumberOfBlocks>143</tns:NumberOfBlocks>
</wsrp:Update>
<wsrp:Delete resourceProperty="tns:Manufacturer" />
<wsrp:Insert>
<tns:someElement>42</tns:someElement>
</wsrp:Insert>
</wsrp:SetResourceProperties>
</s12:Body>
</s12:Envelope>
The following is an example SetResourcePropertiesResponse message using SOAP 1.2 [SOAP
1.2]:
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:resp="http://www.other.org/otherNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/SetResourcePropertiesResponse
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.requestor.org/someEndpoint
</wsa:To>
<resp:SomeResourceRef>
uuid:9fef5fec-6dc3-44a2-ba32-8680cace43f9
</resp:SomeResourceRef>
</s12:Header>
<s12:Body>
<wsrp:SetResourcePropertiesResponse>
</wsrp:SetResourcePropertiesResponse>
</s12:Body>
</s12:Envelope>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 24 of 52
867
868
869
870
871
872
873
The new contents of the resource properties document after successful processing of the request
message MUST be:
<GenericDiskDriveProperties xmlns:tns="http://example.com/diskDrive" >
<tns:NumberOfBlocks>143</tns:NumberOfBlocks>
<tns:BlockSize>1024</tns:BlockSize>
<tns:someElement>42</tns:someElement>
</GenericDiskDriveProperties>
874
5.4 QueryResourceProperties
875
876
877
878
879
A Web service that implements a portType that includes the resource properties document type
declaration (/wsdl:portType/@ResourceProperties) is a component of a WS-Resource, and MAY
support the message exchange defined in this section that allows a requestor to query the
resource properties document of a WS-Resource using a query expression such as XPath
[XPath].
880
The format of this request message MUST be:
881
882
883
884
885
<wsrp:QueryResourceProperties>
<wsrp:QueryExpression Dialect=”URI”>
xsd:any
</wsrp:QueryExpression>
</wsrp:QueryResourceProperties>
886
887
The QueryResourceProperties request message MUST follow the implied resource pattern, as
defined in Section 2.
888
889
The components of the QueryResourceProperties request message are further described as
follows:
890
/wsrp:QueryResourceProperties/wsrp:QueryExpression
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
The context of the expression is to be evaluated against the resource properties
document of the WS-Resource identified by the request. The results of evaluating the
QueryExpression are returned in the response to this request message.
/wsrp:QueryResourceProperties/wsrp:QueryExpression/@Dialect
This attribute contains a URI specifying the type of expression contained by the element.
If the implementation does not recognize the URI identified by @Dialect, it MUST fault.
There are two well known dialects identified by this specification, corresponding to two
versions of the XPath language.
http://www.w3.org/TR/1999/REC-xpath-19991116
This URI identifies the XPath 1.0 language. The contents of the
QueryExpression MUST be a string containing a valid XPath 1.0
expression.
http://www.w3.org/TR/2003/WD-xpath20-20031112
This URI identifies the Xpath 2.0 (working draft) language. The contents
of the QueryExpression MUST be a string containing a valid XPath 2.0
expression. Note: an additional URI will be added to represent the W3C
Recommendation form of the XPath 2.0 language.
/wsrp:QueryResourceProperties/QueryExpression/{any}
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 25 of 52
909
910
911
912
The QueryExpression MUST contain an expression in an expression language specified
by the dialect attribute. Note: this element may contain mixed content.
The response of the QueryResourceProperties request message MUST be a message of the
following form:
913
914
915
<wsrp:QueryResourcePropertiesResponse>
{any}
</wsrp:QueryResourcePropertiesResponse>
916
917
The contents of the QueryResourcePropertiesResponse message are further described as
follows:
918
/wsrp:QueryResourcePropertiesResponse/{any}
919
920
921
922
923
924
925
The response of the QueryResourceProperties request is variable, depending on the
nature of the QueryExpression component of the QueryResourceProperties request. The
response MUST contain an XML serialization of the results of evaluating the
QueryExpression against the resource properties document. Note: this element has
mixedContent, to allow for the case where the QueryExpression evaluates to a simple
type (such as a Boolean, a string or an integer) as well as the case where a node-set of
elements is returned.
926
927
928
If the WS-Resource does not respond to the QueryResourceProperties request message with the
QueryResourcePropertiesResponse message, then it MUST send one of the following fault
messages:
929
•
930
931
932
o
•
933
934
ResourceUnknownFault
UnknownQueryExpressionDialect
o
•
935
936
The resource identified in the message (which follows the implied resource pattern) is
not known to the Web service.
The given QueryExpression has a dialect that is unknown to the Web service.
InvalidQueryExpression
o
The given Query Expression is not valid within the QueryExpression language
identified by the dialect attribute.
937
•
938
939
o The Query Expression failed during evaluation.
OtherFaults: tbd
940
941
Note: All faults generated must be compliant with the WS-BaseFaults [WS-BaseFaults]
specification.
942
5.4.1 Example SOAP Encoding of the QueryResourceProperties
943
944
945
946
947
948
949
950
QueryEvaluationError
Message Exchange
Consider the following resource properties document defining resource properties for a WSResource defined by the GenericDiskDrive portType:
<GenericDiskDriveProperties xmlns:tns="http://example.com/diskDrive" >
<tns:NumberOfBlocks>22</tns:NumberOfBlocks>
<tns:BlockSize>1024</tns:BlockSize>
<tns:Manufacturer>DrivesRUs</tns:Manufacturer>
</GenericDiskDriveProperties>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 26 of 52
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
The following is a non-normative example of a QueryResourceProperties request message using
SOAP 1.2 [SOAP 1.2]:
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:ex="http://example.com/exampleNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/QueryResourceProperties
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.provider.org/ProviderEndpoint
</wsa:To>
<ex:ResourceDisambiguator>
uuid:84decd55-7d3f-65ad-ac44-675d9fce5d22
</ex:ResourceDisambiguator>
</s12:Header>
<s12:Body>
<wsrp:QueryResourceProperties>
<wsrp:QueryExpression
Dialect=”http://www.w3.org/TR/1999/REC-xpath-19991116” >
boolean(/*/NumberOfBlocks > 20 and /*/BlockSize=1024)
</wsrp:QueryExpression>
</wsrp:QueryResourceProperties>
</s12:Body>
</s12:Envelope>
The following is an example QueryResourcePropertiesResponse message using SOAP 1.2
[SOAP 1.2], containing the results of evaluating that XPath expression against the root element of
the resource’s resource properties document:
<s12:Envelope
xmlns:s12="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:resp="http://www.other.org/otherNS">
<s12:Header>
<wsa:Action>
http://docs.oasis-open.org/wsrf/2004/06/WSResourceProperties/QueryResourcePropertiesResponse
</wsa:Action>
<wsa:To s12:mustUnderstand="1">
http://www.requestor.org/someEndpoint
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 27 of 52
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
</wsa:To>
<resp:SomeResourceRef>
uuid:9fef5fec-6dc3-44a2-ba32-8680cace43f9
</resp:SomeResourceRef>
</s12:Header>
<s12:Body>
<wsrp:QueryResourcePropertiesResponse>
true
</wsrp:QueryResourcePropertiesResponse>
</s12:Body>
</s12:Envelope>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 28 of 52
1009
6 Subscription
1010
1011
1012
1013
1014
The WS-Notification [WS-Notification] family of specifications describes the patterns, concepts,
standard message exchanges, and protocols of a topic-based, publish-subscribe messaging
pattern in Web services. In the notification model, a service creates messages that are delivered
to other services that had previously registered interest in the situation associated with that
message.
1015
1016
1017
1018
1019
1020
1021
1022
1023
With WS-ResourceProperties, it is a common pattern for Web service requestors to request
notification of changes (inserts, updates and deletions) made to the values of one or more
resource property elements of a given WS-Resource. It is the Web service component of the WSResource that is responsible for executing or observing the messages. This suggests the need
for encapsulation of the stateful resource to ensure all changes made to the stateful resource are
observed by the WS-Resource implementation. To the extent that encapsulation is not provided,
and updates to the stateful resource are made outside of the knowledge of the associated WSResource implementation, the WS-Resource may not be able to provide notifications reflecting
those updates.
1024
1025
1026
1027
1028
1029
If a WS-Resource supports the resource property value-change notification pattern, and if it uses
WS-Notification to implement this feature, then it MUST implement the message exchanges for
the NotificationProducer role, as specified in [WS-BaseNotification]. The WS-Resource MAY
accept subscriptions to only a subset of the resource properties defined for a WS-Resource. If an
implementation does not use WS-Notification, then it MAY ignore the requirements outlined in this
section.
1030
1031
1032
1033
One notification message artifact is created for each change to each resource property observed
by the WS-Resource implementation. For example, a SetResourceProperties request message
may contain five SetRequestComponents. Each of these components would result in the creation
of a separate message artifact.
1034
1035
1036
1037
1038
1039
1040
WS-ResourceProperties defines the Notification Topic and TopicSpace elements [WS-Topics]
that MUST be used to express the organization of the WS-Resource property element value
change notifications. By understanding the relationship between Topics and resource properties,
and examining the set of Topics supported by the NotificationProducer Web service, the service
requestor can determine which of the resource properties are able to participate in the valuechange notification pattern. The Topic and TopicSpace elements associated with resource
property value-change notification are described as follows:
1041
1042
1043
1044
1045
1. The WS-Resource’s resource properties document MAY be defined using resource
properties declared in multiple XML namespaces. For each of these XML namespaces,
an associated TopicSpace element MUST be defined. The TopicSpace element defines
a topic space intended to contain topics related to value changes of resource properties
declared in that XML namespace.
1046
1047
1048
1049
1050
1051
1052
1053
o
The value of the TopicSpace element’s targetNamespace attribute MUST be the
same as the URI of the namespace in which the resource property element is
defined. The name attribute of the TopicSpace element SHOULD have the value
“ResourcePropertiesTopicSpace”.
2. For each resource property participating in the value-change notification pattern, a Topic
element MUST be defined as a child of the TopicSpace element defined in 1.
o
Notification messages reflecting changes to the resource property are associated
with this Topic.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 29 of 52
1054
1055
o
The value of the Topic element’s name attribute MUST be the same as the
NCName of the resource property element.
1056
1057
1058
o
The value of the Topic element’s messageTypes attribute MUST include
wsrp:ResourcePropertyValueChangeNotification (defined later in this section). In
addition, it MAY include QNames of other message elements.
1059
1060
o
A designer MAY introduce additional child sub-topic elements to the topic
element that represent application-specific needs.
1061
1062
1063
1064
3. The WS-Resource acting as the NotificationProducer MUST include Topics defined in 2,
as part of the value of its “Topics” resource property element. One such Topic MUST be
included for each resource property element offered as a target for a value-change
subscription.
1065
1066
1067
1068
1069
1070
1071
1072
1073
4. When a WS-Resource observes a resource property value change, it SHOULD create a
notification message that expresses the situation, and associate the notification message
with the Topic associated with that resource property. Note: there are many
circumstances in which a change to a resource property might not result in the generation
of a notification message. For example, a resource property value may change
frequently, making generation of notification messages too expensive for the service. In
this situation, a WS-Resource may choose to never generate notification message
artifacts to record value change, or it may choose to generate notification message
artifacts for a subset of the value change situations.
1074
1075
1076
1077
1078
1079
1080
The wsrp:ResourcePropertyValueChangeNotification element MUST appear as a component of
the notification message associated with resource property value change topics. This element is
defined as follows:
<wsrp:ResourcePropertyValueChangeNotification>
<wsrp:OldValue> xsd:any </wsrp:OldValue>?
<wsrp:NewValue> xsd:any </wsrp:NewValue>
</wsrp:ResourcePropertyValueChangeNotification>
1081
1082
1083
1084
This element may appear as the root element of the notification message, or it may appear as a
descendent of the root, accommodating patterns where the notification message itself is
contained in an enveloping mechanism. The form of the
ResourcePropertyValueChangeNotification is further constrained as follows:
1085
/wsrp:ResourcePropertyValueChangeNotification
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
One ResourcePropertyValueChangeNotification element is created for each resource
property value change situation detected and acted upon by the WS-Resource. This
component records the value change of the affected resource property.
/wsrp:ResourcePropertyValueChangeNotification/OldValue
This element, if it appears, MUST contain the value of the affected WS-Resource
property immediately prior to when the value change was applied. If the resource
property did not have a value prior to the value change (for example, this notification
represents an insertion of a new resource property element) then this element is empty
and will contain the attribute xsi:nil with value “true”. If this value does not appear in the
message, then the WS-Resource was unable or unwilling to record the value prior to the
value change.
/wsrp:ResourcePropertyValueChangeNotification/NewValue
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 30 of 52
1098
1099
1100
1101
1102
This element MUST contain the value of the affected WS-Resource property after the
value change condition was detected. If the WS-Resource property does not have a
value after the value change (for example, this notification represents a deletion of the
resource property element) then this element is empty and will contain the attribute xsi:nil
with value “true”.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 31 of 52
1104
7 ACID Properties of Operations on WSResources
1105
1106
1107
1108
1109
1110
1111
The ability to associate a transactional recovery policy to the execution of a Web service
message exchange is described in the Web Services Atomic Transaction specification [WSAtomicTransaction]. In the presence of a transactional unit of work, a Web service capable of
participating in the transactional protocol must abide by the rules of two-phase-commit
transaction management. However, in the absence of a transaction management policy, the Web
service is under no obligation to recover the state of the WS-Resource in the event of a failure
during message processing.
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
This specification is not prescriptive with respect to policy that governs concurrent read or write
access to a WS-Resource. The definition of specific policy governing concurrent updates,
whether or not separate message executions targeting the same WS-Resource may be
interleaved, and whether partially completed WS-Resource updates within a given message
execution may be observed by other concurrent requests is beyond the scope of this definition.
The scope and extent of the isolation of changes made to the WS-Resource is an implementation
dependent responsibility of the WS-Resource itself. The WS-Resource must also take on the
responsibility for the scope and extent to which notifications of changes to the WS-Resource are
isolated and made observable. If WS-Resource update isolation is needed, we suggest the use of
a transaction [WS-AtomicTransaction] to provide a context within which isolation of WS-Resource
updates can be provided. In the absence of a transactional unit of work, the level of WSResource update atomicity, recovery, isolation, and durability provided is implementationdependent.
1125
1126
1127
1128
1129
The ability to declare and attach isolation-level policy to the definition of a Web service message
exchange, whether or not a transactional unit of work is present, represents a general
requirement not met by the current Web service architecture. In the future, isolation-level policy
declarations may be introduced as a formal part of the WS-Resource definition. Refer to [State
Paper] for a general discussion of these requirements.
1103
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 32 of 52
1130
8 Security Considerations
1131
1132
1133
1134
This specification defines the resource properties document and also the set of message
exchanges that MUST be supported by a WS-Resource. In this context, there are two categories
of security aspects that need to be considered: (a) securing the message exchanges and (b)
securing the resource properties.
1135
8.1 Securing the message exchanges
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
When messages are exchanged between a requestor and a WS-Resource in order to access or
act on one or more resource properties, it is RECOMMENDED that the communication between
services be secured using the mechanisms described in WS-Security. In order to properly secure
messages, the message body and all relevant headers need to be included in the digital
signature so as to prove the integrity of the message. In addition the ReferenceProperties from an
EndpointReference, used as part of any message exchange, may be encrypted to ensure their
privacy. In the event that a requestor communicates frequently with a Web service to access
resource properties, either directly through a query or accomplished through notification of state
change, it is RECOMMENDED that a security context be established using the mechanisms
described in WS-Trust [WS-Trust] and WS-SecureConversation [WS-SecureConversation],
allowing for potentially more efficient means of authentication.
1147
1148
1149
1150
It is common for communication between requestors and the WS-Resource to exchange multiple
messages. As a result, the usage profile may be susceptible to key attacks. For this reason it is
RECOMMENDED that the keys used to secure the channel be changed frequently. This "rekeying" can be effected a number of ways. The following list outlines four common techniques:
1151
1152
•
Attaching a nonce to each message and using it in a derived key function with the shared
secret
1153
•
Using a derived key sequence and switch "generations"
1154
•
Closing and re-establishing a security context
1155
•
Exchanging new secrets between the parties
1156
1157
1158
It should be noted that the mechanisms listed above are independent of the security context
token (SCT). That is, the keys used to secure the channel during message exchanges may be
independent of the key used to prove the right to access WS-ResourceProperties.
1159
1160
1161
1162
1163
The security context MAY be re-established using the mechanisms described in WS-Trust and
WS-SecureConversation. Similarly, secrets can be exchanged using the mechanisms described
in WS-Trust. Note, however, that the current shared secret SHOULD NOT be used to encrypt the
new shared secret. Derived keys, the preferred solution from this list, can be specified using the
mechanisms described in WS-SecureConversation.
1164
1165
The following list summarizes common classes of attacks that apply to this protocol and identifies
the mechanism to prevent/mitigate the attacks:
1166
1167
•
Message alteration – Alteration is prevented by including signatures of the message
information using WS-Security.
1168
1169
•
Message disclosure – Confidentiality is preserved by encrypting sensitive data using WSSecurity.
1170
1171
1172
•
Key integrity – Key integrity is maintained by using the strongest algorithms possible (by
comparing secured policies – see WS-Policy [WS-Policy] and WS-SecurityPolicy [WSSecurityPolicy]).
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 33 of 52
1173
1174
1175
•
Authentication – Authentication is established using the mechanisms described in WSSecurity and WS-Trust. Each message is authenticated using the mechanisms described in
WS-Security.
1176
1177
1178
•
Accountability – Accountability is a function of the type of and string of the key and
algorithms being used. In many cases, a strong symmetric key provides sufficient
accountability. However, in some environments, strong PKI signatures are required.
1179
1180
1181
1182
1183
•
Availability – Many services are subject to a variety of availability attacks. Replay is a
common attack and it is RECOMMENDED that this be addressed as described in the Replay
bullet item below. Other attacks, such as network-level denial of service attacks, are harder to
avoid and are outside the scope of this specification. That said, care should be taken to
ensure that minimal processing be performed prior to any authenticating sequences.
1184
1185
1186
1187
•
Replay – Messages may be replayed for a variety of reasons. To detect and eliminate this
attack, mechanisms should be used to identify replayed messages such as the
timestamp/nonce outlined in WS-Security and the sequences outlined in WSReliableMessaging [WS-ReliableMessaging].
1188
8.2 Securing Resource Properties
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
Since WS-ResourceProperties defines a mechanism to expose properties of a WS-Resource,
security policies should be established that ensure that only authorized requestors can access
the value of a resource property. In order to secure access to the resource properties, the
message exchanges that provide the access should be appropriately controlled. Authorization
policies should be put in place so that the implications of providing the state information (through
GetResourceProperty, GetMultipleResourceProperties, or QueryResourceProperties messages
or through notification of value change and modification of the resource properties), are taken into
account. These policies should also take into account the semantic difference between
components of the SetResourceProperties message – i.e. that an Update component updates a
value of a resource property, whereas Insert and Delete components modify whether the WSResource actually contains the resource property values.
1200
1201
1202
1203
1204
The authorization policies may also reflect the sensitivity of the resource property(ies) that are
accessible from a WS-Resource. Policies can be set at the coarse granularity of the message
exchange (e.g., Get(Multiple)ResourceProperty(ies) vs SetResourceProperty), but finer-grained
control at the level of individual resource properties may be desired in some scenarios (e.g. user
Bob can access value of “Manufacturer” but not “NumberOfBlocks”).
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
Given that a requestor will be able to access a resource property value by subscribing to state
changes, care should be taken to set up security policies so that a consistent policy is in effect
irrespective of whether the resource property value is accessed through direct message
exchanges (e.g., GetResourceProperty) or indirectly through subscription for state changes (i.e.,
subscription to “ResourceChangePropertyValueNotification” topic). It should also be noted that a
requestor will be able to query the value of a property through the QueryResourceProperty
operation, or by using a domain-specific operation corresponding to a resource property (e.g.,
getNumberOfBlocks) if one exists. Therefore, the authorization policy on QueryResourceProperty
operation (and the getXXX operation, if one is declared on the Web service for resource property
named XXX) should be set so that a requestor who is not authorized to get a value of a resource
property through a GetResourceProperty request is not able to deduce the value indirectly
through the QueryResourceProperty request (or the getXXX operation on the Web service).
1217
1218
Even if the requestor is authorized to access the requested resource properties, it is
RECOMMENDED that the resource properties that are exchanged between a requestor and a
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 34 of 52
1219
1220
1221
1222
Web service are secured to ensure integrity and/or confidentiality of the resource property values.
This will prevent unauthorized alteration of and/or access to the property values while in transit.
This would mean that the specific resource property elements are signed and/or encrypted within
the message by leveraging WS-Security as discussed in the previous section.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 35 of 52
1223
9 References
1224
9.1 Normative
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
[RFC2119]
[SOAP 1.2]
[URI]
[State Paper]
[WS-Addressing]
[WS-BaseNotification]
[WS-Policy]
[WS-ResourceLifetime]
[WS-Topics]
[XML-Infoset]
[XPATH]
S. Bradner, Key words for use in RFCs to Indicate Requirement
Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March
1997.
http://www.w3.org/TR/soap12-part1/
T. Berners-Lee, R. Fielding, L. Masinter, "Uniform Resource
Identifiers (URI): Generic Syntax," RFC 2396, MIT/LCS, U.C.
Irvine, Xerox Corporation, August 1998.
http://www.oasisopen.org/apps/org/workgroup/wsrf/download.php/6795/wsmodelingresources.pdf
http://www.ibm.com/developerworks/webservices/library/ws-add/
http://docs.oasis-open.org/wsn/2004/06/wsn-WSBaseNotification-1.2-draft-03.pdf
http://www.ibm.com/developerworks/library/ws-policy
http://docs.oasis-open.org/wsrf/2004/06/wsrf-WSResourceLifetime-1.2-draft-03.pdf
http://docs.oasis-open.org/wsn/2004/06/wsn-WS-Topics-1.2draft-01.pdf
http://www.w3.org/TR/xml-infoset/
http://www.w3.org/TR/xpath
9.2 Non-Normative
[OGSI 1.0]
Open Grid Services Infrastructure (OGSI) V1.0
http://forge.gridforum.org/projects/ggf-editor/document/draft-ogsiservice-1/en/1
[WS-AtomicTransaction] http://www.ibm.com/developerworks/webservices/library/wsatomtran/
[WS-Notification]
http://www.oasisopen.org/apps/org/workgroup/wsn/download.php/6661/WSNpub
sub-1-0.pdf
[WS-ReliableMessaging] http://www.ibm.com/developerworks/webservices/library/ws-rm/
[WS-SecureConversation] http://www.ibm.com/developerworks/library/ws-secon/
[WS-Security]
http://www.oasisopen.org/committees/download.php/5531/oasis-200401-wsssoap-message-security-1.0.pdf
[WS-SecurityPolicy]
http://www.ibm.com/developerworks/library/ws-secpol/
[WS-Trust]
http://www.ibm.com/developerworks/library/ws-trust/
[WSDL 2.0]
http://www.w3.org/TR/wsdl12/
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 36 of 52
1262
Appendix A. Acknowledgments
1263
1264
1265
Special thanks to the Global Grid Forum’s Open Grid Services Infrastructure working group,
which defined the OGSI v1.0 [OGSI] specification which was a large inspiration for the ideas
expressed in this specification.
1266
1267
The following individuals were members of the committee during the development of this
specification:
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
Akhil Arora (Sun Microsystems), Tim Banks (IBM), Jeff Bohren (OpenNetwork), Conor Cahill
(AOL), Fred Carter (AmberPoint), Martin Chapman (Oracle), Glen Daniels (Sonic Software),
Thomas Freund (IBM), Stephen Graham (IBM), Anish Karmarkar (Oracle), Hideharu Kato
(Hitachi), David Levine (IBM), Paul Lipton (Computer Associates), Mark Little (Arjuna
Technologies Limited), Lily Liu (WebMethods, Inc.), Tom Maguire (IBM), Susan Malaika (IBM),
David Martin (IBM), Samuel Meder (ArgonneNational Laboratory), Jeff Mischkinsky (Oracle),
Bryan Murray (Hewlett-Packard), Dave Orchard (BEA Systems, Inc.), Savas Parastatidis
(Individual), Greg Pavlik (Oracle), Mark Peel (Novell), Alain Regnier (Ricoh Company, Ltd.), Ian
Robinson (IBM), Junaid Saiyed (Sun Microsystems), Igor Sedukhin (Computer Associates),
Hitoshi Sekine (Ricoh Company, Ltd.), Frank Siebenlist (ArgonneNational Laboratory), David
Snelling (Fujitsu), Latha Srinivasan (Hewlett-Packard), John Tollefsrud (Sun Microsystems), Jem
Treadwell (Hewlett-Packard), Steve Tuecke (ArgonneNational Laboratory), William Vambenepe
(Hewlett-Packard), Katy Warr (IBM), Alan Weissberger (NEC Corporation), and Pete Wenzel
(SeeBeyond Technology Corporation)
1283
1284
In addition, the following people made contributions to this specification:
1285
1286
1287
1288
1289
Nick Butler (IBM), Karl Czajkowski (Globus / USC/ISI), Andrew Eisenberg (IBM), Donald F
Ferguson (IBM), Ian Foster (Globus / Argonne), Jeffrey Frey (IBM), Diane Jordan (IBM), Frank
Leymann (IBM), Andreas Meier (IBM), Nataraj Nagaratnam (IBM), Martin Nally (IBM), John
Rofrano (IBM), Ellen Stokes (IBM), Tony Storey (IBM), Jay Unger (IBM), Sanjiva Weerawarana
(IBM).
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 37 of 52
1290
Appendix B. XML Schema
1291
The XML types and elements used in this specification are defined in the following XML Schema:
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
<?xml version="1.0" encoding="UTF-8"?>
<!-OASIS takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to pertain
to the implementation or use of the technology described in this
document or the extent to which any license under such rights might or
might not be available; neither does it represent that it has made any
effort to identify any such rights. Information on OASIS's procedures
with respect to rights in OASIS specifications can be found at the
OASIS website. Copies of claims of rights made available for
publication and any assurances of licenses to be made available, or the
result of an attempt made to obtain a general license or permission for
the use of such proprietary rights by implementors or users of this
specification, can be obtained from the OASIS Executive Director.
OASIS invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary rights
which may cover technology that may be required to implement this
specification. Please address the information to the OASIS Executive
Director.
Copyright (C) OASIS Open (2004). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing the
copyright notice or references to OASIS, except as needed for the
purpose of developing OASIS specifications, in which case the
procedures for copyrights defined in the OASIS Intellectual Property
Rights document must be followed, or as required to translate it into
languages other than English.
The limited permissions granted above are perpetual and will not be
revoked by OASIS or its successors or assigns.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 38 of 52
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
This document and the information contained herein is provided on an
"AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
-->
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
elementFormDefault="qualified" attributeFormDefault="unqualified"
targetNamespace=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
>
<!-- ======= Global Attribute Declaration for WSDL 1.1 portType==== -->
<xsd:attribute name="ResourceProperties" type="xsd:QName" />
<!-- = Notification Message for ResourceProperties value change === -->
<xsd:complexType name="ResourcePropertyValueChangeNotificationType">
<xsd:sequence>
<xsd:element name="OldValue" nillable="true"
minOccurs="0" maxOccurs="1" >
<xsd:complexType>
<xsd:sequence>
<xsd:any minOccurs="1" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="NewValue" nillable="true"
minOccurs="1" maxOccurs="1" >
<xsd:complexType>
<xsd:sequence>
<xsd:any minOccurs="1" maxOccurs="1" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="ResourcePropertyValueChangeNotification"
type="wsrp:ResourcePropertyValueChangeNotificationType" />
<xsd:complexType name="QueryExpressionType" mixed="true">
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 39 of 52
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
<xsd:sequence>
<xsd:any minOccurs="0" maxOccurs="1" processContents="lax" />
</xsd:sequence>
<xsd:attribute name="Dialect" type="xsd:anyURI" />
</xsd:complexType>
<xsd:element name="QueryExpression" type="wsrp:QueryExpressionType"
/>
</xsd:schema>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 40 of 52
1390
Appendix C. WSDL 1.1
1391
1392
The following illustrates the WSDL 1.1 for the Web service methods described in this
specification:
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
<?xml version="1.0" encoding="utf-8"?>
<!-OASIS takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to pertain
to the implementation or use of the technology described in this
document or the extent to which any license under such rights might or
might not be available; neither does it represent that it has made any
effort to identify any such rights. Information on OASIS's procedures
with respect to rights in OASIS specifications can be found at the
OASIS website. Copies of claims of rights made available for
publication and any assurances of licenses to be made available, or the
result of an attempt made to obtain a general license or permission for
the use of such proprietary rights by implementors or users of this
specification, can be obtained from the OASIS Executive Director.
OASIS invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary rights
which may cover technology that may be required to implement this
specification. Please address the information to the OASIS Executive
Director.
Copyright (C) OASIS Open (2004). All Rights Reserved.
This document and translations of it may be copied and furnished to
others, and derivative works that comment on or otherwise explain it or
assist in its implementation may be prepared, copied, published and
distributed, in whole or in part, without restriction of any kind,
provided that the above copyright notice and this paragraph are
included on all such copies and derivative works. However, this
document itself may not be modified in any way, such as by removing the
copyright notice or references to OASIS, except as needed for the
purpose of developing OASIS specifications, in which case the
procedures for copyrights defined in the OASIS Intellectual Property
Rights document must be followed, or as required to translate it into
languages other than English.
The limited permissions granted above are perpetual and will not be
revoked by OASIS or its successors or assigns.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 41 of 52
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
This document and the information contained herein is provided on an
"AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
-->
<wsdl:definitions name="WS-ResourceProperties"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:wsbf=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2draft-01.xsd"
xmlns:wsrp=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
xmlns:wsrpw=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.wsdl"
targetNamespace=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.wsdl"
>
<!-- ===================== Types Definitions ====================== -->
<wsdl:types>
<xsd:schema
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
targetNamespace=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
elementFormDefault="qualified"
attributeFormDefault="unqualified">
<xsd:include schemaLocation=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties1.2-draft-01.xsd"
/>
<xsd:import
namespace=
"http://schemas.xmlsoap.org/ws/2003/03/addressing"
schemaLocation=
"http://schemas.xmlsoap.org/ws/2003/03/addressing"
/>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 42 of 52
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
<xsd:import
namespace=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2draft-01.xsd"
schemaLocation=
"http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-BaseFaults-1.2draft-01.xsd"
/>
<!-- ========== Message Types for GetResourceProperty
============ -->
<xsd:element name="GetResourceProperty"
type="xsd:QName" />
<xsd:element name="GetResourcePropertyResponse" >
<xsd:complexType>
<xsd:sequence>
<xsd:any minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="ResourceUnknownFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="ResourceUnknownFault"
type="wsrp:ResourceUnknownFaultType"/>
<xsd:complexType name="InvalidResourcePropertyQNameFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="InvalidResourcePropertyQNameFault"
type="wsrp:InvalidResourcePropertyQNameFaultType"/>
<!-- ====== Message Types for GetMultipleResourceProperties ======= -->
<xsd:element name="GetMultipleResourceProperties">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="ResourceProperty" type="xsd:QName"
minOccurs="1" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 43 of 52
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
</xsd:element>
<xsd:element name="GetMultipleResourcePropertiesResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:any minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<!-- ========= Message Types for SetResourceProperties =========== -->
<xsd:complexType name="InsertType">
<xsd:sequence>
<xsd:any processContents="lax"
minOccurs="1" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Insert"
type="wsrp:InsertType"/>
<xsd:complexType name="UpdateType">
<xsd:sequence>
<xsd:any processContents="lax"
minOccurs="1" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Update"
type="wsrp:UpdateType"/>
<xsd:complexType name="DeleteType">
<xsd:attribute name="ResourceProperty"
type="xsd:QName" use="required" />
</xsd:complexType>
<xsd:element name="Delete"
type="wsrp:DeleteType"/>
<xsd:element name="SetResourceProperties">
<xsd:complexType>
<xsd:choice minOccurs="0" maxOccurs="unbounded">
<xsd:element ref="wsrp:Insert"/>
<xsd:element ref="wsrp:Update"/>
<xsd:element ref="wsrp:Delete"/>
</xsd:choice>
</xsd:complexType>
</xsd:element>
<xsd:element name="SetResourcePropertiesResponse" >
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 44 of 52
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
<xsd:complexType />
</xsd:element>
<xsd:complexType
name="InvalidSetResourcePropertiesRequestContentFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element
name="InvalidSetResourcePropertiesRequestContentFault"
type="wsrp:InvalidSetResourcePropertiesRequestContentFaultType"/>
<xsd:complexType name="UnableToModifyResourcePropertyFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="UnableToModifyResourcePropertyFault"
type="wsrp:UnableToModifyResourcePropertyFaultType"/>
<xsd:complexType
name="SetResourcePropertyRequestFailedFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="SetResourcePropertyRequestFailedFault"
type="wsrp:SetResourcePropertyRequestFailedFaultType"/>
<!-- ========= Message Types for QueryResourceProperties ========== -->
<xsd:element name="QueryResourceProperties" >
<xsd:complexType>
<xsd:sequence>
<xsd:element ref="wsrp:QueryExpression"
minOccurs="1" maxOccurs="1"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="QueryResourcePropertiesResponse" >
<xsd:complexType>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 45 of 52
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
<xsd:complexContent mixed="true">
<xsd:restriction base="xsd:anyType">
<xsd:sequence>
<xsd:any processContents="lax"
minOccurs="1" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:restriction>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:complexType name="UnknownQueryExpressionDialectFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="UnknownQueryExpressionDialectFault"
type="wsrp:UnknownQueryExpressionDialectFaultType"/>
<xsd:complexType name="InvalidQueryExpressionFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="InvalidQueryExpressionFault"
type="wsrp:InvalidQueryExpressionFaultType"/>
<xsd:complexType name="QueryEvaluationErrorFaultType">
<xsd:complexContent>
<xsd:extension base="wsbf:BaseFaultType"/>
</xsd:complexContent>
</xsd:complexType>
<xsd:element name="QueryEvaluationErrorFault"
type="wsrp:QueryEvaluationErrorFaultType"/>
</xsd:schema>
</wsdl:types>
<!-- ===================== GetResourceProperty ====================
GetResourceProperty(QName)
returns: any
-->
<wsdl:message name="GetResourcePropertyRequest">
<wsdl:part name="GetResourcePropertyRequest"
element="wsrp:GetResourceProperty" />
</wsdl:message>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 46 of 52
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
<wsdl:message name="GetResourcePropertyResponse">
<wsdl:part name="GetResourcePropertyResponse"
element="wsrp:GetResourcePropertyResponse" />
</wsdl:message>
<wsdl:message name="ResourceUnknownFault">
<part name="ResourceUnknownFault"
element="wsrp:ResourceUnknownFault" />
</wsdl:message>
<wsdl:message name="InvalidResourcePropertyQNameFault">
<part name="InvalidResourcePropertyQNameFault"
element="wsrp:InvalidResourcePropertyQNameFault" />
</wsdl:message>
<!-- ==============GetMultipleResourceProperties ==================
GetMultipleResourceProperties(list of QName)
returns: sequence of any
-->
<wsdl:message name="GetMultipleResourcePropertiesRequest">
<wsdl:part name="GetMultipleResourcePropertiesRequest"
element="wsrp:GetMultipleResourceProperties" />
</wsdl:message>
<wsdl:message name="GetMultipleResourcePropertiesResponse">
<wsdl:part name="GetMultipleResourcePropertiesResponse"
element="wsrp:GetMultipleResourcePropertiesResponse" />
</wsdl:message>
<!-- ================= SetResourceProperties ======================
SetResourceProperties(
{ insert (any)* |
update (any)* |
delete@QName } +
)
returns: empty
-->
<wsdl:message name="SetResourcePropertiesRequest">
<wsdl:part name="SetResourcePropertiesRequest"
element="wsrp:SetResourceProperties" />
</wsdl:message>
<wsdl:message name="SetResourcePropertiesResponse">
<wsdl:part name="SetResourcePropertiesResponse"
element="wsrp:SetResourcePropertiesResponse" />
</wsdl:message>
<wsdl:message name="InvalidSetResourcePropertiesRequestContentFault">
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 47 of 52
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
<part name="InvalidSetResourcePropertiesRequestContentFault"
element="wsrp:InvalidSetResourcePropertiesRequestContentFault" />
</wsdl:message>
<wsdl:message name="UnableToModifyResourcePropertyFault">
<part name="UnableToModifyResourcePropertyFault"
element="wsrp:UnableToModifyResourcePropertyFault" />
</wsdl:message>
<wsdl:message name="SetResourcePropertyRequestFailedFault">
<part name="SetResourcePropertyRequestFailedFault"
element="wsrp:SetResourcePropertyRequestFailedFault" />
</wsdl:message>
<!-- ================ QueryResourceProperties =====================
QueryResourceProperties(QueryExpression)
returns: any
-->
<wsdl:message name="QueryResourcePropertiesRequest">
<wsdl:part name="QueryResourcePropertiesRequest"
element="wsrp:QueryResourceProperties" />
</wsdl:message>
<wsdl:message name="QueryResourcePropertiesResponse">
<wsdl:part name="QueryResourcePropertiesResponse"
element="wsrp:QueryResourcePropertiesResponse" />
</wsdl:message>
<wsdl:message name="UnknownQueryExpressionDialectFault">
<part name="UnknownQueryExpressionDialectFault"
element="wsrp:UnknownQueryExpressionDialectFault" />
</wsdl:message>
<wsdl:message name="InvalidQueryExpressionFault">
<part name="InvalidQueryExpressionFault"
element="wsrp:InvalidQueryExpressionFault" />
</wsdl:message>
<wsdl:message name="QueryEvaluationErrorFault">
<part name="QueryEvaluationErrorFault"
element="wsrp:QueryEvaluationErrorFault" />
</wsdl:message>
<!-- =================== PortType Definitions ===================== -->
<wsdl:portType name="GetResourceProperty">
<wsdl:operation name="GetResourceProperty">
<wsdl:input name="GetResourcePropertyRequest"
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 48 of 52
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
message="wsrpw:GetResourcePropertyRequest" />
<wsdl:output name="GetResourcePropertyResponse"
message="wsrpw:GetResourcePropertyResponse" />
<wsdl:fault name="ResourceUnknownFault"
message="wsrpw:ResourceUnknownFault" />
<wsdl:fault name="InvalidResourcePropertyQNameFault"
message="wsrpw:InvalidResourcePropertyQNameFault" />
</wsdl:operation>
</wsdl:portType>
<wsdl:portType name="GetMultipleResourceProperties">
<wsdl:operation name="GetMultipleResourceProperties">
<wsdl:input name="GetMultipleResourcePropertiesRequest"
message="wsrpw:GetMultipleResourcePropertiesRequest"
/>
<wsdl:output name="GetMultipleResourcePropertiesResponse"
message="wsrpw:GetMultipleResourcePropertiesResponse" />
<wsdl:fault name="ResourceUnknownFault"
message="wsrpw:ResourceUnknownFault" />
<wsdl:fault name="InvalidResourcePropertyQNameFault"
message="wsrpw:InvalidResourcePropertyQNameFault" />
</wsdl:operation>
</wsdl:portType>
<wsdl:portType name="SetResourceProperties">
<wsdl:operation name="SetResourceProperties">
<wsdl:input name="SetResourcePropertiesRequest"
message="wsrpw:SetResourcePropertiesRequest" />
<wsdl:output name="SetResourcePropertiesResponse"
message="wsrpw:SetResourcePropertiesResponse" />
<wsdl:fault name="ResourceUnknownFault"
message="wsrpw:ResourceUnknownFault" />
<wsdl:fault
name="InvalidSetResourcePropertiesRequestContentFault"
message="wsrpw:InvalidSetResourcePropertiesRequestContentFault" />
<wsdl:fault name="UnableToModifyResourcePropertyFault"
message="wsrpw:UnableToModifyResourcePropertyFault"
/>
<wsdl:fault name="InvalidResourcePropertyQNameFault"
message="wsrpw:InvalidResourcePropertyQNameFault" />
<wsdl:fault name="SetResourcePropertyRequestFailedFault"
message="wsrpw:SetResourcePropertyRequestFailedFault" />
</wsdl:operation>
</wsdl:portType>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 49 of 52
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
<wsdl:portType name="QueryResourceProperties">
<wsdl:operation name="QueryResourceProperties">
<wsdl:input name="QueryResourcePropertiesRequest"
message="wsrpw:QueryResourcePropertiesRequest" />
<wsdl:output name="QueryResourcePropertiesResponse"
message="wsrpw:QueryResourcePropertiesResponse" />
<wsdl:fault name="ResourceUnknownFault"
message="wsrpw:ResourceUnknownFault" />
<wsdl:fault name="InvalidResourcePropertyQNameFault"
message="wsrpw:InvalidResourcePropertyQNameFault" />
<wsdl:fault name="UnknownQueryExpressionDialectFault"
message="wsrpw:UnknownQueryExpressionDialectFault"
/>
<wsdl:fault name="InvalidQueryExpressionFault"
message="wsrpw:InvalidQueryExpressionFault" />
<wsdl:fault name="QueryEvaluationErrorFault"
message="wsrpw:QueryEvaluationErrorFault" />
</wsdl:operation>
</wsdl:portType>
</wsdl:definitions>
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 50 of 52
1839
Appendix D. Revision History
Rev
Date
By Whom
What
wd-01
2004-05-18
Steve Graham
Initial version created from submission
by contributing companies. Minor
modifications made to reflect OASIS
formatting and the following issues:
WSRF2, WSRF3, WSRF14, WSRF33.
wd-02
2004-05-31
Steve Graham, Jem
Treadwell
Mods to draft 01, including hyphenation,
clarification of acknowledgements
section
wd-03
2004-06-04
Steve Graham
Reformat rogue Veranda text with Arial.
wd-04
2004-06-07
Steve Graham
Base faults comment on faults (align
with ResourceLifetime), update date
URis to 2004/06, update URLs in
references to point to .pdfs, update
Acknowledgements
1840
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 51 of 52
1841
Appendix E. Notices
1842
1843
1844
1845
1846
1847
1848
1849
1850
OASIS takes no position regarding the validity or scope of any intellectual property or other rights
that might be claimed to pertain to the implementation or use of the technology described in this
document or the extent to which any license under such rights might or might not be available;
neither does it represent that it has made any effort to identify any such rights. Information on
OASIS's procedures with respect to rights in OASIS specifications can be found at the OASIS
website. Copies of claims of rights made available for publication and any assurances of licenses
to be made available, or the result of an attempt made to obtain a general license or permission
for the use of such proprietary rights by implementors or users of this specification, can be
obtained from the OASIS Executive Director.
1851
1852
1853
1854
OASIS invites any interested party to bring to its attention any copyrights, patents or patent
applications, or other proprietary rights which may cover technology that may be required to
implement this specification. Please address the information to the OASIS Executive Director.
1855
1856
Copyright (C) OASIS Open (2004). All Rights Reserved.
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
This document and translations of it may be copied and furnished to others, and derivative works
that comment on or otherwise explain it or assist in its implementation may be prepared, copied,
published and distributed, in whole or in part, without restriction of any kind, provided that the
above copyright notice and this paragraph are included on all such copies and derivative works.
However, this document itself may not be modified in any way, such as by removing the copyright
notice or references to OASIS, except as needed for the purpose of developing OASIS
specifications, in which case the procedures for copyrights defined in the OASIS Intellectual
Property Rights document must be followed, or as required to translate it into languages other
than English.
1867
1868
1869
The limited permissions granted above are perpetual and will not be revoked by OASIS or its
successors or assigns.
1870
1871
1872
1873
1874
1875
This document and the information contained herein is provided on an "AS IS" basis and OASIS
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE
ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
PARTICULAR PURPOSE.
wsrf-WS-ResourceProperties-1.2-draft-04.doc
Copyright © OASIS Open 2004. All Rights Reserved.
6/10/2004
Page 52 of 52