Latest
version:
http://www.w3.org/TR/ws-enumeration
Previous version:
http://www.w3.org/TR/2009/WD-ws-enumeration-20090317
Editors:
Doug Davis, IBM
Ashok Malhotra,
Oracle
Katy Warr,
IBM
Wu Chou, Avaya
Copyright © 2009 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability,
trademark
and document
use rules apply.
This specification describes a general SOAP-based protocol for enumerating
a sequence of XML elements that is suitable for traversing logs, message
queues, or other linear information models.
This document is an editors' copy that has no official standing.
1 Introduction
1.1 Requirements
2 Notations and Terminology
2.1 Notational Conventions
2.2 Considerations on the Use of
Extensibility Points
2.3 XML Namespaces
2.4 Terminology
2.5 Compliance
3 Enumeration Messages
3.1 Enumerate
3.2 Pull
3.3 Renew
3.4 GetStatus
3.5 Release
3.6 EnumerationEnd
4 Faults
4.1 InvalidExpirationTime
4.2 UnsupportedExpirationTime
4.3 FilteringNotSupported
4.4 FilterDialectRequestedUnavailable
4.5 CannotProcessFilter
4.6 InvalidEnumerationContext
4.7 TimedOut
4.8 UnableToRenew
4.9 UnusableEPR
5 Security Considerations
6 Acknowledgements
7 References
A XML Schema
B WSDL
C Change Log
There are numerous applications for which a simple
single-request/single-reply metaphor is insufficient for transferring large
data sets over SOAP. Applications that do not fit into this simple paradigm
include streaming, traversal, query, and enumeration.
This specification defines a simple SOAP-based protocol for enumeration
that allows the data source to provide a session abstraction, called an
enumeration context, to a consumer that represents a logical cursor through a
sequence of data items. The consumer can then request XML element information
items using this enumeration context over the span of one or more SOAP
messages.
Somewhere, state must MUST be maintained
regarding the progress of the iteration. This state may MAY be
maintained between requests by the data source being enumerated or by the data
consumer. WS-Enumeration allows the data source to decide, on a
request-by-request basis, which party will be responsible for maintaining this
state for the next request.
In its simplest form, WS-Enumeration defines a single operation, Pull,
which allows a data source, in the context of a specific enumeration, to
produce a sequence of XML elements in the body of a SOAP message. Each
subsequent Pull operation returns the next N elements in the aggregate
sequence.
A data source may MAY provide a custom
mechanism for starting a new enumeration. For instance, a data source that
provides access to a SQL database may can support a SELECT
operation that performs a database query and uses an explicit database cursor
to iterate through the returned rows. In general, however, it is simpler if all
data sources support a single, standard operation to start an enumeration. This
specification defines such an operation, Enumerate, that data sources may MAY implement
for starting a new enumeration of a data source. The Enumerate operation is
used to create new enumeration contexts for subsequent traversal/retrieval. Each
Enumerate operation results in a distinct enumeration context, each with its
own logical cursor/position.
Note It should be
emphasized that different enumerations of the same data source may can produce
different results; this may can happen even for
two enumeration contexts created concurrently by a single consumer using
identical Enumerate requests. In general, the consumer of an enumeration should SHOULD NOTnot
make any assumptions about the ordering or completeness of the enumeration; the
returned data items represent a selection by the data source of items it wishes
to present to that consumer at that time in that order, with no guarantee that
every available item is returned or that the order in which items is returned
has any semantic meaning whatsoever (of course, any specific data source may can provide
strong guarantees, if so desired). In particular, note it should be
noted that the very act of enumerating the contents of a data
source may
can modify the contents of the data
source; for instance, a queue might be represented as a data source such that
items that are returned in a Pull response are removed from the queue.
This
specification intends to meet the following requirements:
·
Support
enumeration of data sources that cannot practically fit into a single SOAP
message.
·
Support
both server-side and client-side enumeration state maintenance.
·
Minimize
additional mechanism beyond the current web service architecture.
This section specifies the notations, namespaces, and terminology used in
this specification.
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 [RFC2119].
This specification uses the
following syntax to define normative outlines for messages:
·
The
syntax appears as an XML instance, but values in italics indicate data types
instead of values.
·
Characters
are appended to elements and attributes to indicate cardinality:
·
"?"
(0 or 1)
·
"*"
(0 or more)
·
"+"
(1 or more)
·
The
character "|" is used to indicate a choice between alternatives.
·
The
characters "(" and ")" are used to indicate that contained
items are to be treated as a group with respect to cardinality or choice.
·
The
characters "[" and "]" are used to call out references and
property names.
·
Ellipsis (i.e. "...") indicate points of extensibility.
·
XML
namespace prefixes (see Table 2-1) are used to
indicate the namespace of the element being defined.
In addition to Message
Information Header properties [WS-Addressing], this
specification uses the following properties to define messages:
[Headers]
Unordered
message headers.
[Action]
The
value to be used for the wsa:Action
URI.
[Body]
A message body.
These properties bind to a SOAP
Envelope as follows:
<s:Envelope>
<s:Header>
[Headers]
<wsa:Action>[Action]</wsa:Action>
...
</s:Header>
<s:Body>[Body]</s:Body>
</s:Envelope>
The elements defined in this specification MAY be extended at the points
indicated by their outlines and schema. Implementations MAY add child elements
and/or attributes at the indicated extension points but MUST NOT contradict the
semantics of the parent and/or owner, respectively. If a receiver does not
recognize an extension, the receiver SHOULD ignore that extension. Senders MAY
indicate the presence of an extension that has to be understood through the use
of a corresponding SOAP Header with a soap:mustUnderstand
attribute with the value "1".
Extension elements and attributes MUST NOT use the Web Services Enumeration
namespace URI.
The XML namespace URI that MUST be used by implementations of this
specification is:
Table
2-1 lists XML namespaces that are used in this specification. The choice of
any namespace prefix is arbitrary and not semantically significant.
|
Table 2-1: Prefixes and XML namespaces used in this
specification |
||
|
Prefix |
XML Namespace |
Specification(s) |
|
wsen
|
This
specification |
|
|
s |
SOAP
1.2 [SOAP12] |
|
|
s11
|
SOAP
1.1 [SOAP11] |
|
|
wsa |
WS-Addressing
[WS-Addressing] |
|
|
wsam |
WS-Addressing
[WS-Addressing] |
|
|
xs
|
XML
Schema [XMLSchema - Part 1],
[XMLSchema - Part 2] |
|
|
wsdl |
WSDL/1.1
[WSDL11] |
|
The working group intends to
update the value of the Web Services Enumeration namespace URI each time a new
version of this document is published until such time that the document reaches
Candidate Recommendation status. Once it has reached Candidate Recommendation
status, the working group intends to maintain the value of the Web Services
Enumeration namespace URI that was assigned in the Candidate Recommendation
unless significant changes are made that impact the implementation or break
post-CR implementations of the specification. Also see http://www.w3.org/2001/tag/doc/namespaceState.html
and http://www.w3.org/2005/07/13-nsuri
.
Consumer
The Web service that is requesting the data
enumeration from the data source
Data
source
A Web service that supports traversal using
enumeration contexts via the Enumerate operation defined in this specification
Enumeration
context
A session context that represents a specific
traversal through a logical sequence of XML element information items using the
Pull operation defined in this specification
An implementation is not compliant with this specification if it fails to
satisfy one or more of the MUST or REQUIRED level requirements defined herein.
A SOAP Node MUST NOT use the XML namespace identifier for this specification
(listed in 2.3 XML Namespaces) within SOAP Envelopes unless
it is compliant with this specification.
Normative text within this
specification takes precedence over the XML Schema and WSDL descriptions, which
in turn take precedence over outlines, which in turn take precedence over
examples.
All messages defined by this
specification MUST be sent to a Web service that is addressable by an EPR (see [WS-Addressing]).
Enumeration contexts represent a specific traversal through a sequence of
XML information items. An Enumerate operation may MAY be
used to establish an enumeration context from a data source. A Pull operation
is used to fetch information items from a data source according to a specific
enumeration context. A Release operation is used to tell a data source that the
consumer is abandoning an enumeration context before it has completed the
enumeration.
Enumeration contexts are represented as XML data that is opaque to the
consumer. Initially, the consumer gets an enumeration context from the data
source by means of an Enumerate operation. The consumer then passes that XML
data back to the data source in the Pull request. Optionally, the data source may MAY return
an updated enumeration context in the Pull response; when present, this new
enumeration context should SHOULD replace the
old one on the consumer, and should SHOULD be passed to
the data source in all future responses until and unless the data source again
returns an updated enumeration context.
Consumers should SHOULD NOTnot
reuse old enumeration contexts that have been replaced by the data source.
Using a replaced enumeration context in a Pull response MAY yield undefined
results, including being ignored or generating a fault.
Once the last element in a sequence has been returned, or the enumeration
context has expired, the enumeration context is considered invalid and the
result of subsequent operations referencing that context is undefined.
Callers MAY issue a Release operation against a valid enumeration context
at any time, which causes the enumeration context to become invalid and allows
the data source to free up any resources it may might have
allocated to the enumeration. Issuing a Release operation prior to reaching the
end of the sequence of elements is explicitly allowed; however, no further
operations should
SHOULD be issued after a Release.
In addition, the data source MAY invalidate an enumeration context at any
time, as necessary.
All data sources MUST support some operation that allows an enumeration to
be started. A data source MAY support the Enumerate operation, or it may MAY provide
some other mechanism for starting an enumeration and receiving an enumeration
context.
The Enumerate operation is initiated by sending an Enumerate request
message to the data source. The Enumerate request message MUST be of the
following form:
[Action]
http://www.w3.org/2009/02/ws-enu/Enumerate
[Body]
<wsen:Enumerate ...>
<wsen:EndTo>endpoint-reference</wsen:EndTo> ?
<wsen:Expires>(xs:dateTime | xs:duration)</wsen:Expires> ?
<wsen:Filter Dialect="xs:anyURI"?> xs:any
</wsen:Filter> ?
xs:any*
</wsen:Enumerate>
The following describes additional, normative constraints on the outline
listed above:
[Body]/wsen:Enumerate/wsen:EndTo
This optional element denotes where to send an EnumerationEnd message if the enumeration is terminated
unexpectedly (see 3.6 EnumerationEnd).
If present, this element MUST be of type wsa:EndpointReferenceType. Default is to not send this
message. The endpoint to which the EndTo EPR refers
MUST support the EnumerationEndPortType portType.
[Body]/wsen:Enumerate/wsen:Expires
Requested expiration time for the enumeration. (No implied value.) The data source defines the
actual expiration and is not constrained to use a time less
or greater than the requested expiration. The expiration time may MAY be
a specific time or a duration from the enumeration's creation time. Both
specific times and durations are interpreted based on the data source's clock.
If this
element does not appear, then the request is for an enumeration that will not
expire. That is, the consumer is requesting the data source to create an enumeration
with an indefinite lifetime. If the data source grants such an enumeration, it
will terminate when the end of the enumeration is reached, or if the consumer
sends a Release request, or by the data source at any time for reasons such as
connection termination, resource constraints, or system shut-down.
If the
expiration time is either a zero duration or a specific time that occurs in the
past according to the data source, then the request MUST fail, and the data
source MUST generate a wsen:InvalidExpirationTime
fault indicating that an invalid expiration time was requested.
Some
data sources may might not have a
"wall time" clock available, and so are able only to accept durations
as expirations. If such a source receives an Enumerate request containing a specific
time expiration, then the request MUST fail; if so, the data source SHOULD
generate a wsen:UnsupportedExpirationTime
fault indicating that an unsupported expiration type was requested.
[Body]/wsen:Enumerate/wsen:Filter
This
optional element contains a Boolean predicate in some dialect (see [[Body]/wsen:Enumerate/wsen:Filter/@Dialect ])
that all elements of interest must MUST satisfy. The
resultant enumeration context MUST NOT return elements for which this predicate
expression evaluates to the value false. If this element is absent, then the
implied value is the expression true(), indicating
that no filtering is desired.
If the
data source does not support filtering, the request MUST fail, and the data
source MUST generate a wsen:FilteringNotSupported
fault.
If the
data source supports filtering but cannot honor the requested filter dialect,
the request MUST fail, and the data source MUST generate a wsen:FilterDialectRequestUnavailable fault.
If the
data source supports filtering and the requested dialect but cannot process the
requested filter content, the request MUST fail, and the data source MUST
generate a wsen:CannotProcessFilter
fault.
[Body]/wsen:Enumerate/wsen:Filter/@Dialect
Implied value is
"http://www.w3.org/TR/1999/REC-xpath-19991116".
[Body]/wsen:Enumerate/wsen:Filter/@Dialect="http://www.w3.org/TR/1999/REC-xpath-19991116"
Value of [Body]/wsenu:Enumerate/wsen:Filter is
an XPath [XPath1.0] predicate
expression (PredicateExpr); the context of the
expression is:
·
Context
Node: any XML element that could be returned as a direct child of the wsen:Items element.
·
Context
Position: 1.
·
Context
Size: 1.
·
Variable
Bindings: None.
·
Function
Libraries: Core Function Library [XPath1.0].
·
Namespace
Declarations: The [in-scope namespaces] property [XML Infoset] of [Body]/wsen:Enumerate/wsen:Filter.
Other components of the outline
above are not further constrained by this specification.
If included within the Enumerate
request message, the wsen:EndTo
SHOULD have some cursory validity checking performed before the Enumerate
response is returned. While not all errors can be detected prior to sending a
message to that EPR, some obvious ones can be detected. For example, an
unsupported transport specified within the wsa:Address IRI. Detecting these errors during Enumerate
processing will lessen the chances of the consumer creating an unusable
enumeration. If this check is performed and a problem is detected then the
event source MUST generate a wsen:UnusableEPR
fault rather than returning the EnumerateResponse. message.
Upon successful processing of an
Enumerate request message, a data source is expected to create an enumeration
context and return that context in an Enumerate response message, which MUST
adhere to the following form:
[Action]
http://www.w3.org/2009/02/ws-enu/EnumerateResponse
[Body]
<wsen:EnumerateResponse ...>
<wsen:Expires>(xs:dateTime
| xs:duration)</wsen:Expires> ?
<wsen:EnumerationContext>...</wsen:EnumerationContext>
xs:any*
</wsen:EnumerateResponse>
The following describes
additional, normative constraints on the outline listed above:
[Body]/wsen:EnumerateResponse/wsen:Expires
The expiration time assigned by the data source. The expiration time MAY be either an
absolute time or a duration but SHOULD be of the same type as the requested
expiration (if any).
If this
element does not appear, then the enumeration will not expire. That is, the
enumeration has an indefinite lifetime. It will terminate when the end of the
enumeration is reached, or if the consumer sends a Release request, or by the
data source at any time for reasons such as connection termination, resource
constraints, or system shut-down.
[body]/wsen:EnumerateResponse/wsen:EnumerationContext
The
required EnumerationContext element contains the XML
representation of the new enumeration context. The consumer is required to pass
this XML data in Pull requests for this enumeration context, until and unless a
PullResponse message updates the enumeration context.
Example 3-1
lists a sample Enumerate request.
(01)
<s:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
(02) xmlns:wsa="http://www.w3.org/2005/08/addressing"
(03) xmlns:wsen="http://www.w3.org/2009/02/ws-enu">
(04) <s:Header>
(05) <wsa:Action>
(06) http://www.w3.org/2009/02/ws-enu/Enumerate
(07) </wsa:Action>
(08) <wsa:MessageID>
(09) uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:MessageID>
(11) <wsa:To>http://www.example.com/relayAgent/enum19</wsa:To>
(12) <wsa:ReplyTo>
(13) <wsa:Address>
(14)
http://www.w3.org/2005/08/addressing/anonymous
(15) </wsa:Address>
(16) </wsa:ReplyTo>
(17) </s:Header>
(18) <s:Body>
(19) <wsen:Enumerate>
(20) <wsen:Expires> PT10M </wsen:Expires>
(21) </wsen:Enumerate>
(22) </s:Body>
(23)
</s:Envelope>
Lines (05-07) in Example 3-1 indicate this message is an Enumerate request
and that the data source is expected to respond with an Enumerate response
message. The wsen:Expires element on line (20)
indicates that the consumer would like an enumeration context that will be good
for at least 10 minutes; that is, it expects to complete its enumeration within
a 10 minute period. No wsen:Filter
element is present, so the resultant enumeration context is expected to return
all available elements.
Example 3-2
lists a response to the request in Example 3-1.
Example
3-2: Response to Enumerate request
(01)
<s:Envelope xmlns:S='http://www.w3.org/2003/05/soap-envelope'
(02) xmlns:wsen='http://www.w3.org/2009/02/ws-enu'
(03) xmlns:wsa='http://www.w3.org/2005/08/addressing'>
(04) <s:Header>
(05) <wsa:Action>
(06)
http://www.w3.org/2009/02/ws-enu/EnumerateResponse
(07) </wsa:Action>
(08) <wsa:RelatesTo>
(09)
uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:RelatesTo>
(11) <wsa:To>
(12)
http://www.w3.org/2005/08/addressing/anonymous
(13) <wsa:To>
(14) </s:Header>
(15) <s:Body>
(16) <wsen:EnumerateResponse>
(17) <wsen:Expires> PT15M </wsen:Expires>
(18) <wsen:EnumerationContext>
(19)
123
(20) </wsen:EnumerationContext>
(21) </wsen:EnumerateResponse>
(22) </s:Body>
(23)
</s:Envelope>
Lines (05-07) in Example 3-2 indicate this message is an Enumerate response
message. Line (17) indicates that the data source has actually created an
enumeration context with a lifetime of 15 minutes. Lines (18-20) are the XML
representation of the enumeration context that supports the Pull operation
defined below.
The
Pull operation is initiated by sending a Pull request message to the data
source. The Pull request message MUST be of the following form:
[Action]
http://www.w3.org/2009/02/ws-enu/Pull
[Body]
<wsen:Pull ...>
<wsen:EnumerationContext>...</wsen:EnumerationContext>
<wsen:MaxTime>xs:duration</wsen:MaxTime> ?
<wsen:MaxElements>xs:long</wsen:MaxElements> ?
<wsen:MaxCharacters>xs:long</wsen:MaxCharacters> ?
xs:any*
</wsen:Pull>
The
following describes additional, normative constraints on the outline listed
above:
[Body]/wsen:Pull/wsen:EnumerationContext
This required element contains the XML data that
represents the current enumeration context.
The data source MUST fail the request and MUST
generate the wsen:InvalidEnumerationContext
fault if the data source is able to determine that the enumeration context is
invalid for any reason including:
1.
Context
replaced in the response to another Pull request
2.
Context
completed (i.e. an EndOfSequence has been returned in
a Pull response)
3.
Context
released
4.
Context
expired
Note that the data source may might not
be able to determine that an enumeration context is not valid, especially if
all of the state associated with the enumeration is kept in the enumeration
context and refreshed on every PullResponse.
[Body]/wsen:Pull/wsen:MaxTime
This optional element (of type xs:duration) indicates the maximum amount of time the
initiator is willing to allow the data source to assemble the Pull response.
When this element is absent, the data source is not required to limit the
amount of time it takes to assemble the Pull response.
This is useful with data sources that accumulate
elements over time and package them into a single Pull response.
[Body]/wsen:Pull/wsen:MaxElements
This optional element (of type xs:long) indicates the number of items (child elements
of wsen:Items in the Pull response) the consumer is
willing to accept. When this element is absent, its implied value is 1.
Implementations MUST NOT return more than this number of elements in the Pull
response message. Implementations MAY return fewer than this number based on
either the wsen:MaxTime
timeout, the wsen:MaxCharacters size limit, or
implementation-specific constraints.
[Body]/wsen:Pull/wsen:MaxCharacters
This optional element (of type xs:long) indicates the maximum size of the returned
elements, in Unicode characters, that the initiator is willing to accept. When
this element is absent, the data source is not required to limit the number of
characters in the Pull response. Implementations MUST NOT return a Pull
response message whose wsen:Items
element is larger than MaxCharacters. Implementations
MAY return a smaller message based on the wsen:MaxTime timeout, the wsen:MaxElements
limit, or implementation-specific constraints.
Even if a Pull request contains a MaxCharacters element, the consumer MUST be prepared to
receive a Pull response that contains more data characters than specified, as
XML canonicalization or alternate XML serialization algorithms may can change
the size of the representation.
It may can happen that the
next item the data source would return to the consumer is larger than MaxCharacters. In this case, the data source MAY skip the
item, or MAY return an abbreviated representation of the item that fits inside MaxCharacters. If the data source skips the item, it MAY
return it as part of the response to a future Pull request with a larger value
of MaxCharacters, or it MAY omit it entirely from the
enumeration. If the oversize item is the last item to be returned for this
enumeration context and the data source skips it, it MUST include the wsen:EndOfSequence item in the
Pull response and invalidate the enumeration context; that is, it may MAY not
return zero items but not consider the enumeration completed. See the
discussion of wsen:EndOfSequence
below.
Other
components of the outline above are not further constrained by this
specification.
Upon
receipt of a Pull request message, the data source may MAY wait
as long as it deems necessary (but not longer than the value of the wsen:MaxTime element, if present)
to produce a message for delivery to the consumer. The data source MUST
recognize the wsen:MaxTime
element and return a wsen:TimedOut fault if no
elements are available prior to the request message's deadline:
Note,
however, that this fault SHOULD NOT cause the enumeration context to become
invalid (of course, the data source may MAY invalidate the
enumeration context for other reasons). That is, the requestor should can be able to issue
additional Pull requests using this enumeration context after receiving this
fault.
Upon
successful processing of a Pull request message, a data source is expected to
return a Pull response message, which MUST adhere to the following form:
[Action]
http://www.w3.org/2009/02/ws-enu/PullResponse
[Body]
<wsen:PullResponse ...>
<wsen:EnumerationContext>...</wsen:EnumerationContext>
?
<wsen:Items> ?
<xs:any> enumeration-specific
element </xs:any> +
</wsen:Items>
<wsen:EndOfSequence/> ?
xs:any*
</wsen:PullResponse>
The
following describes additional, normative constraints on the outline listed
above:
[Body]/wsen:PullResponse/wsen:EnumerationContext
The optional EnumerationContext
element, if present, contains a new XML representation of the current
enumeration context. The consumer is required to replace the prior
representation with the contents of this element.
[Body]/wsen:PullResponse/wsen:Items/xs:any
The optional Items element contains one or more
enumeration-specific elements, one for each element being returned.
[Body]/wsen:PullResponse/wsen:EndOfSequence
This optional element indicates that no more
elements are available from this enumeration. Additionally, once this element
is returned in a Pull response message, subsequent Pull requests using that
enumeration context MUST generate a wsen:InvalidEnumerationContext
fault message, if the data source is able to determine that the enumeration
context is no longer valid.
Note
that at least one of wsen:Items
or wsen:EndOfSequence MUST appear. It is possible for
both to appear if items are returned and the sequence is exhausted. Similarly, wsen:EnumerationContext and wsen:EndOfSequence MUST NOT both appear; neither may can appear,
or one without the other, but not both in the same PullResponse.
Example 3-3
lists a Pull request.
(01)
<s:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
(02) xmlns:wsa="http://www.w3.org/2005/08/addressing"
(03) xmlns:wsen="http://www.w3.org/2009/02/ws-enu">
(04) <s:Header>
(05) <wsa:Action>
(06)
http://www.w3.org/2009/02/ws-enu/Pull
(07) </wsa:Action>
(08) <wsa:MessageID>
(09) uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:MessageID>
(11) <wsa:To>http://www.example.com/relayAgent</wsa:To>
(12) <wsa:ReplyTo>
(13) <wsa:Address>
(14)
http://www.w3.org/2005/08/addressing/anonymous
(15) </wsa:Address>
(16) </wsa:ReplyTo>
(17) </s:Header>
(18) <s:Body>
(19) <wsen:Pull>
(20) <wsen:EnumerationContext>123</wsen:EnumerationContext>
(21) <wsen:MaxTime>P30S</wsen:MaxTime>
(22) <wsen:MaxElements>10</wsen:MaxElements>
(23) </wsen:Pull>
(24) </s:Body>
(25)
</s:Envelope>
Lines (05-07) in Example 3-3 indicate this message is a Pull request and
that the data source is expected to respond with a Pull response message. Line
(21) indicates that the response message should SHOULD be
generated no more than 30 seconds after receipt of the Pull request message.
Line (22) indicates that no more than 10 elements should can be
returned in the body of the Pull response message.
Example 3-4
lists a response to the request in Example 3-3.
Example
3-4: Response to Pull request
(01)
<s:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
(02) xmlns:wsen="http://www.w3.org/2009/02/ws-enu"
(03) xmlns:wsa="http://www.w3.org/2005/08/addressing">
(04) <s:Header>
(05) <wsa:Action>
(06)
http://www.w3.org/2009/02/ws-enu/PullResponse
(07) </wsa:Action>
(08) <wsa:RelatesTo>
(09) uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:RelatesTo>
(11) <wsa:To>
(12)
http://www.w3.org/2005/08/addressing/anonymous
(13) <wsa:To>
(14) </s:Header>
(15) <s:Body>
(16) <wsen:PullResponse>
(17) <wsen:Items xmlns:xx="http://fabrikam123.example.com/schema/log">
(18)
<xx:LogEntry
id="1">System booted</xx:LogEntry>
(19)
<xx:LogEntry
id="2">AppX started</xx:LogEntry>
(20)
<xx:LogEntry
id="3">John Smith logged on</xx:LogEntry>
(21)
<xx:LogEntry
id="4">AppY started</xx:LogEntry>
(22)
<xx:LogEntry
id="5">AppX crashed</xx:LogEntry>
(23) </wsen:Items>
(24) <wsen:EndOfSequence/>
(25) </wsen:PullResponse>
(26) </s:Body>
(27)
</s:Envelope>
Lines (05-07) in Example 3-4 indicate this message is a Pull response
message. Lines (18-22) are the five elements returned by this Pull request. The
presence of a wsen:EndOfSequence
element (line (24)) indicates that no more elements are available and that the
enumeration context is now invalid.
The consumer SHOULD NOT issue
additional Pull request messages after a Pull response containing a wsen:EndOfSequence element has
been returned. Similarly, upon receipt of a Pull response containing a wsen:EndOfSequence element, the
consumer SHOULD NOT issue a Release operation to signal that the enumeration
context is no longer needed.
If the consumer does issue a Pull
or Release on an invalid enumeration context, the result is undefined: the data
source MAY ignore the request or MAY return a wsen:InvalidEnumerationContext fault or MAY take some
other action.
Data sources MUST support requests to renew enumerations.
To renew an enumeration, the consumer sends a request of the following form
to the data source:
[Action]
http://www.w3.org/2009/02/ws-enu/Renew
[Body]
<wsen:Renew ...>
<wsen:EnumerationContext>...</wsen:EnumerationContext>
<wsen:Expires>(xs:dateTime | xs:duration)</wsen:Expires> ?
xs:any*
</wsen:Renew>
Components of the outline listed above are additionally constrained as for
a request to create an enumeration (see 3.1 Enumerate)
with the following addition(s):
[Body]/wsen:Renew/wsen:EnumerationContext
This
required element contains the XML data that represents the current enumeration
context.
If the
enumeration context is not valid, either because it has been replaced in the
response to another Pull request, or because it has completed (EndOfSequence has been returned in a Pull response), or
because it has been Released, or because it has expired, or because the data
source has had to invalidate the context, then the data source SHOULD fail the
request, and if so, MUST generate a wsen:InvalidEnumerationContext
fault.
Other components of the outline
above are not further constrained by this specification.
If the data source accepts a
request to renew an enumeration, it MUST reply with a response of the following
form:
[Action]
http://www.w3.org/2009/02/ws-enu/RenewResponse
[Body]
<wsen:RenewResponse ...>
<wsen:Expires>(xs:dateTime
| xs:duration)</wsen:Expires> ?
<wsen:EnumerationContext>...</wsen:EnumerationContext> ?
xs:any*
</wsen:RenewResponse>
Components of the outline listed
above are constrained as for a response to an Enumerate request (see 3.1 Enumerate) with the following addition:
[Body]/wsen:RenewResponse/wsen:Expires
If the
requested expiration is a duration, then the implied
start of that duration is the time when the data source starts processing the
Renew request.
[Body]/wsen:RenewResponse/wsen:EnumerationContext
This
element is optional in this response.
If the data source chooses not to
renew this enumeration, the request MUST fail, and the data source SHOULD
generate a wsen:UnableToRenew
fault indicating that the renewal was not accepted.
Other components of the outline
above are not further constrained by this specification.
To get the status of an enumeration, the subscriber sends a request of the
following form to the data source:
[Action]
http://www.w3.org/2009/02/ws-enu/GetStatus
[Body]
<wsen:GetStatus ...>
<wsen:EnumerationContext>...</wsen:EnumerationContext>
?
xs:any*
</wsen:GetStatus>
Components of the outline listed above are additionally constrained as for
a request to renew an enumeration (see 3.3 Renew). Other components
of the outline above are not further constrained by this specification.
If the enumeration is valid and
has not expired, the data source MUST reply with a response of the following
form:
[Action]
http://www.w3.org/2009/02/ws-enu/GetStatusResponse
[Body]
<wsen:GetStatusResponse ...>
<wsen:Expires>(xs:dateTime
| xs:duration)</wsen:Expires> ?
xs:any*
</wsen:GetStatusResponse>
Components of the outline listed
above are constrained as for a response to a renew request (see 3.3
Renew). Other components of the outline above are not further
constrained by this specification.
The Release operation is initiated by sending a Release request message to
the data source. The Release request message MUST be of the following form:
[Action]
http://www.w3.org/2009/02/ws-enu/Release
[Body]
<wsen:Release ...>
<wsen:EnumerationContext>...</wsen:EnumerationContext>
xs:any*
</wsen:Release>
The following describes additional, normative constraints on the outline
listed above:
[Body]/wsen:Release/wsen:EnumerationContext
This required element contains the XML data that
represents the enumeration context being abandoned.
Other components of the outline above are not further constrained by this
specification.
Upon successful processing of a Release request message, a data source is
expected to return a Release response message, which MUST adhere to the
following form:
[Action]
http://www.w3.org/2009/02/ws-enu/ReleaseResponse
[Body]
<wsen:ReleaseResponse ...>
xs:any*
</wsen:ReleaseResponse>
Example 3-5
lists a Release request.
(01)
<s:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
(02) xmlns:wsa="http://www.w3.org/2005/08/addressing"
(03) xmlns:wsen="http://www.w3.org/2009/02/ws-enu">
(04) <s:Header>
(05) <wsa:Action>
(06)
http://www.w3.org/2009/02/ws-enu/Release
(07) </wsa:Action>
(08) <wsa:MessageID>
(09) uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:MessageID>
(11) <wsa:To>http://www.example.com/relayAgent</wsa:To>
(12) <wsa:ReplyTo>
(13) <wsa:Address>
(14)
http://www.w3.org/2005/08/addressing/anonymous
(15) </wsa:Address>
(16) </wsa:ReplyTo>
(17) </s:Header>
(18) <s:Body>
(19) <wsen:Release>
(20) <wsen:EnumerationContext>123</wsen:EnumerationContext>
(21) </wsen:Release>
(22) </s:Body>
(23)
</s:Envelope>
Lines (05-07) in Example 3-5 indicate this message is a Release request
and that the data source is expected to respond with a Release response
message. Line (20) identifies the enumeration context to be released.
Example 3-6
lists a response to the request in Example 3-5.
(01)
<s:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"
(02) xmlns:wsen="http://www.w3.org/2009/02/ws-enu"
(03) xmlns:wsa="http://www.w3.org/2005/08/addressing">
(04) <s:Header>
(05) <wsa:Action>
(06)
http://www.w3.org/2009/02/ws-enu/ReleaseResponse
(07) </wsa:Action>
(08) <wsa:RelatesTo>
(09) uuid:e7c5726b-de29-4313-b4d4-b3425b200839
(10) </wsa:RelatesTo>
(11) <wsa:To>
(12)
http://www.w3.org/2005/08/addressing/anonymous
(13) <wsa:To>
(14) </s:Header>
(15) <s:Body>
(16) <wsen:ReleaseResponse/>
(17) </s:Body>
(18)
</s:Envelope>
Lines (05-07) in Example 3-6 indicate this message is a Release response
message.
If the data source terminates an enumeration unexpectedly, the data source
SHOULD send an EnumerationEnd SOAP message to the
endpoint reference indicated when the enumeration was created (see 3.1 Enumerate).
The message MUST be of the following form:
[Action]
http://www.w3.org/2009/02/ws-enu/EnumerationEnd
[Body]
<wsen:EnumerationEnd ...>
<wsen:Code>
( http://www.w3.org/2009/02/ws-enu/SourceShuttingDown
|
http://www.w3.org/2009/02/ws-enu/SourceCancelling )
</wsen:Code>
<wsen:Reason xml:lang="language
identifier" >
xs:string
</wsen:Reason>
?
xs:any*
</wsen:EnumerationEnd>
The following describes
additional, normative constraints on the outline listed above:
[Body]/wsen:EnumerationEnd/wsen:Code =
"http://www.w3.org/2009/02/ws-enu/SourceShuttingDown"
This
value MUST be used if the data source terminated the enumeration because the
source is being shut down in a controlled manner; that is, if the data source
is being shut down but has the opportunity to send an EnumerationEnd
message before it exits.
[Body]/wsen:EnumerationEnd/wsen:Code =
"http://www.w3.org/2009/02/ws-enu/SourceCancelling"
This
value MUST be used if the data source terminated the enumeration for some other
reason before it expired.
[Body]/wsen:EnumerationEnd/wsen:Reason
This
optional element contains text, in the language specified by the @xml:lang attribute, describing the
reason for the unexpected enumeration termination.
Other components of the outline
above are not further constrained by this specification.
WS-Enumeration faults MUST include as the [Action] property the
following fault action URI:
http://www.w3.org/2009/02/ws-enu/fault
The faults defined in this section are generated if the condition stated in
the preamble is met. Faults are targeted at a destination endpoint according to
the fault handling rules defined in [WS-Addressing].
The definitions of faults in this
section use the following properties:
[Code] The fault code.
[Subcode] The fault subcode.
[Reason] The English language reason element.
[Detail] The detail element. If
absent, no detail element is defined for the fault.
For SOAP 1.2, the [Code]
property MUST be either "Sender" or "Receiver". These
properties are serialized into text XML as follows:
|
Sender
|
Receiver
|
|
|
SOAP 1.2 |
s12:Sender |
s12:Receiver |
The properties above bind to a SOAP 1.2 fault as follows:
<s12:Envelope>
<s12:Header>
<wsa:Action>
http://www.w3.org/2009/02/ws-enu/fault
</wsa:Action>
<!--
Headers elided for clarity. -->
</s12:Header>
<s12:Body>
<s12:Fault>
<s12:Code>
<s12:Value>[Code]</s12:Value>
<s12:Subcode>
<s12:Value>[Subcode]</s12:Value>
</s12:Subcode>
</s12:Code>
<s12:Reason>
<s12:Text xml:lang="en">[Reason]</s12:Text>
</s12:Reason>
<s12:Detail>
[Detail]
...
</s12:Detail>
</s12:Fault>
</s12:Body>
</s12:Envelope>
The properties bind to a SOAP 1.1 fault as follows:
<s11:Envelope>
<s11:Body>
<s11:Fault>
<faultcode>[Subcode]</faultcode>
<faultstring xml:lang="en">[Reason]</faultstring>
<detail>
[Detail]
...
</detail>
</s11:Fault>
</s11:Body>
</s11:Envelope>
This fault is generated if the Enumerate
expiration time is either a zero duration or a
specific time that occurs in the past according to the data source.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:InvalidExpirationTime |
|
[Reason] |
Invalid expiration time. |
|
[Detail] |
This fault is generated if the Enumerate
expiration time is specified not as a duration.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:UnsupportedExpirationTime |
|
[Reason] |
Unsupported expiration
time. |
|
[Detail] |
This fault is generated if the data source does
not support filters.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:FilteringNotSupported |
|
[Reason] |
Filtering not supported. |
|
[Detail] |
This fault is generated if the data source does
not support the requested filter dialect.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:FilterDialectRequestedUnavailable |
|
[Reason] |
Filer dialect requested
unavailable. |
|
[Detail] |
<wsen:SupportedDialect>
+ |
This fault is generated if the data source can not process the filter content.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:CannotProcessFilter |
|
[Reason] |
Cannot filter as requested.
|
|
[Detail] |
This fault is generated if the enumeration context
is invalid.
|
[Code] |
s12:Receiver |
|
[Subcode] |
wsen:InvalidEnumerationContext |
|
[Reason] |
Text explaining why the
enumeration context is no longer valid, or "Invalid enumeration context" if no
additional information is available. |
|
[Detail] |
This fault is generated if the data source times out is the wsen:MaxTime is reached.
|
[Code] |
s12:Receiver |
|
[Subcode] |
wsen:TimedOut
|
|
[Reason] |
Timeout. |
|
[Detail] |
This fault is generated if the data source is unable to renew the
enumeration.
|
[Code] |
s12:Receiver |
|
[Subcode] |
wsen:UnableToRenew
|
|
[Reason] |
Text explaining why the
enumeration context cannot be renewed, or "data
source unable to renew" if no additional information is available. |
|
[Detail] |
This fault MAY be generated when a Data Source detects that the wsen:EndTo EPR is unusable.
|
[Code] |
s12:Sender |
|
[Subcode] |
wsen:UnusableEPR |
|
[Reason] |
The wsen:EndTo EPR is unusable. |
|
[Detail] |
Details as to why the EPR
is unusable. |
It is strongly recommended that the communication between services be
secured using the mechanisms described in [WS-Security].
In order to properly secure
messages, the body (even if empty) and all relevant headers need to be included
in the signature. Specifically, the WS-Addressing header blocks, WS-Security
timestamp, and any header blocks resulting from a <wsa:ReferenceParameters> in references need to be signed along with the
body in order to "bind" them together and prevent certain types of
attacks.
If a requestor
is issuing multiple messages to a Web service, such as when a consumer is
enumerating a data source, it is recommended that a security context be
established using the mechanisms described in [WS-SecureConversation]. It is often appropriate to
establish a security context that is used both for the initiation of
enumeration (i.e., the Enumerate request or an equivalent service-specific
request) and the actual enumeration itself (i.e., the Pull requests). It is
further recommended that if shared secrets are used, message-specific derived
keys should
SHOULD be used to protect the secret
from crypto attacks.
The access control semantics of
data sources is out-of-scope of this specification and are specific to each
data source. Similarly, any protection mechanisms on data source independent of
their transfer (e.g. embedded signatures and encryption) are also out-of-scope.
It is recommended that the
security considerations of WS-Security also be considered.
While a comprehensive set of
attacks is not feasible, the following list summarizes common classes of
attacks that apply to this protocol and identifies the mechanism(s) to
prevent/mitigate the attacks.
·
Replay - Messages, or portions of messages, can
be replayed in an attempt to gain access or disrupt services. Freshness checks
such as timestamps, digests, and sequences can be used to detect duplicate
messages.
·
Invalid
tokens - There are a
number of token attacks including certificate authorities, false signatures,
and PKI attacks. Care should SHOULD be taken to
ensure each token is valid (usage window, digest, signing authority, revocation, ...), and that the appropriate delegation
policies are in compliance.
·
Man-in-the-middle - The message exchanges in this
specification could be subject to man-in-the-middle attacks so care should SHOULD be
taken to reduce possibilities here such as establishing a secure channel and
verifying that the security tokens user represent identities authorized to
speak for, or on behalf of, the desired resource reference.
·
Message
alteration - Alteration
is prevented by including signatures of the message information using
WS-Security. Care should SHOULD be taken to
review message part references to ensure they haven't been forged (e.g. ID
duplication).
·
Message
disclosure -
Confidentiality is preserved by encrypting sensitive data using WS-Security.
·
Key
integrity - Key
integrity is maintained by using the strongest algorithms possible (by
comparing secured policies - see [WS-Policy] and [WS-SecurityPolicy]) and
by using derived keys ([WS-SecureConversation]).
·
Authentication - Authentication is established using the
mechanisms described in WS-Security and WS-Trust. Each message is authenticated
using the mechanisms described in WS-Security.
·
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.
·
Availability - All reliable messaging services are
subject to a variety of availability attacks. Replay detection is a common
attack and it is recommended that this be addressed by the mechanisms described
in WS-Security. 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 SHOULD be taken to
ensure that minimal state is saved prior to any authenticating sequences.
This
specification has been developed as a result of joint work with many
individuals and teams, including: Ashok Malhotra
(Oracle Corp.), Asir Vedamuthu
(Microsoft Corp.), Bob Freund (Hitachi, Ltd.), Doug Davis (IBM), Fred Maciel (Hitachi, Ltd.), Geoff Bullen
(Microsoft Corp.), Gilbert Pilz (Oracle Corp.), Greg
Carpenter (Microsoft Corp.), Jeff Mischkinsky (Oracle
Corp.), Katy Warr (IBM), Li Li
(Avaya Communications), Mark Little (Red Hat), Prasad Yendluri
(Software AG), Sreedhara Narayanaswamy
(CA), Sumeet Vij (Software
AG), Vikas Varma (Software
AG), Wu Chou (Avaya Communications), Yves Lafon (W3C)
Key words
for use in RFCs to Indicate Requirement Levels , S. Bradner, March 1997. (See
http://www.ietf.org/rfc/rfc2119.txt.)
Simple
Object Access Protocol (SOAP) 1.1 , D. Box,
et al, May 2000. (See http://www.w3.org/TR/2000/NOTE-SOAP-20000508/.)
SOAP
Version 1.2 Part 1: Messaging Framework ,
M. Gudgin, et al, June 2003. (See
http://www.w3.org/TR/2003/REC-soap12-part1-20030624/.)
W3C Recommendation,
"Web Services Addressing 1.0 (WS-Addressing)" , May 2006.
(See http://www.w3.org/2005/08/addressing/.)
W3C Recommendation, "Web
Services Policy 1.5 - Framework" , September 2007. (See
http://www.w3.org/TR/ws-policy/.)
WS-SecureConversation
Web Services Secure
Conversation Language (WS-SecureConversation) , S. Anderson, et al,
February 2005. (See http://schemas.xmlsoap.org/ws/2005/02/sc.)
Web
Services Security: SOAP Message Security 1.0 , A. Nadalin, et al, March 2004. (See
http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf.)
WS-SecurityPolicy
Web
Services Security Policy Language (WS-SecurityPolicy), , Version 1.1 , G. Della-Libera, et al, July 2005.
(See http://schemas.xmlsoap.org/ws/2005/07/securitypolicy.)
Web
Services Description Language (WSDL) 1.1 ,
E. Christensen, et al, March 2001. (See
http://www.w3.org/TR/2001/NOTE-wsdl-20010315.)
XML Infoset
XML
Information Set , J. Cowan, et al, February 2004. (See
http://www.w3.org/TR/2004/REC-xml-infoset-20040204/.)
XML
Schema Part 1: Structures , H. Thompson, et
al, October 2004. (See http://www.w3.org/TR/2004/REC-xmlschema-1-20041028/.)
XML
Schema Part 2: Datatypes , P. Biron, et al, October 2004. (See
http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/.)
XML Path Language
(XPath) Version 1.0 , J. Clark, et al, November 1999. (See
http://www.w3.org/TR/1999/REC-xpath-19991116.)
A normative copy of the XML Schema [XMLSchema
- Part 1], [XMLSchema -
Part 2] description for this specification may can be
retrieved from the following address:
A non-normative copy of the XML
schema is listed below for convenience.
<xs:schema
targetNamespace="http://www.w3.org/2009/02/ws-enu"
xmlns:tns="http://www.w3.org/2009/02/ws-enu"
xmlns:wsa="http://www.w3.org/2005/08/addressing"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
elementFormDefault="qualified"
blockDefault="#all">
<xs:import
namespace="http://www.w3.org/XML/1998/namespace"
schemaLocation="http://www.w3.org/2001/xml.xsd"
/>
<xs:import
namespace="http://www.w3.org/2005/08/addressing"
schemaLocation="http://www.w3.org/2005/08/addressing/ws-addr.xsd"
/>
<!-- Types and global elements -->
<xs:complexType name="FilterType" mixed="true">
<xs:sequence>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute
name="Dialect" type="xs:anyURI"
/>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
<xs:simpleType name="PositiveDurationType">
<xs:restriction
base="xs:duration">
<xs:minExclusive
value="P0Y0M0DT0H0M0S" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="NonNegativeDurationType">
<xs:restriction
base="xs:duration">
<xs:minInclusive
value="P0Y0M0DT0H0M0S" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ExpirationType">
<xs:union memberTypes="xs:dateTime tns:NonNegativeDurationType" />
</xs:simpleType>
<xs:complexType name="EnumerationContextType">
<xs:complexContent
mixed="true">
<xs:restriction base="xs:anyType">
<xs:sequence>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="ItemListType">
<xs:sequence maxOccurs="unbounded">
<xs:any namespace="##other"
processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="LanguageSpecificStringType">
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute ref="xml:lang" />
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<!-- Enumerate request -->
<xs:element
name="Enumerate">
<xs:complexType>
<xs:sequence>
<xs:element name="EndTo" type="wsa:EndpointReferenceType"
minOccurs="0"
/>
<xs:element
name="Expires" type="tns:ExpirationType"
minOccurs="0"
/>
<xs:element name="Filter"
type="tns:FilterType"
minOccurs="0"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Used for a fault response -->
<xs:element name="SupportedDialect" type="xs:anyURI"
/>
<!-- Enumerate response -->
<xs:element name="EnumerateResponse">
<xs:complexType>
<xs:sequence>
<xs:element
name="Expires" type="tns:ExpirationType"
minOccurs="0"
/>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Pull request -->
<xs:element
name="Pull">
<xs:complexType>
<xs:sequence>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
/>
<xs:element name="MaxTime" type="tns:PositiveDurationType"
minOccurs="0"
/>
<xs:element name="MaxElements" type="xs:positiveInteger"
minOccurs="0"
/>
<xs:element name="MaxCharacters" type="xs:positiveInteger"
minOccurs="0"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Pull response -->
<xs:element name="PullResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
minOccurs="0"
/>
<xs:element name="Items"
type="tns:ItemListType"
minOccurs="0"
/>
<xs:element name="EndOfSequence" minOccurs="0"
/>
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Renew request -->
<xs:element
name="Renew">
<xs:complexType>
<xs:sequence>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
/>
<xs:element
name="Expires" type="tns:ExpirationType"
minOccurs="0"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Renew response -->
<xs:element name="RenewResponse">
<xs:complexType>
<xs:sequence>
<xs:element
name="Expires" type="tns:ExpirationType"
minOccurs="0"
/>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
minOccurs="0"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- GetStatus request -->
<xs:element name="GetStatus">
<xs:complexType>
<xs:sequence>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- GetStatus response -->
<xs:element name="GetStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element
name="Expires" type="tns:ExpirationType"
minOccurs="0"
/>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0" maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Release request -->
<xs:element
name="Release">
<xs:complexType>
<xs:sequence>
<xs:element name="EnumerationContext"
type="tns:EnumerationContextType"
/>
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- Release response -->
<xs:element name="ReleaseResponse">
<xs:complexType>
<xs:sequence>
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<!-- EnumerationEnd message
-->
<xs:element name="EnumerationEnd">
<xs:complexType>
<xs:sequence>
<xs:element name="Code"
type="tns:OpenEnumerationEndCodeType" />
<xs:element name="Reason"
type="tns:LanguageSpecificStringType"
minOccurs="0"
maxOccurs="unbounded" />
<xs:any
namespace="##other" processContents="lax"
minOccurs="0"
maxOccurs="unbounded" />
</xs:sequence>
<xs:anyAttribute
namespace="##other" processContents="lax"
/>
</xs:complexType>
</xs:element>
<xs:simpleType name="EnumerationEndCodeType">
<xs:restriction
base="xs:anyURI">
<xs:enumeration
value=
"http://www.w3.org/2009/02/ws-enu/SourceShuttingDown" />
<xs:enumeration
value=
"http://www.w3.org/2009/02/ws-enu/SourceCancelling" />
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="OpenEnumerationEndCodeType">
<xs:union memberTypes="tns:EnumerationEndCodeType
xs:anyURI" />
</xs:simpleType>
</xs:schema>
A
normative copy of the WSDL [WSDL11] description for this specification may can be
retrieved from the following address:
A non-normative copy of the WSDL
description is listed below for convenience.
<wsdl:definitions
targetNamespace="http://www.w3.org/2009/02/ws-enu"
xmlns:wsa="http://www.w3.org/2005/08/addressing"
xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsen="http://www.w3.org/2009/02/ws-enu"
xmlns:xs="http://www.w3.org/2001/XMLSchema" >
<wsdl:types>
<xs:schema>
<xs:import
namespace="http://www.w3.org/2009/02/ws-enu"
schemaLocation="http://www.w3.org/2009/02/ws-enu/enumeration.xsd"
/>
</xs:schema>
</wsdl:types>
<wsdl:message name="EnumerateMessage">
<wsdl:part
name="Body" element="wsen:Enumerate"
/>
</wsdl:message>
<wsdl:message name="EnumerateResponseMessage">
<wsdl:part
name="Body" element="wsen:EnumerateResponse"
/>
</wsdl:message>
<wsdl:message name="PullMessage">
<wsdl:part
name="Body" element="wsen:Pull"
/>
</wsdl:message>
<wsdl:message name="PullResponseMessage">
<wsdl:part
name="Body" element="wsen:PullResponse"
/>
</wsdl:message>
<wsdl:message name="RenewMessage" >
<wsdl:part
name="Body" element="wsen:Renew"
/>
</wsdl:message>
<wsdl:message name="RenewResponseMessage" >
<wsdl:part
name="Body" element="wsen:RenewResponse"
/>
</wsdl:message>
<wsdl:message name="GetStatusMessage" >
<wsdl:part
name="Body" element="wsen:GetStatus"
/>
</wsdl:message>
<wsdl:message name="GetStatusResponseMessage" >
<wsdl:part
name="Body" element="wsen:GetStatusResponse"
/>
</wsdl:message>
<wsdl:message name="ReleaseMessage">
<wsdl:part
name="Body" element="wsen:Release"
/>
</wsdl:message>
<wsdl:message name="ReleaseResponseMessage">
<wsdl:part
name="Body" element="wsen:ReleaseResponse"
/>
</wsdl:message>
<wsdl:message name="EnumerationEndMessage" >
<wsdl:part name="Body"
element="wsen:EnumerationEnd" />
</wsdl:message>
<wsdl:portType name="DataSource">
<wsdl:operation
name="EnumerateOp">
<wsdl:input
message="wsen:EnumerateMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/Enumerate"
/>
<wsdl:output
message="wsen:EnumerateResponseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/EnumerateResponse"
/>
</wsdl:operation>
<wsdl:operation
name="PullOp">
<wsdl:input
message="wsen:PullMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/Pull"
/>
<wsdl:output
message="wsen:PullResponseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/PullResponse"
/>
</wsdl:operation>
<wsdl:operation
name="RenewOp" >
<wsdl:input
message="wsen:RenewMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/Renew"
/>
<wsdl:output
message="wsen:RenewResponseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/RenewResponse"
/>
</wsdl:operation>
<wsdl:operation
name="GetStatusOp" >
<wsdl:input
message="wsen:GetStatusMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/GetStatus"
/>
<wsdl:output
message="wsen:GetStatusResponseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/GetStatusResponse"
/>
</wsdl:operation>
<wsdl:operation
name="ReleaseOp">
<wsdl:input
message="wsen:ReleaseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/Release"
/>
<wsdl:output
message="wsen:ReleaseResponseMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/ReleaseResponse"
/>
</wsdl:operation>
</wsdl:portType>
<wsdl:portType name="EnumerationEndPortType">
<wsdl:operation
name="EnumerationEndOp" >
<wsdl:input
message="wsen:EnumerationEndMessage"
wsam:Action="http://www.w3.org/2009/02/ws-enu/EnumerationEnd"
/>
</wsdl:operation>
</wsdl:portType>
</wsdl:definitions>
|
Data
|
Author
|
Description
|
|
2009/03/04 |
DD |
Added resolution of issue 6391 |
|
2009/03/04
|
DD
|
Added
resolution of issue 6519 |
|
2009/03/11
|
DD
|
Added
change log |
|
2009/03/11
|
DD
|
Added
resolution of issue 6641 |
|
2009/03/11
|
DD
|
Added
resolution of issue 6425 |
|
2009/03/16
|
KW
|
Added
resolution of issue 6587 |
|
2009/03/17
|
DD
|
Added
resolution of issue 6399 |
|
2009/03/23
|
DD
|
Added
resolution of issue 6666 |
|
2009/03/24
|
DD
|
Added
resolution of issue 6648 |
|
2009/04/07
|
DD
|
Added
resolution of issue 6499 |
|
2009/04/07
|
DD
|
Added
resolution of issue 6726 |
|
2009/04/22
|
KW
|
Added
resolution of issue 6739 |
|
2009/04/28
|
DD
|
Added
resolution of issue 6787 |
|
2009/05/12
|
DD
|
Added
resolution of issue 6860 |
|
2009/05/13
|
DD
|
Added
resolution of issue 6696 |
|
2009/05/21
|
DD
|
Added
resolution of issue 6674 |
|
2009/05/26
|
KW
|
Added
resolution of issue 6920 |
|
2009/05/27
|
DD
|
Added
resolution of issue 6906 |
|
2009/06/04
|
DD
|
Added
resolution of issue 6916 |
|
2009/06/11
|
DD
|
Added
resolution of issue 6956 |