Web Services Eventing (WS-Eventing)

Editor's Draft $Date: 2010/05/12 02:05:22 $

Latest version:

http://www.w3.org/TR/ws-eventing

Previous version:

http://www.w3.org/TR/2009/WD-ws-eventing-20090317

Editors:

Doug Davis, IBM

Ashok Malhotra, Oracle

Katy Warr, IBM

Wu Chou, Avaya

Copyright © 2010 W3C^® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark and document use rules apply.

---

Abstract

This specification describes a protocol that allows Web services to subscribe to or accept subscriptions for notification messages.

Status of this Document

This document is an editors' copy that has no official standing.

Table of Contents

1 Composable Architecture
2 Introduction
   2.1 Requirements
   2.2 Delivery
   2.3 Notification Formats
   2.4 Subscription Managers
   2.5 Example
3 Notations and Terminology
   3.1 Notational Conventions
   3.2 Considerations on the Use of Extensibility Points
   3.3 Terminology
   3.4 Compliance
   3.5 XML Namespaces
4 Subscription Messages
   4.1 Subscribe
   4.2 Renew
   4.3 GetStatus
   4.4 Unsubscribe
   4.5 SubscriptionEnd
5 Notifications
6 Faults
   6.1 Fault Detail RetryAfter Element
   6.2 InvalidExpirationTime
   6.3 ExpirationTimeExceeded
   6.4 UnsupportedExpirationType
   6.5 FilteringNotSupported
   6.6 FilteringRequestedUnavailable
   6.7 DeliveryFormatRequestUnavailable
   6.8 EmptyFilter
   6.9 UnusableEPR
   6.10 UnknownSubscription
   6.11 EndToNotSupported
7 Security Considerations
   7.1 Notifications
   7.2 Subscriptions
   7.3 Endpoint Verification
8 Implementation Considerations
9 WS-Eventing Metadata
   9.1 EventSource Assertion
   9.2 SubscriptionManager Assertion
10 Acknowledgements
11 References
   11.1 Normative References
   11.2 Informative References

Appendices

A Advertising Event Information
   A.1 Event Types & Event Descriptions
        A.1.1 Retrieving Event Descriptions
        A.1.2 Bindings for Event Descriptions
            A.1.2.1 Binding for Unwrapped Notifications
            A.1.2.2 Binding for Wrapped Notifications
   A.2 Notification WSDLs
        A.2.1 Retrieving Notification WSDLs
B XML Schema
C WSDL
D WSDL for Standard Wrapped Delivery
E Action Tables
F Change Log

---

1 Composable Architecture

By using the XML, SOAP [SOAP11], [SOAP12], and WSDL [WSDL11] extensibility models, the Web service specifications (WS-*) are designed to be composed with each other to provide a rich set of tools for the Web services environment. This specification specifically relies on other Web service specifications to provide secure, reliable, and/or transacted message delivery and to express Web service and client policy.

2 Introduction

Web services often want to receive messages when events occur in other services and applications. A mechanism for registering interest is needed because the set of Web services interested in receiving such messages is often unknown in advance or will change over time. This specification defines a protocol for one Web service (called a "subscriber") to register interest (called a "subscription") with another Web service (called an "event source") in receiving messages about events (called "notifications"). The subscriber can manage the subscription by interacting with a Web service (called the "subscription manager") designated by the event source.

To improve robustness, a subscription can be leased by an event source to a subscriber, and the subscription expires over time. The subscription manager provides the ability for the subscriber to renew or cancel the subscription before it expires.

There are many mechanisms by which notifications can be delivered to event sinks. This specification provides an extensible way for subscribers to identify the delivery mechanism they prefer.

2.1 Requirements

This specification intends to meet the following requirements:

· Define means to create and delete event subscriptions.

· Define expiration for subscriptions and allow them to be renewed.

· Define how one Web service can subscribe on behalf of another.

· Define how an event source delegates subscription management to another Web service.

· Allow subscribers to specify how notifications are to be delivered.

· Leverage other Web service specifications for secure, reliable, transacted message delivery.

· Support complex eventing topologies that allow the originating event source and the final event sink to be decoupled.

· Provide extensibility for more sophisticated and/or currently unanticipated subscription scenarios.

· Support a variety of encoding formats, including (but not limited to) both SOAP 1.1 [SOAP11] and SOAP 1.2 [SOAP12] Envelopes.

2.2 Delivery

This specification defines a method for transmitting notifications to the event sink through the use of the wse:NotifyTo element. Other methods or combination of methods MAY be defined through the use of delivery extensions.

When the wse:NotifyTo element is used within the Delivery element it specifies the endpoint to which notifications are sent. For delivery to addressable endpoints this is sufficient. However, for non-addressable endpoints some additional mechanisms are needed. A subscription manager MAY choose to support mechanisms, such as the [WS-MakeConnection] specification, to enable delivery of notifications and the SubscriptionEnd message to non-addressable endpoints. See the [WS-MakeConnection] specification for more information, and an example, of how this would work.

2.3 Notification Formats

This specification does not mandate how events are serialized into notification messages. Rather, within the Subscribe request message a subscriber can specify a "Format" that indicates the set of rules that MUST be followed when constructing notification messages.

This specification specifies two delivery formats: wrapped and unwrapped. Use of wrapped format indicates that notification messages MUST be contained in a wrapper element defined by this specification. Use of unwrapped format indicates that notification messages are not contained in a wrapper element.

Filtering occurs prior to any formatting of notification messages. This ensures that regardless of what type of formatting might occur, the same Filter dialect/expression can be used to subset the event stream.

2.4 Subscription Managers

In some scenarios the event source itself manages the subscriptions it has created. In other scenarios, for example a geographically distributed publish-and-subscribe system, it might be useful to delegate the management of a subscription to another Web service. To support this flexibility, the response to a subscription request to an event source will include the EPR of a service that the subscriber can interact with to manage this subscription. This EPR MUST be the target for future requests to renew or cancel the subscription. It can address the same Web service (Address and ReferenceParameters) as the event source itself, or it can address some other Web service to which the event source has delegated management of this subscription.

The term "subscription manager" is used in this specification to refer to the Web service that manages the subscription, whether it is the event source itself or some separate Web service.

2.5 Example

Example 2-1 lists a hypothetical request to create a subscription for storm warnings.

Example 2-1: Hypothetical request to create a subscription

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ew="http://www.example.com/warnings" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Subscribe

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:d7c5726b-de29-4313-b4d4-b3425b200839

(12) </wsa:MessageID>

(13) <wsa:ReplyTo>

(14) <wsa:Address>http://www.example.com/MyEventSink</wsa:Address>

(15) </wsa:ReplyTo>

(16) <wsa:To>http://www.example.org/oceanwatch/EventSource</wsa:To>

(17) </s12:Header>

(18) <s12:Body>

(19) <wse:Subscribe>

(20) <wse:Delivery>

(21) <wse:NotifyTo>

(22) <wsa:Address>

(23) http://www.example.com/MyEventSink/OnStormWarning

(24) </wsa:Address>

(25) <wsa:ReferenceParameters>

(26) <ew:MySubscription>2597</ew:MySubscription>

(27) </wsa:ReferenceParameters>

(28) </wse:NotifyTo>

(29) </wse:Delivery>

(30) </wse:Subscribe>

(31) </s12:Body>

(32) </s12:Envelope>

Lines (07-09) in Example 2-1 indicate the message is a request to create a subscription, and line (16) indicates that it is sent to a hypothetical event source of ocean events.

While lines (13-15) indicate where a reply is sent, lines (20-29) indicate where and how notifications are to be delivered; there is no requirement that these match. The absence of any extensions to the wse:Delivery or wse:NotifyTo elements indicates that notifications are sent as SOAP messages to the endpoint described in lines (21-28). Note that lines (25-27) illustrate a typical pattern where the event sink lists a reference parameter (line 26) that identifies the subscription and will be included in each notification.

Example 2-2 lists a hypothetical response to the request in Example 2-1.

Example 2-2: Hypothetical response to a subscribe request

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscribeResponse

(09) </wsa:Action>

(10) <wsa:RelatesTo>

(11) uuid:d7c5726b-de29-4313-b4d4-b3425b200839

(12) </wsa:RelatesTo>

(13) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(14) </s12:Header>

(15) <s12:Body>

(16) <wse:SubscribeResponse>

(17) <wse:SubscriptionManager>

(18) <wsa:Address>

(19) http://www.example.org/oceanwatch/SubscriptionManager

(20) </wsa:Address>

(21) <wsa:ReferenceParameters>

(22) <ow:MyId>

(23) 28

(24) </ow:MyId>

(25) </wsa:ReferenceParameters>

(26) </wse:SubscriptionManager>

(27) <wse:GrantedExpires>P0Y0M0DT30H0M0S</wse:GrantedExpires>

(28) </wse:SubscribeResponse>

(29) </s12:Body>

(30) </s12:Envelope>

Lines (07-09) in Example 2-2 indicate this message is a response to a request to create a subscription, and lines (10-12) indicate that it is a response to the request in Example 2-1. Lines (17-26) provide the subscription manager EPR for this subscription, and line (27) indicates the subscription will expire in 30 hours unless renewed.

3 Notations and Terminology

This section specifies the notations, namespaces, and terminology used in this specification.

3.1 Notational Conventions

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 [RFC 2119].

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:

o "?" (0 or 1)

o "*" (0 or more)

o "+" (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 a point of extensibility.

· XML namespace prefixes (see Table 3-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 IRI.

[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>

This specification can be used in terms of XML Information Set (Infoset) [XML Infoset], even though the specification uses XML 1.0 terminology. Valid Infoset for this specification is the one serializable in XML 1.0, hence the use of XML 1.0.

The term "generate" is used in relation to the various faults defined by this specification to imply that a fault is produced and no further processing SHOULD be performed. In these cases the fault SHOULD be transmitted. However, there might be reasons when a compliant implementation can choose not to transmit the fault - for example, security concerns - in these situations the service MAY choose not to transmit the fault.

3.2 Considerations on the Use of Extensibility Points

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".

In cases where it is either desirable or necessary for the receiver of a request that has been extended to indicate that it has recognized and accepted the semantics associated with that extension, it is RECOMMENDED that the receiver add a corresponding extension to the response message. The definition of an extension SHOULD clearly specify how the extension that appears in the response correlates with that in the corresponding request.

Extension elements and attributes MUST NOT use the Web Services Eventing namespace URI.

3.3 Terminology

Event Source

A Web service that accepts requests to create subscriptions. Notifications MAY be sent by any endpoint including the event source.

Event Sink

A Web service that receives notifications.

Notification

A message sent to indicate that an event, or events, have occurred.

Subscription

A registration of interest in receiving notification messages from an event source. Subscriptions MAY be created, renewed, expired or cancelled. A subscription is "active" when it has been created but has not been expired or cancelled.

Subscriber

A Web service that sends requests to create, renew, and/or delete subscriptions.

Subscription Manager

A Web service that accepts requests to manage, get the status of, renew, and/or delete subscriptions on behalf of an event source.

3.4 Compliance

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 3.5 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 conform to the WS-Addressing specifications and be sent to a Web service that is addressable by an EPR (see [WS-Addressing]).

Unless otherwise noted, all IRIs are absolute IRIs and IRI comparison MUST be performed according to [RFC 3987] section 5.3.1.

For any message defined by this specification, any OPTIONAL elements or attributes in the message MAY be used by senders of the message; however receivers of those messages MUST support those OPTIONAL elements and attributes, unless other behavior is explicitly defined by this specification.

Implementations are expected to support both UTF-8 and UTF-16 as described in XML 1.0.

3.5 XML Namespaces

The XML namespace URI that MUST be used by implementations of this specification is:

http://www.w3.org/2002/ws/ra/edcopies/ws-evt

Table 3-1 lists XML namespaces that are used in this specification. The choice of any namespace prefix is arbitrary and not semantically significant.

Table 3-1: Prefixes and XML namespaces used in this specification
Prefix	XML Namespace	Specification(s)
s	(Either SOAP 1.1 or 1.2)	(Either SOAP 1.1 or 1.2)
s11	http://schemas.xmlsoap.org/soap/envelope/	SOAP 1.1 [SOAP11]
s12	http://www.w3.org/2003/05/soap-envelope	SOAP 1.2 [SOAP12]
wsdl	http://schemas.xmlsoap.org/wsdl/	WSDL [WSDL11]
wsa	http://www.w3.org/2005/08/addressing	WS-Addressing [WS-Addressing]
wse	http://www.w3.org/2002/ws/ra/edcopies/ws-evt	This specification
xs	http://www.w3.org/2001/XMLSchema	XML Schema [XMLSchema - Part 1], [XMLSchema - Part 2]

The working group intends to update the value of the Web Services Eventing 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 Eventing 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 .

4 Subscription Messages

To create, renew, and delete subscriptions, subscribers send request messages to event sources and subscription managers.

When an event source accepts a request to create a subscription, it typically does so for a given amount of time, although an event source MAY accept an indefinite subscription with no time-based expiration. If the subscription manager accepts a renewal request, it updates that amount of time. During that time, notifications are delivered to the requested event sink. An event source MAY support filtering to limit notifications that are delivered to the event sink; if it does, and a subscribe request contains a filter, only events that match the requested filter are sent. Notifications are sent until one of the following happens: the subscription manager accepts an unsubscribe request for the subscription; the subscription expires without being renewed; or the event source cancels the subscription prematurely. In this last case, the event source makes a best effort to indicate why the subscription ended, via a SubscriptionEnd message if an EndTo was present in the Subscribe message.

In the absence of reliable messaging at the application layer (e.g. [WS-ReliableMessaging]), messages defined herein are delivered using the quality of service of the underlying transport(s) and on a best-effort basis at the application layer.

A subscription can become invalid for any reason including:

1. Subscription deleted (via Unsubscribe)

2. Subscription expired

3. Subscription ended (via SubscriptionEnd)

In addition, the Event Source/Subscription Manager MAY cancel a subscription at any time, as necessary.

When processing a Renew, GetStatus or Unsubscribe operation, a Subscription Manager MUST generate an wse:UnknownSubscription fault if it determines that the subscription is invalid.

Once a Subscriber determines that a subscription is invalid, it MUST NOT issue any more WSEventing request messages using that subscription.

4.1 Subscribe

To create a subscription, a subscriber sends a Subscribe request message to an event source. This operation MUST be supported by compliant event sources. The message MUST be of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Subscribe

[Body]

<wse:Subscribe ...>

<wse:EndTo> endpoint-reference </wse:EndTo> ?

<wse:Delivery ...> xs:any* </wse:Delivery>

<wse:Format Name="xs:anyURI"? > xs:any* </wse:Format> ?

<wse:Expires min="(xs:dateTime | xs:duration)"?

max="(xs:dateTime | xs:duration)"?

exact="xs:boolean"? ...>

(xs:dateTime | xs:duration)

</wse:Expires> ?

<wse:Filter Dialect="xs:anyURI"? ...> xs:any* </wse:Filter> ?

xs:any*

</wse:Subscribe>

The following describes additional, normative constraints on the outline listed above:

[Body]/wse:Subscribe/wse:EndTo

Where to send a SubscriptionEnd message if the subscription is terminated unexpectedly. (See 4.5 SubscriptionEnd.) If present, this element MUST be of type wsa:EndpointReferenceType. Default is not to send this message. The endpoint to which the EndTo EPR refers MUST support the SubcriptionEndPortType portType. Unless some mechanism is used to indicate otherwise, the messages sent to this endpoint MUST use the same version of SOAP that was used for the Subscribe message.

If the event source does not support the use of the EndTo EPR, the event source MUST generate a wse:EndToNotSupported fault.

[Body]/wse:Subscribe/wse:Delivery

This element contains the information necessary to convey notification messages to the event sink in a manner REQUIRED by the subscriber. This element MUST contain at least one child element.

[Body]/wse:Subscribe/wse:Delivery/wse:NotifyTo

This is an OPTIONAL element. When present, this element indicates that notifications MUST be sent to the EndpointReference identified by this element. Unless some mechanism is used to indicate otherwise, the messages sent to this endpoint MUST use the same version of SOAP that was used for the Subscribe message.

[Body]/wse:Subscribe/wse:Format

This OPTIONAL element contains the delivery format to be used for notification messages sent in relation to this subscription. Implied value is "http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFormats/Unwrap", which indicates that unwrapped delivery MUST be used. See Section 2.3 Notification Formats for details.

If the event source does not support the requested delivery format, the request MUST generate a wse:DeliveryFormatRequestedUnavailable fault indicating that the requested delivery format is not supported.

[Body]/wse:Subscribe/wse:Format@Name="http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFormats/Unwrap"

Indicate the unwrapped event delivery format.

[Body]/wse:Subscribe/wse:Format@Name="http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFormats/Wrap"

Indicate the wrapped event delivery format.

[Body]/wse:Subscribe/wse:Expires

This OPTIONAL element can be used by the subscriber to indicate the expiration time of the requested subscription. The value of this element indicates the desired expiration time for the subscription. The implied default is indefinite (no expiry). The value of this element MUST be between the values of the @min and @max attributes inclusive. If the request is malformed, the event source MUST generate a wse:InvalidExpirationTime fault.

If the wse:Expires element is present and the event source is not able to grant an expiry time within range indicated by the @min and @max attribute values, it MUST generate a wse:ExpirationTimeExceeded fault.

The value of the wse:Expires element as well as those of its @min and @max attributes MAY be either a duration (xs:duration) or a specific time (xs:dateTime). Event sources and subscription managers MUST accept duration values and MAY accept specific time values. Upon receiving a request that contains specific time values, an event source or subscription manager that does not support such value types MUST fail the request and generate a wse:UnsupportedExpirationType fault.

The value types in a wse:Expires element MAY differ among the element and its attributes. For example, the element value can be a duration while the @max attribute can be a specific time. Regardless of the value types, it MUST be true that wse:Expires/@min <= wse:Expires <= wse:Expires/@max as interpreted by the event source or subscription manager at the time the wse:Subscribe request is processed. If this is not true, the request MUST fail and the receiver MUST generate a wse:InvalidExpirationTime fault.

If a subscriber chooses to use specific time values in a request, it is RECOMMENDED that these values include a time zone component. Specific time values that lack a time zone MUST be interpreted in the local time zone of the receiver.

[Body]/wse:Subscribe/wse:Expires@min

The implied default is PT0S. This specifies the minimum expiration time that the event subscriber is willing to accept.

[Body]/wse:Subscribe/wse:Expires@max

The implied default is indefinite (no expiry). This specifies the maximum expiration time that the event subscriber is willing to accept.

[Body]/wse:Subscribe/wse:Expires@exact

The default value is "false" in which case this attribute has no effect. If this attribute value is "true" both @min and @max attributes MUST be ignored and are treated as if they had the same value as the wse:Expires element.

[Body]/wse:Subscribe/wse:Filter

A Boolean expression in some dialect, either as a string or as an XML fragment (see [[Body]/wse:Subscribe/wse:Filter/@Dialect ]). If the expression evaluates to false for a notification, the notification MUST NOT be sent to the event sink. Implied value is an expression that always returns true. If the event source does not support filtering, then a request that specifies a filter MUST fail, and the event source MUST generate a wse:FilteringNotSupported fault indicating that filtering is not supported.

If the event source supports filtering but cannot honor the requested filtering, the request MUST fail, and the event source MUST generate a wse:FilteringRequestedUnavailable fault indicating that the requested filter dialect is not supported.

It is possible for a Subscribe request to contain a filter that will never evaluate to true for the lifetime of the subscription. If an event source detects this condition it MUST generate a wse:EmptyFilter fault in response to the Subscribe request message.

[Body]/wse:Subscribe/wse:Filter/@Dialect

Implied value is "http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Dialects/XPath10".

If filtering is supported, then support for the XPath 1.0 dialect (described below) is RECOMMENDED. Alternate filter dialects can be defined. Such dialect definitions MUST include sufficient information for proper application. For example, it would need to define the context (which data) over which the filter operates.

[Body]/wse:Subscribe/wse:Filter/@Dialect=" http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Dialects/XPath10 "

Value of [Body]/wse:Subscribe/wse:Filter is an XPath [XPath1.0] predicate expression (PredicateExpr); the context of the expression is:

· Context Node: the root of the event XML.

· 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 /s:Envelope/s:Body/*/wse:Filter.

The namespace bindings are evaluated against any namespace declarations that are in scope where the XPath expression appears within the SOAP message. Note that the evaluation of expressions that rely on such context dependent bindings is fragile in the face of transformations that alter namespace prefixes. Such transformations might occur during the transmission, processing, storage, or retrieval of a request. Clients that wish to isolate expressions from the effects of any changes to the namespace prefixes in the containing SOAP message are advised to construct expressions in a manner that avoids the use of namespace prefixes. For example, use an expression such as "/a[namespace-uri()='http://www.example.com']" not "/ns1:a".

Other components of the outline above are not further constrained by this specification.

If included within the Subscribe request message, the wse:NotifyTo and wse:EndTo SHOULD have some cursory validity checking performed before the Subscribe response is returned. While not all errors can be detected prior to sending a message to those EPRs, some obvious ones can be detected. For example, an unsupported transport specified within the wsa:Address IRI. Detecting these errors during Subscribe processing will lessen the chances of the subscriber creating an unusable subscription. If this check is performed and a problem is detected then the event source MUST generate a wse:UnusableEPR fault rather than returning the SubscribeResponse message.

If the event source chooses not to accept a subscription due to the content of the Subscribe message, then the event source MUST generate a SOAP 1.1 Client fault or a SOAP 1.2 Sender fault. If the event source does not accept this subscription due to an internal processing reason and not due to the specific content of the Subscribe message, then the event source MUST generate a SOAP 1.1 Server fault or a SOAP 1.2 Receiver fault which MAY contain the RetryAfter fault detail element.

If the event source accepts a request to create a subscription, it MUST reply with a response of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscribeResponse

[Body]

<wse:SubscribeResponse ...>

<wse:SubscriptionManager>

wsa:EndpointReferenceType

</wse:SubscriptionManager>

<wse:GrantedExpires ...>

(xs:dateTime | xs:duration)

</wse:GrantedExpires> ?

xs:any*

</wse:SubscribeResponse>

The following describes additional, normative constraints on the outline listed above:

[Body]/wse:SubscribeResponse/wse:SubscriptionManager

The EPR of the subscription manager for this subscription.

[Body]/wse:SubscribeResponse/wse:GrantedExpires

The expiration time assigned by the event source. The expiration time MAY be either a specific time or a duration but MUST be of the same type as the wse:Expires element of the corresponding request. If the corresponding request did not contain a wse:Expires element, this element MUST be a duration (xs:duration).

When expressed as a duration, the wse:GrantedExpires element designates a time interval that began at the moment the subscription is created. Although this specification cannot dictate when, during the processing of a Subscribe request, a subscription is created, the event source MUST start the expiration interval at or before it transmits the wse:SubscribeResponse message.

If this element does not appear, then the subscription will not expire. That is, the subscription has an indefinite lifetime.

Other components of the outline above are not further constrained by this specification.

Example 4-1 lists another hypothetical request to create a subscription.

Example 4-1: Second hypothetical request to create a subscription

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ew="http://www.example.com/warnings" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Subscribe

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:e1886c5c-5e86-48d1-8c77-fc1c28d47180

(12) </wsa:MessageID>

(13) <wsa:ReplyTo>

(14) <wsa:Address>http://www.example.com/MyEvEntsink</wsa:Address>

(15) <wsa:ReferenceParameters>

(16) <ew:MySubscription>2597</ew:MySubscription>

(17) </wsa:ReferenceParameters>

(18) </wsa:ReplyTo>

(19) <wsa:To>http://www.example.org/oceanwatch/EventSource</wsa:To>

(20) </s12:Header>

(21) <s12:Body>

(22) <wse:Subscribe>

(23) <wse:EndTo>

(24) <wsa:Address>

(25) http://www.example.com/MyEventSink

(26) </wsa:Address>

(27) <wsa:ReferenceParameters>

(28) <ew:MySubscription>2597</ew:MySubscription>

(29) </wsa:ReferenceParameters>

(30) </wse:EndTo>

(31) <wse:Delivery>

(32) <wse:NotifyTo>

(33) <wsa:Address>

(34) http://www.other.example.com/OnStormWarning

(35) </wsa:Address>

(36) <wsa:ReferenceParameters>

(37) <ew:MySubscription>2597</ew:MySubscription>

(38) </wsa:ReferenceParameters>

(39) </wse:NotifyTo>

(40) </wse:Delivery>

(41) <wse:Expires>2004-06-26T21:07:00.000-08:00</wse:Expires>

(42) <wse:Filter xmlns:ow="http://www.example.org/oceanwatch" >

(43) /*/ow:Speed &gt; 50

(44) </wse:Filter>

(45) </wse:Subscribe>

(46) </s12:Body>

(47) </s12:Envelope>

Like the request in Example 2-1, lines (07-09) of Example 4-1 indicate the message is a request to create a subscription. Line (19) indicates that it is sent to a hypothetical event source of ocean events.

Lines (13-18) indicate where to send the response to this request, lines (23-30) indicate where to send a SubscriptionEnd message if necessary, and lines (31-34) indicate how and where to send notifications.

Line (41) indicates the event sink would prefer to have the subscription expire on 26 June 2004 at 9:07 PM Pacific time.

Lines (42-44) indicate the event sink only wants weather reports where the speed of wind is greater than 50.

Example 4-2 lists a hypothetical response to the request in Example 4-1.

Example 4-2: Hypothetical response to second subscribe request

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ew="http://www.example.com/warnings"

(06) xmlns:ow="http://www.example.org/oceanwatch" >

(07) <s12:Header>

(08) <wsa:Action>

(09) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscribeResponse

(10) </wsa:Action>

(11) <wsa:RelatesTo>

(12) uuid:e1886c5c-5e86-48d1-8c77-fc1c28d47180

(13) </wsa:RelatesTo>

(14) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(15) <ew:MySubscription wsa:IsReferenceParameter="true">

(16) 2597

(17) </ew:MySubscription>

(18) </s12:Header>

(19) <s12:Body>

(20) <wse:SubscribeResponse>

(21) <wse:SubscriptionManager>

(22) <wsa:Address>

(23) http://www.example.org/oceanwatch/SubscriptionManager

(24) </wsa:Address>

(25) <wsa:ReferenceParameters>

(26) <x:SubID xmlns:x="http://example.com">

(27) uuid:22e8a584-0d18-4228-b2a8-3716fa2097fa

(28) </x:SubID>

(29) </wsa:ReferenceParameters>

(30) </wse:SubscriptionManager>

(31) <wse:Expires>2004-07-01T00:00:00.000-00:00</wse:Expires>

(32) </wse:SubscribeResponse>

(33) </s12:Body>

(34) </s12:Envelope>

Like the response in Example 2-2, lines (08-10) of Example 4-2 indicate this message is a response to a request to create a subscription, and lines (11-13) indicate that it is a response to the request in Example 4-1 . Lines (14-17) indicate the response is sent to the event sink indicated in lines (13-18) of Example 4-1. Lines (21-30) provide the address of the subscription manager for this subscription; note that this particular response uses the x:SubID element as a reference parameter to distinguish this subscription EPR from other subscription EPRs. Finally, line (31) indicates the subscription will expire on 1 July 2004 unless renewed; there is no requirement that this time be necessarily longer or shorter than the requested expiration (line (41) of Example 4-1).

4.2 Renew

To update, or renew, the expiration for a subscription, a subscriber sends a Renew request message to the subscription manager. This operation MUST be supported by compliant subscription managers. The Renew request message message MUST be of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Renew

[Body]

<wse:Renew ...>

<wse:Expires min="(xs:dateTime | xs:duration)"?

max="(xs:dateTime | xs:duration)"?

exact="xs:boolean"? ...>

(xs:dateTime | xs:duration)

</wse:Expires> ?

xs:any*

</wse:Renew>

Components of the outline listed above are additionally constrained as for a request to create a subscription (see 4.1 Subscribe). Other components of the outline above are not further constrained by this specification.

If the subscription manager chooses not to renew this subscription, the request MUST fail, and the subscription manager MUST generate a SOAP 1.1 Server fault or a SOAP 1.2 Receiver fault indicating that the renewal was not accepted. This fault MAY contain the RetryAfter fault detail element.

If the subscription manager accepts a request to renew a subscription, it MUST reply with a response of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/RenewResponse

[Body]

<wse:RenewResponse ...>

<wse:GrantedExpires ...>

(xs:dateTime | xs:duration)

</wse:GrantedExpires> ?

xs:any*

</wse:RenewResponse>

Components of the outline listed above are constrained as for a response to a subscribe request (see 4.1 Subscribe). Other components of the outline above are not further constrained by this specification.

Example 4-3 lists a hypothetical request to renew the subscription created in Example 4-2.

Example 4-3: Hypothetical request to renew second subscription

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Renew

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:bd88b3df-5db4-4392-9621-aee9160721f6

(12) </wsa:MessageID>

(13) <wsa:ReplyTo>

(14) <wsa:Address>http://www.example.com/MyEventSink</wsa:Address>

(15) </wsa:ReplyTo>

(16) <wsa:To>

(17) http://www.example.org/oceanwatch/SubscriptionManager

(18) </wsa:To>

(19) <x:SubID wsa:IsReferenceParameter="true" xmlns:x="http://example.com">

(20) uuid:22e8a584-0d18-4228-b2a8-3716fa2097fa

(21) </x:SubID>

(22) </s12:Header>

(23) <s12:Body>

(24) <wse:Renew>

(25) <wse:Expires>2004-06-26T21:07:00.000-08:00</wse:Expires>

(26) </wse:Renew>

(27) </s12:Body>

(28) </s12:Envelope>

Lines (07-09) indicate this is a request to renew a subscription. Lines (19-21) contain the reference parameter that indicates the subscription to be renewed is the one created in Example 4-2. Line (25) in Example 4-3 indicates the request is to extend the subscription until 26 June 2004 at 9:07 PM Pacific.

Example 4-4 lists a hypothetical response to the request in Example 4-3.

Example 4-4: Hypothetical response to renew request

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/RenewResponse

(09) </wsa:Action>

(10) <wsa:RelatesTo>

(11) uuid:bd88b3df-5db4-4392-9621-aee9160721f6

(12) </wsa:RelatesTo>

(13) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(14) </s12:Header>

(15) <s12:Body>

(16) <wse:RenewResponse>

(17) <wse:Expires>2004-06-26T12:00:00.000-00:00</wse:Expires>

(18) </wse:RenewResponse>

(19) </s12:Body>

(20) </s12:Envelope>

Line (17) in Example 4-4 indicates the subscription has been extended only until 26 June 2004 at noon.

4.3 GetStatus

To get the status of a subscription, the subscriber sends a GetStatus request message to the subscription manager. This operation MUST be supported by compliant subscription managers. The GetStatus request MUST be of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatus

[Body]

<wse:GetStatus ...>

<wse:Verify ...>

xs:any*

</wse:Verify> ?

xs:any*

</wse:GetStatus>

The following describes additional, normative constraints on the outline listed above:

[Body]/wse:GetStatus/wse:Verify

This OPTIONAL element can be used by the subscriber in its GetStatus request to ask the subscription manager to verify that notifications can be transmitted from the event source to the event sink.A subscriber can attempt to verify the ability of the event source to successfully transmit Notifications to the event sink by including this OPTIONAL element in the GetStatus request. Conformant subscription managers MAY elect not to perform the requested verification.

If the subscription manager opts to support the wse:Verify request, it MUST include a wse:VerificationInitiated element in its GetStatus response, and it MUST cause the event source to transmit a single verification event notification, defined in Appendix B, from the event source to the event sinkIf the subscription is active and the request for verification is honored, the event source MUST attempt to transmit a notification of the “verification event” (see Appendix B) to the event sink using the delivery method and format in effect for this subscription. Any filters in effect for the subscription MUST NOT be applied to this notification.

Components of the outline listed above are additionally constrained as for a request to renew a subscription (see 4.2 Renew). Other components of the outline above are not further constrained by this specification.

If the subscription is active, the subscription manager MUST reply with a response of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatusResponse

[Body]

<wse:GetStatusResponse ...>

<wse:GrantedExpires ...>

(xs:dateTime | xs:duration)

</wse:GrantedExpires> ?

<VerificationInitiated ...>

xs:any*

</VerificationInitiated> ?

xs:any*

</wse:GetStatusResponse>

The following describes additional, normative constraints on the outline listed above:

[Body]/wse:GetStatusResponse/wse:GrantedExpires

[As per Renew]

[Body]/wse:GetStatusResponse/wse:VerificationInitiated

If a subscriber attempted to verify the ability of the event source to successfully transmit Notifications to the event sink by including the wse:Verify element in the corresponding GetStatus request, the presence of this element in the GetStatusResponse indicates that the subscription manager has honored this request and initiated the notification of the verification event. This element MUST NOT appear in the GetStatusResponse unless the corresponding GetStatus request contained the wse:Verify element. The absence of this element in a GetStatusResponse indicates that no verification notification was not initiated.

Note, the relative timing of the verification and the GetStatusResponse message is unconstrained by this specification. The presence of the wse:VerificationInitiated element in a GetStatusResponse message does not indicate the success of the verification

Example 4-5 lists a hypothetical request to get the status of the subscription created in Example 4-2.

Example 4-5: Hypothetical request to get the status of the second subscription

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatus

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:bd88b3df-5db4-4392-9621-aee9160721f6

(12) </wsa:MessageID>

(13) <wsa:ReplyTo>

(14) <wsa:Address>http://www.example.com/MyEventSink</wsa:Address>

(15) </wsa:ReplyTo>

(16) <wsa:To>

(17) http://www.example.org/oceanwatch/SubscriptionManager

(18) </wsa:To>

(19) <x:SubID wsa:IsReferenceParameter="true" xmlns:x="http://example.com">

(20) uuid:22e8a584-0d18-4228-b2a8-3716fa2097fa

(21) </x:SubID>

(22) </s12:Header>

(23) <s12:Body>

(24) <wse:GetStatus />

(25) </s12:Body>

(26) </s12:Envelope>

Lines (07-09) indicate this is a request to get the status of a subscription. Lines (16-21) indicate that the request is sent to the subscription manager for the subscription created in Example 4-2.

Example 4-6 lists a hypothetical response to the request in Example 4-5.

Example 4-6: Hypothetical response to get status request

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatusResponse

(09) </wsa:Action>

(10) <wsa:RelatesTo>

(11) uuid:bd88b3df-5db4-4392-9621-aee9160721f6

(12) </wsa:RelatesTo>

(13) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(14) </s12:Header>

(15) <s12:Body>

(16) <wse:GetStatusResponse>

(17) <wse:Expires>2004-06-26T12:00:00.000-00:00</wse:Expires>

(18) </wse:GetStatusResponse>

(19) </s12:Body>

(20) </s12:Envelope>

Line (17) in Example 4-6 indicates the subscription will expire on 26 June 2004 at noon.

4.5 Unsubscribe

Though subscriptions expire eventually, to minimize resources, the subscriber SHOULD explicitly delete a subscription when it no longer wants notifications associated with the subscription.

To explicitly delete a subscription, a subscriber sends an Unsubscribe request message to the subscription manager. This operation MUST be supported by compliant subscription managers. The Unsubscribe request message MUST be of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Unsubscribe

[Body]

<wse:Unsubscribe ...>

xs:any*

</wse:Unsubscribe>

Components of the outline above are additionally constrained only as for a request to renew a subscription (see 4.2 Renew). For example, the faults listed there are also defined for a request to delete a subscription.

If the subscription manager accepts a request to delete a subscription, it MUST reply with a response of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/UnsubscribeResponse

[Body]

<wse:UnsubscribeResponse ...>

xs:any*

</wse:UnsubscribeResponse>

Components of the outline listed above are not further constrained by this specification.

Example 4-7 lists a hypothetical request to delete the subscription created in Example 4-2.

Example 4-7: Hypothetical unsubscribe request to delete second subscription

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Unsubscribe

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:2653f89f-25bc-4c2a-a7c4-620504f6b216

(12) </wsa:MessageID>

(13) <wsa:ReplyTo>

(14) <wsa:Address>http://www.example.com/MyEventSink</wsa:Address>

(15) </wsa:ReplyTo>

(16) <wsa:To>

(17) http://www.example.org/oceanwatch/SubscriptionManager

(18) </wsa:To>

(19) <x:SubID wsa:IsReferenceParameter="true" xmlns:x="http://example.com">

(20) uuid:22e8a584-0d18-4228-b2a8-3716fa2097fa

(21) </x:SubID>

(22) </s12:Header>

(23) <s12:Body>

(24) <wse:Unsubscribe />

(25) </s12:Body>

(26) </s12:Envelope>

Lines (07-09) in Example 4-7 indicate the message is a request to delete a subscription. Lines (16-21) indicate that the request is addressed to the manager for the subscription created in Example 4-2.

Example 4-8 lists a hypothetical response to the request in Example 4-7.

Example 4-8: Hypothetical response to unsubscribe request

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing" >

(04) <s12:Header>

(05) <wsa:Action>

(06) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/UnsubscribeResponse

(07) </wsa:Action>

(08) <wsa:RelatesTo>

(09) uuid:2653f89f-25bc-4c2a-a7c4-620504f6b216

(10) </wsa:RelatesTo>

(11) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(12) </s12:Header>

(13) <s12:Body>

(14) <wse:UnsubscribeResponse/>

(15) </s12:Body>

(16) </s12:Envelope>

4.5 SubscriptionEnd

If the event source terminates a subscription unexpectedly, and it supports the use of the EndTo EPR, and the EndTo EPR was present in the Subscribe message for that subscription (see 4.1 Subscribe), the SubscriptionEnd message MUST be sent to the endpoint reference indicated by that EPR, if possible.

Note, a subscription expiring as expected is not considered to be an unexpected termination, therefore a SubscriptionEnd message MUST NOT be sent in this case.

The message MUST be of the following form:

[Action]

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscriptionEnd

[Body]

<wse:SubscriptionEnd ...>

<wse:Status>

( http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFailure |

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceShuttingDown |

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceCancelling |

xs:anyURI )

</wse:Status>

<wse:Reason xml:lang="language identifier" >xs:string</wse:Reason> ?

xs:any*

</wse:SubscriptionEnd>

The following describes additional, normative constraints on the outline listed above:

[Body]/wse:SubscriptionEnd/wse:Status = "http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFailure"

This value MUST be used if the event source terminated the subscription because of problems delivering notifications.

[Body]/wse:SubscriptionEnd/wse:Status = "http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceShuttingDown"

This value MUST be used if the event source terminated the subscription because the source is being shut down in a controlled manner; that is, if the event source is being shut down but has the opportunity to send a SubscriptionEnd message before it exits.

[Body]/wse:SubscriptionEnd/wse:Status = "http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceCancelling"

This value MUST be used if the event source terminated the subscription for some other reason before it expired.

[Body]/wse:SubscriptionEnd/wse:Reason

This OPTIONAL element contains text, in the language specified by the @xml:lang attribute, describing the reason for the unexpected subscription termination.

Other components of the outline above are not further constrained by this specification.

Example 4-9 lists a hypothetical SubscriptionEnd message corresponding to an early termination of the subscription created in Example 4-1.

Example 4-9: Hypothetical subscription end message

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:wse="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(05) xmlns:ew="http://www.example.com/warnings" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscriptionEnd

(09) </wsa:Action>

(10) <wsa:To>http://www.example.com/MyEventSink</wsa:To>

(11) <ew:MySubscription wsa:IsReferenceParameter="true">

(12) 2597

(13) </ew:MySubscription>

(14) </s12:Header>

(15) <s12:Body>

(16) <wse:SubscriptionEnd>

(17) <wse:Status>wse:SourceShuttingDown</wse:Status>

(18) <wse:Reason xml:lang="en-US" >

(19) Event source going off line.

(20) </wse:Reason>

(21) </wse:SubscriptionEnd>

(22) </s12:Body>

(23) </s12:Envelope>

Line (08) is the action IRI for SubscriptionEnd. Lines (10-13) indicate the message is sent to the EndTo of the subscribe request (lines (23-30) in Example 4-1). Line (17) indicates the event source is shutting down, and lines (18-20) indicate that the event source was going off line.

5 Notifications

Notifications are SOAP messages that are transmitted to the event sink as the result of a successful Subscribe operation.

Example 5-1 lists a hypothetical notification message sent as part of the subscription created by the subscribe request in Example 4-1.

Example 5-1: Hypothetical notification message

(01) <s12:Envelope

(02) xmlns:s12="http://www.w3.org/2003/05/soap-envelope"

(03) xmlns:wsa="http://www.w3.org/2005/08/addressing"

(04) xmlns:ew="http://www.example.com/warnings"

(05) xmlns:ow="http://www.example.org/oceanwatch" >

(06) <s12:Header>

(07) <wsa:Action>

(08) http://www.example.org/oceanwatch/2003/WindReport

(09) </wsa:Action>

(10) <wsa:MessageID>

(11) uuid:568b4ff2-5bc1-4512-957c-0fa545fd8d7f

(12) </wsa:MessageID>

(13) <wsa:To>http://www.other.example.com/OnStormWarning</wsa:To>

(14) <ew:MySubscription wsa:IsReferenceParameter="true">

(15) 2597

(16) </ew:MySubscription>

(17) </s12:Header>

(18) <s12:Body>

(19) <ow:WindReport>

(20) <ow:Date>030701</ow:Date>

(21) <ow:Time>0041</ow:Time>

(22) <ow:Speed>65</ow:Speed>

(23) <ow:Location>BRADENTON BEACH</ow:Location>

(24) <ow:County>MANATEE</ow:County>

(25) <ow:State>FL</ow:State>

(26) <ow:Lat>27.46</ow:Lat>

(27) <ow:Long>82.70</ow:Long>

(28) <ow:Comments xml:lang="en-US" >

(29) WINDS 55 WITH GUSTS TO 65. ROOF TORN OFF BOAT HOUSE. REPORTED

(30) BY STORM SPOTTER. (TBW)

(31) </ow:Comments>

(32) </ow:WindReport>

(33) </s12:Body>

(34) </s12:Envelope>

Lines (13-16) indicate the message is sent to the endpoint indicated by the subscribe request (lines (32-39) in Example 4-1). Line (22) matches the filter in the subscribe request (lines (42-44) in Example 4-1).

6 Faults

All fault messages defined in this specification MUST be sent according to the rules and usage described in [WS-Addressing 1.0 SOAP Binding] Section 6 for encoding SOAP 1.1 and SOAP 1.2 faults. The [Action] property below MUST be used for faults defined in this specification:

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/fault

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:

SOAP Version	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> [Action] </wsa:Action>

<!-- Headers elided for brevity. -->

</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>

6.1 Fault Detail RetryAfter Element

The following element MAY be used to convey additional information in the detail element of a fault.

/wse:RetryAfter

This element (whose content is of type xs:unsignedLong) is a suggested minimum duration in milliseconds to wait before retransmitting the message. Omission of this element indicates that a retry is never likely to succeed.

6.2 InvalidExpirationTime

This fault MUST be generated when a request specifies an expiration that is malformed.

[Code]	s12:Sender
[Subcode]	wse:InvalidExpirationTime
[Reason]	The expiration time requested is invalid.
[Detail]	none

6.3 ExpirationTimeExceeded

This fault MUST be generated when a request specifies an expiration that is not within the min/max range.

[Code]	s12:Sender
[Subcode]	wse:ExpirationTimeExceeded
[Reason]	The expiration time requested is not within the min/max range.
[Detail]	none

6.4 UnsupportedExpirationType

This fault MUST be generated when a Subscribe request specifies an expiration time and the event source is only capable of accepting expiration durations; for instance, if the event source does not have access to absolute time.

[Code]	s12:Sender
[Subcode]	wse:UnsupportedExpirationType
[Reason]	Only expiration durations are supported.
[Detail]	none

6.5 FilteringNotSupported

This fault MUST be generated when a Subscribe request contains a filter and the event source does not support filtering.

[Code]	s12:Sender
[Subcode]	wse:FilteringNotSupported
[Reason]	Filtering is not supported.
[Detail]	none

6.6 FilteringRequestedUnavailable

This fault MUST be generated when a Subscribe request specifies a filter dialect that the event source does not support. This fault MAY contain a list of supported filter dialect IRIs in the Detail property.

[Code]	s12:Sender
[Subcode]	wse:FilteringRequestedUnavailable
[Reason]	The requested filter dialect is not supported.
[Detail]	<wse:SupportedDialect> + OPTIONAL; one per filter dialect supported by the receiver

6.7 DeliveryFormatRequestUnavailable

This fault MUST be generated when a Subscribe request specifies a delivery format that is not supported by the event source. This fault MAY contain a list of supported delivery format IRIs in the Detail property.

[Code]	s12:Sender
[Subcode]	wse:DeliveryFormatRequestedUnavailable
[Reason]	The requested delivery format is not supported.
[Detail]	<wse:SupportedDeliveryFormat> + OPTIONAL, one per delivery format supported by the receiver.

6.8 EmptyFilter

This fault MUST be generated when an event source detects a wse:Subscribe request containing a filter that, for whatever reason, will never evaluate to true.

[Code]	s12:Sender
[Subcode]	wse:EmptyFilter
[Reason]	The wse:Filter would result in zero notifications.
[Detail]	The wse:Filter value.

6.9 UnusableEPR

This fault MUST be generated when an event source detects that the wse:NotifyTo or wse:EndTo EPR is unusable.

[Code]	s12:Sender
[Subcode]	wse:UnusableEPR
[Reason]	An EPR in the Subscribe request message is unusable.
[Detail]	The specific EPR that generated the error and why.

6.10 UnknownSubscription

This fault MUST be generated when a request specifies a subscription that is not known.

[Code]	s12:Sender
[Subcode]	wse:UnknownSubscription
[Reason]	The subscription is not known.
[Detail]	none

6.11 EndToNotSupported

This fault MUST be generated by an event source that does not support /wse:Subscribe/wse:EndTo semantics, in response to a subscription request that contains a wse:EndTo element.

[Code]	s12:Sender
[Subcode]	wse:EndToNotSupported
[Reason]	wse:EndTo semantics is not supported.
[Detail]	none

7 Security Considerations

This specification considers two sets of security requirements, those of the applications that use the WS-Eventing protocol and those of the protocol itself.

This specification makes no assumptions about the security requirements of the applications that use WS-Eventing. However, once those requirements have been satisfied within a given operational context, the addition of WS-Eventing to this operational context cannot undermine the fulfillment of those requirements; the use of WS-Eventing SHOULD NOT create additional attack vectors within an otherwise secure system.

The material below is not a "check list". There are many other security concerns that need to be considered when implementing or using this protocol. Implementers and users of this protocol are urged to perform a security analysis to determine their particular threat profile and the appropriate responses to those threats.

7.1 Notifications

The information contained in Notifications might be sensitive. In such cases it is advisable to authenticate and authorize subscribers as part of the processing of the Subscribe request. Note that an Event Source may authorize the delivery of Notifications on a per-message basis after the subscription has been created. This might be necessary in cases where the sensitivity of the Notification information is not known at Subscribe time or varies over the lifetime of a subscription.

To protect the Notifications sent over a network, Notifications ought to have the proper authenticity, integrity and confidentiality protections applied.

The ability to subscribe on behalf of a third-party Event Sink could be misused by a malicious Subscriber to create a denial-of-service attack. While it does not remove the ability for such misuse, authenticating Subscribers provides a way to deter and trace the origin of such attempts. Additionally, the authorization of Subscribers reduces the pool of potential attackers.

7.2 Subscriptions

Once created, subscriptions ought to be treated as protected resources. Renew, GetStatus, and Unsubscribe requests ought to be authenticated and authorized (for example, the identity of the requester ought to be checked against the identity of the entity that performed the original Subscribe request). Likewise SubscriptionEnd messages ought to be authenticated and authorized (for example, the identity of the sender ought to be checked against the identity of the entity that sent the original SubscribeResponse message). Note that authentication and authorization policies (i.e. the rules that define which entities are allowed to perform which requests and the mechanisms by which the identities of these entities are discovered and verified) are particular to individual deployments.

7.3 Endpoint Verification

Implementations that perform validity checks on the EPRs used in WS-Eventing (wse:NotifyTo, wse:EndTo) are advised that such checks can be misused to obtain information about a target network. For example, suppose an Event Source implementation verifies the address of NotifyTo EPRs by attempting to create a connection to the EPR's address and faulting the Subscribe request if a connection cannot be created. When deployed within a DMZ, such an Event Source could be exploited by a malicious Subscriber to probe for other, non-visible hosts by guessing target addresses and using them in Subscribe requests. Note that, even if the returned fault does not provide connection information, the time the Event Source spends processing the Subscribe request might reveal if there is a host with the target address.

Implementations that perform validity checks on the EPRs used in WS-Eventing are advised to provide a means to disable such checks in environments where these types of attacks are an issue.

8 Implementation Considerations

Event sinks SHOULD be prepared to receive notifications after sending a subscribe request but before receiving a subscribe response message. Event sinks SHOULD also be prepared to receive notifications after receiving an unsubscribe response message.

9 WS-Eventing Metadata

An endpoint MAY indicate its support of WS-Eventing, or its features, by including the WS-Eventing EventSource or SubscriptionManager Policy assertions within its WSDL. By doing so the endpoint is indicating that the corresponding WS-Eventing operations are supported by that endpoint even though they are implicit and do not explicitly appear in its WSDL (ie. the WS-Eventing operations do not appear in the WSDL that MAY be retrievable by using WS-MetadataExchange GetWSDL to that endpoint).

The WS-Eventing WSDL containing the operations indicated by the EventSource or SubscriptionManager assertions MAY be exposed by including the WSDL as a child of the appropriate Policy assertion or by including a reference to it using the mex:Location or mex:Reference element ( as described in WS-MetadataExchange [WS-MetadataExchange] Section 9).

This WS-Eventing WSDL can be annotated to indicate any endpoint specific metadata that might be needed by clients interacting with the WS-Eventing operations. For example, the WSDL MAY have policy assertions that indicate a particular security mechanism used to protect the WS-Eventing operations supported by this endpoint.

9.1 EventSource Assertion

Services indicate support for the WS-Eventing's definition of an event source through the use of the Web Services Policy - Framework [WS-Policy] and Web Services Policy - Attachment [WS-Policy Attachment] specifications.

This specification defines a policy assertion (wse:EventSource). The normative outline of this assertion is:

<wse:EventSource ...>

<wse:DateTimeSupported .../> ?

<wse:FilterDialect URI="xs:anyURI" ...>

xs:any*

</wse:FilterDialect> *

<wse:MaxExpires ...> xs:duration </wse:MaxExpires> ?

<wse:FormatName URI="xs:anyURI" ...>

<!-- Notification WSDL can go here - see A Advertising Event Information -->

xs:any*

</wse:FormatName> *

<wse:EndToSupported .../> ?

<wse:NotificationPolicy ...>

xs:any

</wse:NotificationPolicy> ?

<!-- EventDescription data can go here - see A Advertising Event Information -->

xs:any*

</wse:EventSource>

The following describes additional, normative constraints on the outline listed above:

/wse:EventSource

This policy assertion has Endpoint Policy Subject. When present in a policy alternative, it indicates that the subject is an event source and the WS-Eventing protocol MUST be used when communicating with this endpoint.

/wse:EventSource/wse:DateTimeSupported

When present, this OPTIONAL parameter indicates support for expiration time expressed as specific time (rather than duration).

/wse:EventSource/wse:FilterDialect

When present, this OPTIONAL parameter indicates support for the specified filter dialect IRI.

/wse:EventSource/wse:FilterDialect/xs:any

This extensibility point allows for additional FilterDialect specific metadata to be included within the policy assertion. Any metadata that appears is scoped to the use of the specified FilterDialect URI.

/wse:EventSource/wse:MaxExpires

When present, this OPTIONAL parameter indicates the maximum subscription expiration time that this endpoint will support. The implied default is indefinite (no expiry). Note: a value of "PT0S" indicates that this endpoint supports subscriptions with an infinite lifetime.

/wse:EventSource/wse:FormatName

When present, this OPTIONAL parameter indicates support for the specified event delivery format name URI.

/wse:EventSource/wse:FormatName/xs:any

This extensibility point allows for additional FormatName specific metadata to be included within the policy assertion. Any metadata that appears is scoped to the use of the specified FormatName URI. If the Event Source advertises Notification WSDL then it MUST appear as a child of the FormatName element.

/wse:EventSource/wse:EndToSupported

When present, this OPTIONAL parameter indicates support for the /wse:Subscribe/wse:EndTo semantics. That is, when a subscription request contains a wse:EndTo element, a SubscriptionEnd message will be sent to the EPR contained in the wse:EndTo element, if the subscription terminates unexpectedly.

/wse:EventSource/wse:NotificationPolicy

When present, this OPTIONAL parameter includes the Endpoint Subject Policy that the event source supports for sending notifications. This element MUST have one child element - typically a wsp:Policy element or a wsp:PolicyReference element. A subscriber can use this information to discover the valid set of Policy Alternatives that MAY be used within a wse:NotifyTo EPR which will be used for any Notification message sent from the event source to the event sink. Any policy alternatives included within this parameter SHOULD be compatible with those Policy Alternatives available from the Notification WSDLs that the event source advertises.

/wse:EventSource/xs:any

This extensibility point allows for additional WS-Eventing specific metadata to be included within the policy assertion - e.g. WS-Eventing WSDL, or nested policy assertions related to the WS-Eventing message exchanges. Any metadata that appears is scoped to the operations and features of the WS-Eventing specification. If the Event Source advertises EventDescription data then it MUST appear as a child of the EventSource element.

Note: The WS-RA WG is interested in Last Call feedback on the use of nested policy expressions.

9.2 SubscriptionManager Assertion

Services indicate support for the WS-Eventing's definition of a subscription manager through the use of the Web Services Policy - Framework [WS-Policy] and Web Services Policy - Attachment [WS-Policy Attachment] specifications.

This specification defines a policy assertion (wse:SubscriptionManager). The normative outline of this assertion is:

<wse:SubscriptionManager ...>

<wse:DateTimeSupported .../> ?

<wse:GetStatusOperationSupported .../> ?

<wse:VerifyOperationSupported .../> ?

<wse:UnsubscribeOperationSupported .../> ?

<wse:MaxExpires ...> xs:duration </wse:MaxExpires> ?

xs:any*

</wse:SubscriptionManager>

The following describes additional, normative constraints on the outline listed above:

/wse:SubscriptionManager

This policy assertion has Endpoint Policy Subject. When present in a policy alternative, it indicates that the subject is an subscription manager and the WS-Eventing protocol MUST be used when communicating with this endpoint.

/wse:SubscriptionManager/wse:DateTimeSupported

When present, this OPTIONAL parameter indicates support for expiration time expressed as specific time (rather than duration).

/wse:SubscriptionManager/wse:GetStatusOperationSupported

When present, this OPTIONAL parameter indicates that the GetStatus operation is supported by this endpoint.

/wse:SubscriptionManager/wse:UnsubscribeOperationSupported

When present, this OPTIONAL parameter indicates that the Unsubscribe operation is supported by this endpoint.

/wse:SubscriptionManager/wse:MaxExpires

When present, this OPTIONAL parameter indicates the maximum subscriptions expiration time that this endpoint will support. The implied default is indefinite (no expiry). Note: a value of "PT0S" indicates that this endpoint supports subscriptions with an infinite lifetime.

/wse:SubscriptionManager/xs:any

This extensibility point allows for additional WS-Eventing specific metadata to be included within the policy assertion - e.g. WS-Eventing WSDL, or nested policy assertions related to the WS-Eventing message exchanges. Any metadata that appears is scoped to the operations and features of the WS-Eventing specification.

Note: The WS-RA WG is interested in Last Call feedback on the use of nested policy expressions.

10 Acknowledgements

This specification has been developed as a result of joint work with many individuals and teams, including: Alessio Soldano (Red Hat), Ashok Malhotra (Oracle Corp.), Asir Vedamuthu (Microsoft Corp.), Bob Freund (Hitachi, Ltd.), Bob Natale (MITRE Corp.), David Snelling (Fujitsu, 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), Martin Chapman (Oracle Corp.), Paul Fremantle (WSO2), Paul Nolan (IBM), Prasad Yendluri (Software AG), Ram Jeyaraman (Microsoft Corp.), Sreedhara Narayanaswamy (CA), Sumeet Vij (Software AG), Tom Rutt (Fujitsu, Ltd.), Vikas Varma (Software AG), Wu Chou (Avaya Communications), Yves Lafon (W3C/ERCIM).

11 References

11.1 Normative References

RFC 2119

Key words for use in RFCs to Indicate Requirement Levels , S. Bradner, Author. Internet Engineering Task Force, March 1997. Available at http://www.ietf.org/rfc/rfc2119.txt

.

RFC 3986

Uniform Resource Identifier (URI): Generic Syntax , T. Berners-Lee, R. Fields and L. Masinter, Authors. Network Working Group, January 2005. Available at http://www.ietf.org/rfc/rfc3986.txt.

RFC 3987

Internationalized Resource Identifiers (IRIs) , M. Duerst and M. Suignard, Authors. Internet Engineering Task Force, January 2005. Available at http://www.ietf.org/rfc/rfc3987.txt.

SOAP11

W3C Note, "Simple Object Access Protocol (SOAP) 1.1" , D. Box, et al, Editors. World Wide Web Consortium (W3C), 8 May 2000. Available at http://www.w3.org/TR/2000/NOTE-SOAP-20000508/.

SOAP12

W3C Recommendation, "SOAP Version 1.2 Part 1: Messaging Framework" , M. Gudgin, M. Hadley, N. Mendelsohn, J-J. Moreau, H. Frystyk Nielson, Editors. World Wide Web Consortium (W3C), 27 April 2007. Available at http://www.w3.org/TR/soap12-part1/.

WS-Addressing

W3C Recommendation, "Web Services Addressing 1.0 (WS-Addressing)" , M. Gudgin, M. Hadley, T. Rogers, Editors. World Wide Web Consortium (W3C), 9 May 2006. Available at http://www.w3.org/TR/ws-addr-core.

WS-Addressing 1.0 SOAP Binding

W3C Recommendation, "Web Services Addressing 1.0 - SOAP Binding" , M. Gudgin, M. Hadley, T. Rogers, Editors. World Wide Web Consortium (W3C), 9 May 2006. Available at http://www.w3.org/TR/ws-addr-soap.

WS-EventDescriptions

W3C Working Group Draft, "Web Services Event Descriptions (WS-EventDescriptions) 1.0" , D. Davis, et al., Editors. World Wide Web Consortium (W3C), 15 September 2009. Available at http://www.w3.org/TR/ws-event-descriptions.

WS-Policy

W3C Recommendation, "Web Services Policy (WS-Policy) 1.5 - Framework" , A. Vedamuthu, et al., Editors. World Wide Web Consortium (W3C), 4 September 2007. Available at http://www.w3.org/TR/ws-policy/.

WS-Policy Attachment

W3C Recommendation, "Web Services Policy (WS-Policy) 1.5 - Attachment" , A. Vedamuthu, et al., Editors. World Wide Web Consortium (W3C), 4 September 2007. Available at http://www.w3.org/TR/ws-policy-attach.

WSDL11

W3C Note, "Web Services Description Language (WSDL) 1.1" , E. Christensen, et al., Editors. World Wide Web Consortium (W3C), 15 March 2001 Available at http://www.w3.org/TR/2001/NOTE-wsdl-20010315.

11.2 Informative References

WS-MakeConnection

OASIS Standard, "Web Services Make Connection (WS-MakeConnection) 1.1" Web Services Make Connection (WS-MakeConnection) , D. Davis, et al., Editors. Organization for the Advancement of Structured Information Standards (OASIS), 2 February 2009. Available at http://docs.oasis-open.org/ws-rx/wsmc/v1.1/wsmc.doc.

WS-MetadataExchange

W3C Working Group Draft, "Web Services Metadata Exchange (WS-MetadataExchange) 1.1" , D. Davis, et al., Editors. World Wide Web Consortium (W3C), 15 September 2009. Available at http://www.w3.org/TR/ws-metadata-exchange.

WS-ReliableMessaging

OASIS Standard, "Web Services Reliable Messaging Protocol (WS-ReliableMessaging) 1.2" , Davis, et al., Editors. Organization for the Advancement of Structured Information Standards (OASIS), 2 February 2009. Available at http://docs.oasis-open.org/ws-rx/wsrm/v1.2/wsrm.doc.

WS-SecureConversation

OASIS Standard, "Web Services Secure Conversation (WS-SecureConversation) 1.4" , A. Nadalin, et al., Editors. Organization for the Advancement of Structured Information Standards (OASIS), 2 February 2009. Available at http://docs.oasis-open.org/ws-sx/ws-secureconversation/v1.4/os/ws-secureconversation-1.4-spec-os.doc.

WS-Security

OASIS Standard, "Web Services Security: SOAP Message Security 1.1" , K. Lawrence, C. Kaler, Editors. Organization for the Advancement of Structured Information Standards (OASIS), 1 February 2006. Available at http://docs.oasis-open.org/wss/v1.1/wss-v1.1-spec-os-SOAPMessageSecurity.pdf.

WS-SecurityPolicy

OASIS Standard, "Web Services Security Policy (WS-SecurityPolicy) 1.3, Version 1.1" , K. Lawrence, C. Kaler, Editors. Organization for the Advancement of Structured Information Standards (OASIS), 2 February 2009. Available at http://docs.oasis-open.org/ws-sx/ws-securitypolicy/v1.3/os/ws-securitypolicy-1.3-spec-os.doc.

WS-Trust

OASIS Standard, "Web Services Trust (WS-Trust) 1.4" , K. Lawrence, C. Kaler, Editors. Organization for the Advancement of Structured Information Standards (OASIS), 2 February 2009. Available at http://docs.oasis-open.org/ws-sx/ws-trust/v1.4/os/ws-trust-1.4-spec-os.doc.

XML Infoset

W3C Recommendation, "XML Information Set (Second Edition)" , J. Cowan, R. Tobin, Editors. World Wide Web Consortium (W3C), 4 February 2004. Available at http://www.w3.org/TR/xml-infoset.

XMLSchema - Part 1

W3C Recommendation, "XML Schema Part 1: Structures (Second Edition)" , H. Thompson, et al., Editors. World Wide Web Consortium (W3C), 28 October 2004. Available at http://www.w3.org/TR/xmlschema-1/.

XMLSchema - Part 2

W3C Recommendation, "XML Schema Part 2: Datatypes (Second Edition)" , P. Biron, A. Malhotra, Editors. World Wide Web Consortium (W3C), 28 October 2004. Available at http://www.w3.org/TR/xmlschema-2/.

XPath1.0

W3C Recommendation, "XML Path Language (XPath) Version 1.0" , J. Clark, S. DeRose, Editors. World Wide Web Consortium (W3C), 16 November 1999. Available at http://www.w3.org/TR/xpath.

A Advertising Event Information

There are many use cases for WS-Eventing in which it is necessary for the subscriber and the event sink to know the structure and contents of the notifications that can result from a successful Subscribe request. For example, a developer might wish to use WSDL-based tools to generate service stubs capable of unmarshalling and dispatching notifications. In addition to this, the effective use of filters (including those in the XPath dialect defined in 4.1 Subscribe as well as other dialects not defined in this specification) requires some knowledge of the schema of the events over which the filter will be applied.

There are many ways in which an event source could describe and advertise the structure of the events for which it will issue notifications. To provide a basic level of interoperability, this specification uses the following two OPTIONAL mechanisms, in A.1 Event Types & Event Descriptions and A.2 Notification WSDLs, for describing and advertising event information. If an implementation of a WS-Eventing event source chooses to describe the structure of its events and advertise this description, it is RECOMMENDED that at least one of these mechanisms be used. Mechanisms other than these MAY be used to describe and advertise the structure of events, but the definition of such mechanisms is out of the scope of this specification.

A.1 Event Types & Event Descriptions

An event source MAY advertise the events that are generated by making available an Event Description document as defined by WS-EventDescriptions [WS-EventDescriptions].

The following is an example of an EventDescriptions element that could serve as a description of the Event Type used in Example 2-1.

Example A-1: EventDescriptions

(01) <wsevd:EventDescriptions

(02) targetNamespace="http://www.example.org/oceanwatch/notifications"

(03) xmlns:wsevd="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(04) xmlns:ow="http://www.example.org/oceanwatch">

(05) <wsevd:types>

(06) <xs:schema targetNamespace="http://www.example.org/oceanwatch">

(07) <xs:include schemaLocation="http://www.example.org/schemas/oceanwatch.xsd"/>

(08) <xs:element name="WindReport" type="ow:WindReportType"/>

(09) </xs:schema>

(10) </wsevd:types>

(11)

(12) <wsevd:eventType name="WindReportEvent"

(13) element="ow:WindReport"

(14) actionURI="http://www.example.org/oceanwatch/2003/WindReport"/>

(15) </wsevd:EventDescriptions>

Lines (12-14) describe an Event Type with a QName of "{http://www.example.org/oceanwatch/notifications}:WindReportEvent". The GED for this Event Type is defined on line (08) as being of type "{http://www.example.org/oceanwatch}:WindReportType".

A.1.1 Retrieving Event Descriptions

Although there are many ways in which an event source can make its EventDescriptions available, this specification RECOMMENDS the use of the mechanisms described in WS-MetadataExchange [WS-MetadataExchange]. In particular, this specification RECOMMENDS that the Event Description metadata be made available through the EventSource Policy assertion. This MAY be done by either embedding the Event Description metadata directly within the assertion, or by including a MetadataExchange reference to the data.

The value of the @Identifier attribute, if present, for this MetadataSection MUST be equal to the value of its wsevd:EventDescriptions/@targetNamespace. An event source MUST NOT have more than one EventDescriptions document.

The following examples show how Event Description metadata might appear within a WS-Eventing EventSource Policy assertion.

Example A-2: Sample Embedded EventDescription Metadata

(01) <wse:EventSource ...>

(02) <wse:FormatName URI="..."/>

(03) <wsevd:EventDescritions ...>

(04) ...

(05) </wsevd:EventDescriptions>

(06) </wse:EventSource>

Example A-2 shows how the Event Description metadata might be embedded directly within a WS-Eventing EventSource Policy assertion.

Example A-3: Sample Reference to EventDescription Metadata

(01) <wse:EventSource ...>

(02) <wse:FormatName URI="..."/>

(03) <mex:Location

(04) Type="evd:EventDescriptions"

(05) URI="http://example.com/EVD_Metadata" />

(06) </wse:EventSource>

Example A-3 shows the same policy assertion from Example A-2 except the embedded Event Description metadata is replaced with a reference to an HTTP resource whose representation is the Event Description metadata. The data can be retrieved via an HTTP GET to the specified URL.

A.1.2 Bindings for Event Descriptions

For any Notification Format it MUST be possible to determine how a given wsevd:eventType will appear on the wire as a notification in a subscription created with that format. The following sections define how wsevd:eventTypes bind to notifications for the two Notification Formats defined in this specification; Unwrapped and Wrapped. Specifications or profiles that define additional Notification Formats MUST define how wsevd:eventTypes bind to the notifications for those formats. In the absence of a mapping for a particular Notification Format, implementations MAY provide a Notification WSDL (see below) that explicitly describes the notification operations.

A.1.2.1 Binding for Unwrapped Notifications

The information about an Event Type contained in the wsevd:eventType element binds to a Unwrapped Notification for that type as follows:

· The [Action] property of the notification has the value of the @actionURI attribute of the wsevd:eventType element corresponding to the type of the event being transmitted.

· The [Body] property of the notification has a single child element. This child element is an instance of the Global Element Declaration referenced by the @element attribute of the wsevd:eventType element corresponding to the type of the event being transmitted. If the @element attribute is absent then the [Body] property has no children.

A.1.2.2 Binding for Wrapped Notifications

The information about an Event Type contained in the eventType element binds to a Wrapped Notification for that type as follows:

· The /soap:Envelope/soap:Body/wse:Notify/@actionURI attribute of the Wrapped Notification has the value of the @actionURI attribute of the eventType element corresponding to the type of the event being transmitted.

· The /soap:Envelope/soap:Body/wse:Notify element has a single child element. This child element is an instance of the Global Element Declaration referenced by the @element attribute of the eventType element corresponding to the type of the event being transmitted. If the @element attribute is absent then the wse:Notify element has no children.

A.2 Notification WSDLs

As described previously, events are transmitted to event sinks as SOAP messages called "Notifications". These notifications MAY be described via a Web Services Description Language [WSDL11] definitions element termed a "Notification WSDL". A Notification WSDL describes the interface that the event sink is REQUIRED to implement to receive and process the notifications that might result from a successful Subscribe request that used a particular Format IRI. The following is an example of a Notification WSDL:

Example A-4: Notification WSDL

(01) <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

(02) targetNamespace="http://www.example.org/oceanwatch/notifications"

(03) xmlns:xs="http://www.w3.org/2001/XMLSchema"

(04) xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"

(05) xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"

(06) xmlns:ow="http://www.example.org/oceanwatch"

(07) xmlns:tns="http://www.example.org/oceanwatch/notifications">

(08) <wsdl:types>

(09) <xs:schema targetNamespace="http://www.example.org/oceanwatch">

(10) <xs:include schemaLocation="http://www.example.org/schemas/oceanwatch.xsd"/>

(11) <xs:element name="WindReport" type="ow:WindReportType">

(12) </xs:schema>

(13) </wsdl:types>

(14)

(15) <wsdl:message name="WindReportNotificationMsg">

(16) <wsdl:part name="event" element="ow:WindReport"/>

(17) </wsdl:message>

(18)

(19) <wsdl:portType name="WindReportPortType">

(20) <wsdl:operation name="WindReportNotificationOp">

(21) <wsdl:input message="tns:WindReportNotificationMsg"

(22) wsam:Action="http://www.example.org/oceanwatch/2003/WindReport"/>

(23) </wsdl:operation>

(24) </wsdl:portType>

(25)

(26) <wsdl:binding name="WindReportBinding" type="tns:WindReportPortType">

(27) <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>

(28) <wsdl:operation name="WindReportNotificationOp">

(29) <soap:operation soapAction=""/>

(30) <wsdl:input>

(31) <soap:body use="literal"/>

(32) </wsdl:input>

(33) </wsdl:operation>

(34) </wsdl:binding>

(35) </wsdl:definitions>

A.2.1 Retrieving Notification WSDLs

Although there are many ways in which an event source can make Notification WSDLs available, this specification RECOMMENDS the use of the mechanisms described in WS-MetadataExchange [WS-MetadataExchange]. In particular, if an event source has Notification WSDL then it SHOULD be referenced from the wse:EventSource policy assertion.

B Verification Event

As described in Section 4.4, the Verify operation tests the ability of the event source to successfully transmit a notification to the event sink. A notification of the “verification pseudo event” is used in this test.

B.1 EventDescription for the Verification Event

The verification event is described by the following EventDescription.

(01) <wsevd:EventDescriptions xmlns:wsevd=”http://www.w3.org/2002/ws/ra/edcopies/ws-evd”

(02) targetNamespace=”http://www.w3.org/2002/ws/ra/edcopies/ws-evt”

(03) xmlns:xs="http://www.w3.org/2001/XMLSchema"

(04) xmlns:wse=”http://www.w3.org/2002/ws/ra/edcopies/ws-evt”>

(05)

(06) <wsevd:types>

(07) <xs:schema targetNamespace="http://www.w3.org/2002/ws/ra/edcopies/ws-evt">

(08) <xs:include schemaLocation="http://www.w3.org/.../eventing.xsd"/>

(09)

(10) <xs:element name="Verification" type="wse:VerificationEventType"/>

(11) </xs:schema>

(12) </wsevd:types>

(13)

(14) <wsevd:eventType name="VerificationEvent"

(15) element="wse:Verification"

(16) actionURI="http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Verfication"/>

(17) </wsevd:EventDescriptions>

B.2 Notification WSDL for the Verification Event

The verification event is described by the following Notification WSDL.

(01) <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"

(02) targetNamespace="http://www.w3.org/2002/ws/ra/edcopies/ws-evt"

(03) xmlns:xs="http://www.w3.org/2001/XMLSchema"

(04) xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata"

(05) xmlns:tns="http://www.w3.org/2002/ws/ra/edcopies/ws-evt">

(06)

(07) <wsdl:types>

(08) <xs:schema targetNamespace="http://www.w3.org/2002/ws/ra/edcopies/ws-evt">

(09) <xs:include schemaLocation="http://www.w3.org/.../eventing.xsd"/>

(10)

(11) <xs:element name="Verification" type="wse:VerificationEventType"/>

(12) </xs:schema>

(13) </wsdl:types>

(14)

(15) <wsdl:message name="VerificationMsg">

(16) <wsdl:part name=”part1” element="wse:Verification">

(17) </wsdl:message>

(18)

(19) <wsdl:portType name="VerificationPortType">

(20) <wsdl:operation name="VerificationOp">

(21) <wsdl:input message="tns:VerificationMsg"

(22) wsam:Action="http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Verfication"/>

(23) </wsdl:operation>

(24) </wsdl:portType>

(25) </wsdl:definitions>

C XML Schema

A normative copy of the XML Schema [XMLSchema - Part 1], [XMLSchema - Part 2] description for this specification can be retrieved from the following address:

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/eventing.xsd

A non-normative copy of the XML schema is listed below for convenience.

<xs:schema

targetNamespace='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

xmlns:tns='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

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='DeliveryType' mixed='true'>

<xs:sequence>

<xs:element ref='tns:NotifyTo' minOccurs='0' maxOccurs='1' />

<xs:any namespace='##other' processContents='lax'

minOccurs='0' maxOccurs='unbounded' />

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

<xs:complexType name='FormatType' mixed='true'>

<xs:sequence>

<xs:any namespace='##any' processContents='lax'

minOccurs='0' maxOccurs='unbounded' />

</xs:sequence>

<xs:attribute name='Name' type='xs:anyURI' use='optional'

default='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFormats/Unwrap' />

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

<xs:simpleType name='NonNegativeDurationType'>

<xs:restriction base='xs:duration'>

<xs:minInclusive value='P0Y0M0DT0H0M0S' />

</xs:restriction>

</xs:simpleType>

<xs:simpleType name='DurationDateTime'>

<xs:union memberTypes='xs:dateTime tns:NonNegativeDurationType' />

</xs:simpleType>

<xs:complexType name='MiniExpirationType'>

<xs:simpleContent>

<xs:extension base='tns:DurationDateTime'>

<xs:anyAttribute namespace='##other' processContents='lax'/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

<xs:complexType name='ExpirationType'>

<xs:simpleContent>

<xs:extension base='tns:MiniExpirationType'>

<xs:attribute name='min' type='tns:DurationDateTime' use='optional'/>

<xs:attribute name='max' type='tns:DurationDateTime' use='optional'/>

<xs:attribute name='exact' type='xs:boolean' use='optional'/>

<xs:anyAttribute namespace='##other' processContents='lax'/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

<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' use='optional'

default='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Dialects/XPath10' />

<xs:anyAttribute namespace='##other' processContents='lax' />

</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>

<xs:element name='NotifyTo' type='wsa:EndpointReferenceType' />

<xs:complexType name='NotificationPolicy'>

<xs:sequence>

<xs:any namespace='##other' processContents='lax'

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>

<!-- Subscribe request -->

<xs:element name='Subscribe'>

<xs:complexType>

<xs:sequence>

<xs:element name='EndTo' type='wsa:EndpointReferenceType'

minOccurs='0' />

<xs:element name='Delivery' type='tns:DeliveryType' />

<xs:element name='Format' type='tns:FormatType'

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>

<!-- Subscribe response -->

<xs:element name='SubscribeResponse'>

<xs:complexType>

<xs:sequence>

<xs:element name='SubscriptionManager'

type='wsa:EndpointReferenceType' />

<xs:element name='GrantedExpires' type='tns:MiniExpirationType' />

<xs:any namespace='##other' processContents='lax'

minOccurs='0' maxOccurs='unbounded' />

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

<!-- Used in a fault if there's an unsupported dialect -->

<xs:element name='SupportedDialect' type='xs:anyURI' />

<!-- Used in a fault if there's an unsupported format name -->

<xs:element name='SupportedDeliveryFormat' type='xs:anyURI' />

<!-- Renew request -->

<xs:element name='Renew'>

<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>

<!-- Renew response -->

<xs:element name='RenewResponse'>

<xs:complexType>

<xs:sequence>

<xs:element name='GrantedExpires' type='tns:MiniExpirationType'

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=”Verify” minOccurs=”0”>

<xs:complexType>

<xs:sequence>

<xs:any namespace='##other' processContents='lax'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

<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='GrantedExpires' type='tns:MiniExpirationType'

minOccurs='0' />

<xs:element name=”VerifyInitiated” minOccurs=”0”>

<xs:complexType>

<xs:sequence>

<xs:any namespace='##other' processContents='lax'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

<xs:any namespace='##other' processContents='lax'

minOccurs='0' maxOccurs='unbounded' />

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

<!-- Verification Event type -->

<xs:complexType name='VerificationEventType'>

<xs:sequence>

<xs:any namespace='##other' processContents='lax'

maxOccurs='unbounded'/> </xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

<!-- Unsubscribe request -->

<xs:element name='Unsubscribe'>

<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>

<!-- Unsubscribe response -->

<xs:element name='UnsubscribeResponse'>

<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>

<!-- SubscriptionEnd message -->

<xs:element name='SubscriptionEnd'>

<xs:complexType>

<xs:sequence>

<xs:element name='Status'

type='tns:OpenSubscriptionEndCodeType' />

<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='SubscriptionEndCodeType'>

<xs:restriction base='xs:anyURI'>

<xs:enumeration value=

'http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFailure' />

<xs:enumeration value=

'http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceShuttingDown' />

<xs:enumeration value=

'http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SourceCancelling' />

</xs:restriction>

</xs:simpleType>

<xs:simpleType name='OpenSubscriptionEndCodeType'>

<xs:union memberTypes='tns:SubscriptionEndCodeType xs:anyURI' />

</xs:simpleType>

<!-- RetryAfter Fault Detail Element -->

<xs:element name='RetryAfter' type='tns:RetryAfterType'/>

<xs:complexType name='RetryAfterType'>

<xs:simpleContent>

<xs:extension base='xs:nonNegativeInteger'>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:extension>

</xs:simpleContent>

</xs:complexType>

<!-- Wrapped Events -->

<xs:complexType name='EventType' mixed='true'>

<xs:sequence>

<xs:any namespace='##any' processContents='lax' minOccurs='0'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:attribute name='actionURI' type='xs:anyURI' use='optional' />

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

<xs:element name='Notify' type='tns:EventType' />

<!-- Policy -->

<xs:complexType name='Duration'>

<xs:simpleContent>

<xs:extension base='tns:NonNegativeDurationType'>

<xs:anyAttribute namespace='##other' processContents='lax'/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

<xs:complexType name='URI'>

<xs:simpleContent>

<xs:extension base='xs:anyURI'>

<xs:anyAttribute namespace='##other' processContents='lax'/>

</xs:extension>

</xs:simpleContent>

</xs:complexType>

<xs:complexType name='Empty'>

<xs:sequence/>

<xs:anyAttribute namespace='##other' processContents='lax'/>

</xs:complexType>

<xs:element name='EventSource'>

<xs:complexType>

<xs:sequence>

<xs:element name='DateTimeSupported' type='tns:Empty' minOccurs='0'/>

<xs:element name='FilterDialect' minOccurs='0' maxOccurs='unbounded'>

<xs:complexType>

<xs:sequence>

<xs:any namespace='##other' processContents='lax' minOccurs='0'

maxOccurs='0'/>

</xs:sequence>

<xs:attribute name='URI' type='xs:anyURI' use='required' />

<xs:anyAttribute namespace="##other" processContents='lax'/>

</xs:complexType>

</xs:element>

<xs:element name='MaxExpires' type='tns:Duration' minOccurs='0'/>

<xs:element name='FormatName' minOccurs='0' maxOccurs='unbounded'>

<xs:complexType>

<xs:sequence>

<xs:any namespace='##other' processContents='lax' minOccurs='0'

maxOccurs='0'/>

</xs:sequence>

<xs:attribute name='URI' type='xs:anyURI' use='required' />

<xs:anyAttribute namespace="##other" processContents='lax'/>

</xs:complexType>

</xs:element>

<xs:element name='EndToSupported' type='tns:Empty' minOccurs='0'/>

<xs:element name='NotificationPolicy' type='tns:NotificationPolicy'

minOccurs='0'/>

<xs:any namespace='##other' processContents='lax' minOccurs='0'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

<xs:element name='SubscriptionManager'>

<xs:complexType>

<xs:sequence>

<xs:element name='DateTimeSupported' type='tns:Empty' minOccurs='0'/>

<xs:element name='GetStatusOperationSupported' type='tns:Empty'

minOccurs='0'/>

<xs:element name='UnsubscribeOperationSupported' type='tns:Empty'

minOccurs='0'/>

<xs:element name='MaxExpires' type='tns:Duration' minOccurs='0'/>

<xs:any namespace='##other' processContents='lax' minOccurs='0'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

</xs:element>

</xs:schema>

C WSDL

A normative copy of the WSDL [WSDL11] description can be retrieved from the following address:

http://www.w3.org/2002/ws/ra/edcopies/ws-evt/eventing.wsdl

A non-normative copy of the WSDL description is listed below for convenience.

<wsdl:definitions

targetNamespace='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

xmlns:wsa='http://www.w3.org/2005/08/addressing'

xmlns:wsam='http://www.w3.org/2007/05/addressing/metadata'

xmlns:wse='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

xmlns:wsdl='http://schemas.xmlsoap.org/wsdl/'

xmlns:xs='http://www.w3.org/2001/XMLSchema' >

<wsdl:types>

<xs:schema>

<xs:import

namespace='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

schemaLocation=

'http://www.w3.org/2002/ws/ra/edcopies/ws-evt/eventing.xsd' />

</xs:schema>

</wsdl:types>

<wsdl:message name='SubscribeMsg' >

<wsdl:part name='body' element='wse:Subscribe' />

</wsdl:message>

<wsdl:message name='SubscribeResponseMsg' >

<wsdl:part name='body' element='wse:SubscribeResponse' />

</wsdl:message>

<wsdl:message name='RenewMsg' >

<wsdl:part name='body' element='wse:Renew' />

</wsdl:message>

<wsdl:message name='RenewResponseMsg' >

<wsdl:part name='body' element='wse:RenewResponse' />

</wsdl:message>

<wsdl:message name='GetStatusMsg' >

<wsdl:part name='body' element='wse:GetStatus' />

</wsdl:message>

<wsdl:message name='GetStatusResponseMsg' >

<wsdl:part name='body' element='wse:GetStatusResponse' />

</wsdl:message>

<wsdl:message name='UnsubscribeMsg' >

<wsdl:part name='body' element='wse:Unsubscribe' />

</wsdl:message>

<wsdl:message name='UnsubscribeResponseMsg' >

<wsdl:part name='body' element='wse:UnsubscribeResponse' />

</wsdl:message>

<wsdl:message name='SubscriptionEnd' >

<wsdl:part name='body' element='wse:SubscriptionEnd' />

</wsdl:message>

<wsdl:message name='notifyEvent'>

<wsdl:part name='parameter' element='wse:Notify'/>

</wsdl:message>

<wsdl:portType name='EventSource' >

<wsdl:operation name='SubscribeOp' >

<wsdl:input

message='wse:SubscribeMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Subscribe'/>

<wsdl:output

message='wse:SubscribeResponseMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscribeResponse'/>

</wsdl:operation>

</wsdl:portType>

<wsdl:portType name='SubscriptionEndPortType' >

<wsdl:operation name='SubscriptionEnd' >

<wsdl:input

message='wse:SubscriptionEnd'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/SubscriptionEnd'/>

</wsdl:operation>

</wsdl:portType>

<wsdl:portType name='SubscriptionManager' >

<wsdl:operation name='RenewOp' >

<wsdl:input

message='wse:RenewMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Renew'/>

<wsdl:output

message='wse:RenewResponseMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/RenewResponse'/>

</wsdl:operation>

<wsdl:operation name='GetStatusOp' >

<wsdl:input

message='wse:GetStatusMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatus'/>

<wsdl:output

message='wse:GetStatusResponseMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/GetStatusResponse'/>

</wsdl:operation>

<wsdl:operation name='UnsubscribeOp' >

<wsdl:input

message='wse:UnsubscribeMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/Unsubscribe'/>

<wsdl:output

message='wse:UnsubscribeResponseMsg'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/UnsubscribeResponse'/>

</wsdl:operation>

</wsdl:portType>

<wsdl:portType name='WrappedSinkPortType'>

<wsdl:operation name='NotifyEvent'>

<wsdl:input message='wse:notifyEvent' name='NotifyEvent'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/WrappedSinkPortType/NotifyEvent'/>

</wsdl:operation>

</wsdl:portType>

</wsdl:definitions>

D WSDL for Standard Wrapped Delivery

If an event subscriber specifies the wrapped event delivery format http://www.w3.org/2002/ws/ra/edcopies/ws-evt/DeliveryFormats/Wrap in the Subscribe request message, then the event sink MUST implement the following abstract WSDL and notification messages MUST be wrapped in the element defined in the WSDL.

<definitions

xmlns='http://schemas.xmlsoap.org/wsdl/'

xmlns:xs='http://www.w3.org/2001/XMLSchema'

xmlns:wsam='http://www.w3.org/2007/05/addressing/metadata'

xmlns:wsa='http://www.w3.org/2005/08/addressing/'

xmlns:tns='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'

targetNamespace='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'>

<types>

<xs:schema

targetNamespace='http://www.w3.org/2002/ws/ra/edcopies/ws-evt'>

<xs:complexType name='EventType' mixed='true'>

<xs:sequence>

<xs:any namespace='##any' processContents='lax' minOccurs='0'

maxOccurs='unbounded'/>

</xs:sequence>

<xs:attribute name='actionURI' type='xs:anyURI' use='optional' />

<xs:anyAttribute namespace='##other' processContents='lax' />

</xs:complexType>

<xs:element name='Notify' type='tns:EventType' />

</xs:schema>

</types>

<message name='notifyEvent'>

<part name='parameter' element='tns:Notify'/>

</message>

<portType name='WrappedSinkPortType'>

<operation name='NotifyEvent'>

<input message='tns:notifyEvent' name='NotifyEvent'

wsam:Action='http://www.w3.org/2002/ws/ra/edcopies/ws-evt/WrappedSinkPortType/NotifyEvent'/>

</operation>

</portType>

</definitions>

E Action Tables

Note: The WS-RA WG is interested in Last Call feedback on the action tables

Note: This table needs to be updated to reflect the effects of Verify

The purpose of the action tables is to illustrate, via a separate means from the normative text, the allowable order and interactions of various messages and activities. The action tables are not intended to constrain implementations beyond those necessary to insure this ordering.

· Actions are represented as columns.

· Triggers (messages, application actions, timer events) are represented as rows. Triggers are annotated by their type; "[app]" - represents an application action (e.g. a user selecting a "Subscribe" menu item); "[msg]" - represents an incoming, WS-Eventing defined, message; "[timer]" - represents an internal timer event.

· Each cell describes the appropriate action for a given state and trigger. Where the action is dependent upon other factors than the state and trigger (e.g. the value of a fault message), the activity is described in pseudo-code. The section of the specification that describes these activities is displayed in curly brackets (e.g. "{4.2}").

· Empty box indicates that the spec is silent for the specified trigger/action pair.

Table E-1: Event Source Action Table
Trigger	Action
Subscribe Request [msg]	Create subscription Send SubscribeResponse + Subscription Manager EPR {4.1}
Event [app]	Send notification to all pertinent subscriptions {5}

Table E-2: Subscription Manager Action Table
Trigger	Action
	Trigger refers to a valid subscription	Trigger refers to an invalid subscription
Renew Request [msg]	Update expiration timer Send RenewResponse {4.2}	Generate UnknownSubscription Fault {4.2}
GetStatus Request [msg]	Send GetStatusResponse {4.3}	Generate UnknownSubscription Fault {4.3}
Unsubscribe Request [msg]	Send UnsubscribeResponse {4.4}	Generate UnknownSubscription Fault {4.4}
Expiration [timer]	If (EndTo engaged)   Send SubscriptionEnd Invalidate subscription {4.1}
Shutdown/Error [app]	If (EndTo engaged)   Send SubscriptionEnd Invalidate subscription {4.1}

Table E-3: Event Sink Action Table
Trigger	Action
Expiration [timer]	Invalidate subscription {4.1}
SubscriptionEnd [msg]	Invalidate subscription {4.5}

F Change Log

Data	Author	Description
2009/03/04	DD	Added resolution of issue 6391
2009/03/04	DD	Added resolution of issue 6519
2009/03/04	DD	Added resolution of issue 6427
2009/03/04	DD	Added resolution of issue 6459
2009/03/09	DD	Added resolution of issue 6397
2009/03/09	DD	Added resolution of issue 6426
2009/03/11	DD	Added change log
2009/03/11	DD	Added resolution of issue 6641
2009/03/11	DD	Added resolution of issue 6498
2009/03/11	DD	Added resolution of issue 6425
2009/03/16	KW	Added resolution of issue 6587
2009/03/17	KW	Added resolution of issue 6400
2009/03/17	DD	Added resolution of issue 6428
2009/03/17	DD	Added resolution of issue 6687
2009/03/23	DD	Added resolution of issue 6666
2009/03/23	DD	Added resolution of issue 6681
2009/03/24	DD	Added resolution of issue 6595
2009/03/24	DD	Added resolution of issue 6648
2009/04/07	DD	Added resolution of issue 6727
2009/04/07	DD	Added resolution of issue 6725
2009/04/07	DD	Added resolution of issue 6715
2009/04/22	KW	Added resolution of issue 6739
2009/04/28	DD	Added resolution of issue 6787
2009/04/28	DD	Added resolution of issue 6788
2009/05/13	KW	Added resolution of issue 6472
2009/05/13	DD	Added resolution of issue 6850
2009/05/13	DD	Added resolution of issue 6696
2009/05/19	DD	Added resolution of issue 6907
2009/05/19	DD	Added resolution of issue 6429
2009/05/21	DD	Added resolution of issue 6674
2009/05/27	DD	Added resolution of issue 6906
2009/06/04	DD	Added resolution of issue 6955
2009/06/04	DD	Added resolution of issue 6916
2009/06/04	DD	Added resolution of issue 6986
2009/07/07	DD	Added resolution of issue 7039
2009/07/21	DD	Added resolution of issue 6980
2009/07/28	DD	Added resolution of issue 6692
2009/08/04	DD	Added resolution of issue 7136
2009/08/05	DD	Added resolution of issue 6432
2009/08/05	DD	Added resolution of issue 7159
2009/08/05	DD	Added resolution of issue 7205
2009/08/18	DD	Added resolution of issue 7206
2009/08/25	DD	Added resolution of issue 7365
2009/08/25	DD	Added resolution of issue 7270
2009/08/25	DD	Added resolution of issue 7235
2009/08/26	DD	Added resolution of issue 7160
2009/09/01	DD	Added resolution of issue 6700
2009/09/02	DD	Added resolution of issue 6694
2009/09/02	DD	Added resolution of issue 6401
2009/09/02	DD	Added resolution of issue 6533
2009/09/22	DD	Added resolution of issue 7698
2009/09/23	DD	Added resolution of issue 6569
2009/10/01	DD	Added resolution of issue 7589
2009/10/02	DD	Added resolution of issue 7426
2009/10/02	DD	Added resolution of issue 7554
2009/10/05	DD	Added resolution of issues 6402, 6721
2009/10/06	DD	Added resolution of issue 7478
2009/10/13	DD	Added resolution of issue 7827
2009/10/20	DD	Added resolution of issue 7982
2009/10/20	DD	Added resolution of issue 7068
2009/10/20	DD	Added resolution of issue 7553
2009/10/20	DD	Added resolution of issue 7207
2009/10/27	DD	Added resolution of issues 7586, 7588, 7828
2009/11/05	DD	Added resolution of issue 8076
2009/11/05	DD	Added resolution of issue 7912
2009/11/06	DD	Added resolution of issue 8172
2009/11/06	DD	Added resolution of issue 8168
2009/11/06	DD	Added resolution of issue 7970
2009/11/06	DD	Added resolution of issue 8213
2009/11/06	DD	Added resolution of issue 8170
2009/11/06	DD	Added resolution of issue 8162
2009/11/06	DD	Added resolution of issue 8163
2009/11/06	DD	Added resolution of issue 8166
2009/11/06	DD	Added resolution of issue 8167
2009/11/06	DD	Added resolution of issue 8169
2009/11/06	DD	Added resolution of issue 8124
2009/11/17	DD	Added resolution of issue 8280
2009/11/17	DD	Added resolution of issue 8276
2009/11/17	DD	Added resolution of issue 8277
2009/11/17	DD	Added resolution of issue 8285
2009/12/01	DD	Added resolution of issue 8201
2009/12/08	DD	Added resolution of issue 8287
2010/01/05	DD	Added resolution of issue 8165
2010/01/12	DD	Added resolution of issue 8164
2010/01/12	DD	Added resolution of issue 8281
2010/01/12	DD	Added resolution of issue 8176
2010/01/19	DD	Added resolution of issue 8068
2010/01/19	DD	Added resolution of issue 8286
2010/01/19	DD	Added resolution of issue 8283
2010/01/26	DD	Added resolution of issue 8288
2010/01/26	DD	Added resolution of issue 8275
2010/01/27	DD	Added resolution of issue 7986
2010/01/28	DD	Added resolution of issue 8196
2010/02/05	DD	Added resolution of issue 6435
2010/02/08	DD	Added resolution of issue 8901
2010/02/09	DD	Added resolution of issue 8160
2010/02/09	DD	Added resolution of issue 8271
2010/03/09	DD	Added resolution of issue 6463, 8031, 8198
2010/03/16	DD	Added resolution of issue 8886
2010/03/30	DD	Added resolution of issue 9320
2010/03/30	DD	Added resolution of issue 9031
2010/03/30	DD	Added resolution of issue 9266
2010/04/20	DD	Added resolution of issue 9321
2010/04/20	DD	Added resolution of issue 9543
2010/04/27	DD	Added resolution of issue 8832
2010/05/04	DD	Added resolution of issue 9588
2010/05/11	DD	Added resolution of issue 9567
2010/05/11	DD	Added resolution of issue 9613
2010/05/11	DD	Added resolution of issue 9699
2010/05/11	DD	Added resolution of issue 9676