XEP-0021: Jabber Event Notification Service (ENS)

Abstract:A generic publish-and-subscribe service for Jabber.
Author:Robert Norris
Copyright:© 1999 - 2014 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:Retracted
Type:Standards Track
Version:0.2
Last Updated:2003-04-22

WARNING: This document has been retracted by the author(s). Implementation of the protocol described herein is not recommended. Developers desiring similar functionality are advised to implement the protocol that supersedes this one (if any).


Table of Contents


1. Introduction
2. Definitions
    2.1. Event
    2.2. Subscriber
    2.3. Publisher
3. Subscriber protocol
    3.1. Subscription request
       3.1.1. Option: <auth-info/>
       3.1.2. Option: <reliable/>
    3.2. Subscription response
    3.3. Unsubscription request
    3.4. Unsubscription response
    3.5. Publish
    3.6. Publish response (reliable subscriptions)
4. Publisher protocol
    4.1. Publish
    4.2. Publish response
    4.3. Authorisation request
    4.4. Authorisation response
5. Errors
6. Considerations
    6.1. ENS discovery
    6.2. How reliable should <reliable/> be?
    6.3. Longevity of subscriptions
    6.4. Replacing <presence/> with the ENS?

Appendices
    A: Document Information
    B: Author Information
    C: Legal Notices
    D: Relation to XMPP
    E: Discussion Venue
    F: Requirements Conformance
    G: Notes
    H: Revision History


1. Introduction

The Jabber Event Notification Service (ENS) acts as a dispatcher and may be used by applications as a central point of collection for certain types of events that are of interest to them. Examples of events include:

In Jabber, the role of the ENS has traditionally been filled by overloading the <presence/> packet type. However, this method was never designed to be used as a general publish-and-subscribe mechanism, and so has the following problems:

The protocol consists of two parts - the subscriber-to-ENS protocol, and the publisher-to-ENS protocol. Since there is no direct interaction between a publisher and a subscriber, it makes sense to seperate the two parts of the protocol.

The protocol operates in the 'http://xml.cataclysm.cx/jabber/ens/' namespace.

A reference implementation was formerly available at http://cataclysm.cx/jabber/ens.html.

2. Definitions

Before we begin describing the protocol, is it necessary to define some terms, including the function and responsibilties of the entities that communicate with the ENS.

2.1 Event

An event can be defined as a change to the value of one or more properties of a resource.

In the ENS, an event type is referred to by a JID (Jabber IDentifier), including the JID resource. For example, consider a hypothetical publisher that is linked to an IMAP message store. It might notify the ENS of the fact the a message has arrived, deleted, or filed, using the following JIDs:

Alternatively, an end-user client that wanted to notify the ENS when its avatar changes might do so using a JID like "rob@cataclysm.cx/avatar"

2.2 Subscriber

A subscriber is a Jabber entity that receives notifications about events. Usually, a subscriber will be an end-user client, but it may be any Jabber entity.

As the name suggests, a subscriber can subscribe and unsubscribe to various events via the ENS. When it subscribes, the publisher responsible for the event it is subscribing to will be asked by the ENS to authorise the subscription request. To facilitate this, the subscriber may provide an XML fragment containing information that the publisher can use to authorise it. The use of this fragment is application specific.

Once subscribed to an event, the subscriber will receive any notifications that the publisher sends about that event.

2.3 Publisher

A publisher is the Jabber entity responsible for actually sending event notifications to the ENS. A notification contains the event type JID of the event that occured, and an optional "payload" XML fragment, that is passed untouched by the ENS to the subscriber. The contents of this payload is application-specific and can be used to provide detailed information about the event to the subscriber. For example, in the case of the NewMessage event above, the payload might contain the contents of the To:, From: and Subject: headers of the message.

Additionally, the publisher is responsible for deciding who may subscribe to events it publishes. When the ENS receives a subscription request, it will ask the publisher to decide whether or not the subscriber may subscribe to a particular event. This authorisation request may also contain an XML fragment from the subscriber containing information that may be used for authorisation.

3. Subscriber protocol

3.1 Subscription request

To subscribe to a particular event, the subscriber sends a packet like of the following form to the ENS:

Example 1. Subscription request

<iq id='sub1' type='set' from='subscriber-jid' to='ens-jid'>
  <subscribe xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
</iq>
    

3.1.1 Option: <auth-info/>

The subscriber may include an <auth-info/> XML fragment containing some (application-specific) information that the publisher can use to authorise it:

Example 2. Subscription request with authorisation information

<iq id='sub2' type='set' from='subscriber-jid' to='ens-jid'>
  <subscribe xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'>
    <auth-info xmlns='jabber:iq:auth'>password</auth-info>
  </subscribe>
</iq>
      

3.1.2 Option: <reliable/>

If it wishes, the subscriber may request a "reliable" subscription. This option guarantees that the subscriber will receive all notifications about this event (as far as the Jabber architecture guarantees delivery). This changes the semantics of the subscriber publish protocol - see section 3.6 for more details.

Example 3. Reliable subscription request

<iq id='sub2' type='set' from='subscriber-jid' to='ens-jid'>
  <subscribe xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'>
    <reliable/>
  </subscribe>
</iq>
      

3.2 Subscription response

Once subscribed, the ENS will return a packet of the following form to the subscriber:

Example 4. Successful subscription response

<iq id='sub1' type='result' from='ens-jid' to='subscriber-jid'>
  <subscribed xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
</iq>
    

If an error occured during subscription (such as the publisher not allowing the subscriber to subscribe), an error packet will be returned to the subscriber:

Example 5. Failed subscription response

<iq id='sub1' type='error' from='ens-jid' to='subscriber-jid'>
  <subscribe xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
  <error code='401'>Unauthorized</error>
</iq>
    

The actual error fragment in the packet is a direct copy of the one returned by the publisher when it fails the authorisation request from the ENS. If the publisher does not provide one, error code 503 (Service Unavailable) will be returned instead. If the publisher does not respond to the authorisation request (after an implementation-specific timeout), error code (Remote Server Timeout) will be returned.

3.3 Unsubscription request

To unsubscribe from a particular event, the subscriber sends a packet like of the following form to the ENS:

Example 6. Unsubscription request

<iq id='unsub1' type='set' from='subscriber-jid' to='ens-jid'>
  <unsubscribe xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
</iq>
    

3.4 Unsubscription response

Once unsubscribed, the ENS will return a packet of the following form to the subscriber:

Example 7. Unsubscription response

<iq id='unsub1' type='result' from='ens-jid' to='subscriber-jid'>
  <unsubscribed xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
</iq>
    

No further notifications for the event will be received.

3.5 Publish

When a publisher publishes a notification to the ENS, the ENS will forward the notification to any subscribers for that event. A notification sent to a subscriber takes the following form:

Example 8. Event notification (publish)

<iq id='enspub1' type='set' from='ens-jid' to='subscriber-jid'>
  <publish xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'/>
</iq>
    

A notification may also contain a (application-specific) "payload" XML fragment:

Example 9. Event notification (publish) with payload

<iq id='enspub2' type='set' from='ens-jid' to='subscriber-jid'>
  <publish xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='event-jid'>
    <xml-payload/>
  </publish>
</iq>
    

Section 4.1 has more information about the payload.

If the subscriber responds to the notification with an error, the subscriber will be automatically unsubscribed from the event by the ENS.

3.6 Publish response (reliable subscriptions)

If the <reliable/> option was specified when the subscriber subscribed to the event, then the subscriber is expected to acknowledge a notification with a packet of the following form:

Example 10. Event notification (publish) response

<iq id='enspub1' type='result' from='subscriber-jid' to='ens-jid'>
  <published xmlns='http://xml.cataclysm.cx/jabber/ens/'/>
</iq>
    

If the subscriber does not respond, or responds with an error, the notification will be resent by the ENS after a (implementation-specific) timeout.

4. Publisher protocol

4.1 Publish

To publish a notification, the publisher sends a packet of the following form to the ENS:

Example 11. Event notification (publish)

<iq id='pub1' type='set' from='event-jid' to='ens-jid'>
  <publish xmlns='http://xml.cataclysm.cx/jabber/ens/'/>
</iq>
    

A notification may also contain a (application-specific) "payload" XML fragment:

Example 12. Event notification (publish) with payload

<iq id='pub1' type='set' from='event-jid' to='ens-jid'>
  <publish xmlns='http://xml.cataclysm.cx/jabber/ens/'>
    <xml-payload/>
  </publish>
</iq>
    

The payload can be any well-formed XML data. Everything inside the <publish/> tag will be forwarded untouched to the subscriber.

4.2 Publish response

Once the ENS has dispatched the notification to subscribers, it will return a packet of the following form to the publisher:

Example 13. Event notification (publish) response

<iq id='pub1' type='result' from='ens-jid' to='event-jid'>
  <published xmlns='http://xml.cataclysm.cx/jabber/ens/'/>
</iq>
    

4.3 Authorisation request

A publisher is required to approve subcription requests. When a subscriber attempts to subscribe to an event, the publisher will receive a packet of the following form from the ENS:

Example 14. Authorisation request

<iq id='ensauth1' type='get' from='ens-jid' to='event-jid'>
  <authorise xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='subscriber-jid'/>
</iq>
    

The subscriber may include an <auth-info/> XML fragment containing some (application-specific) information that the publisher can use to authorise it:

Example 15. Authorisation request with authorisation information

<iq id='ensauth1' type='get' from='ens-jid' to='event-jid'>
  <authorise xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='subscriber-jid'>
    <auth-info xmlns='jabber:iq:auth'>password</auth-info>
  </authorise>
</iq>
    

4.4 Authorisation response

To signal to the ENS that a subscriber should be allowed to subscribe, the publisher should return a packet of the following form:

Example 16. Successful authorisation response

<iq id='ensauth1' type='result' from='event-jid' to='ens-jid'>
  <authorised xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='subscriber-jid'/>
</iq>
    

To deny the subscription, the publisher should return an error packet, containing the appropriate <error/> fragment:

Example 17. Unsuccessful authorisation response

<iq id='ensauth1' type='error' from='event-jid' to='ens-jid'>
  <authorise xmlns='http://xml.cataclysm.cx/jabber/ens/' jid='subscriber-jid'/>
  <error code='401'>Unauthorized</error>
</iq>
    

The <error/> fragment will be copied untouched into the error response sent back to the subscriber. See section 3.2 for more details.

5. Errors

The ENS will respond with error code 400 (Bad Request) any time it receives a request that it cannot understand (a malformed packet, for example).

Other errors may occur, and they are described in the appropriate sections of the above protocol specification.

6. Considerations

The following items should be discussed before this proposal is approved by the Council:

6.1 ENS discovery

The ENS, as described, works well. However, no provisions are made for a subscriber to find out which ENS a publisher is publishing to. It does a subscriber no good to subscribe to an event on the wrong ENS - the subscription would succeed (assuming the publisher allows it), but no notifications would ever be received.

There are several potential solutions, each with their problems:

This problem may be outside of the scope of this specification.

6.2 How reliable should <reliable/> be?

Currently, if a subscriber obtains a reliable subscription, and then disappears from the network (as an end-user client might), the ENS will continue to send notifications to it (ignoring errors) until it unsubscribes. If the subscriber never comes back, then ENS will send notifications forever (in theory).

At what point should even <reliable/> have its limits? Should we unsubscribe a reliable subscriber who bounces (ie. the Jabber server failed to deliver) more than, say, 10 publishes? Or maybe they should be unsubscribed if they do not respond (as in section 3.6) to anything for, say, 10 minutes?

<reliable/> is an interesting idea, but it may be that it is too problematic for its own good.

6.3 Longevity of subscriptions

The topic of reliable subscriptions raises the question as to how long a subscription lasts. Should a subscription last forever (like <presence/> does), even across restarts of the server?

If end-user clients are to be subscribers, then under this scheme the ENS would have to subscribe to presence, so as to know when the client has disconnected. Since presence is a function of the session manager, this could have the effect of making the ENS less generic that we may like.

6.4 Replacing <presence/> with the ENS?

As I see it, basic presence will always be a function of the session manager, for the following reasons:

I think the places where the ENS can boom will be in applications like avatars, and genuine event-based systems (like the kind described above - "you have new mail", "someone has scheduled a meeting with you in your online calendar", etc).


Appendices


Appendix A: Document Information

Series: XEP
Number: 0021
Publisher: XMPP Standards Foundation
Status: Retracted
Type: Standards Track
Version: 0.2
Last Updated: 2003-04-22
Approving Body: XMPP Council
Dependencies: None
Supersedes: None
Superseded By: None
Short Name: None
Source Control: HTML
This document in other formats: XML  PDF


Appendix B: Author Information

Robert Norris

Email: rob@cataclysm.cx
JabberID: rob@cataclysm.cx


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright © 1999 - 2014 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <http://xmpp.org/about-xmpp/xsf/xsf-ipr-policy/> or obtained by writing to XMPP Standards Foundation, 1899 Wynkoop Street, Suite 600, Denver, CO 80202 USA).

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.


Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.


Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".


Appendix G: Notes


Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

Version 0.2 (2003-04-22)

At the request of the author, the status of this document has been changed to Retracted since it has been superseded by XEP-0060. (psa)

Version 0.1 (2002-03-04)

Initial version (rn)

END