Abstract: | This specification defines a modern efficient way to deliver PubSub notifications. |
Author: | Sergey Dobrov |
Copyright: | © 1999 – 2017 XMPP Standards Foundation. SEE LEGAL NOTICES. |
Status: | Experimental |
Type: | Standards Track |
Version: | 0.1 |
Last Updated: | 2014-08-28 |
WARNING: This Standards-Track document is Experimental. Publication as an XMPP Extension Protocol does not imply approval of this proposal by the XMPP Standards Foundation. Implementation of the protocol described herein is encouraged in exploratory implementations, but production systems are advised to carefully consider whether it is appropriate to deploy implementations of this protocol before it advances to a status of Draft.
1. Introduction
2. Requirements
3. Use Cases
3.1. Switching protocols
3.2. Sending and receiving a notification
3.3. Advertising client's filtering preferences
4. Security Considerations
5. IANA Considerations
6. XMPP Registrar Considerations
7. XML Schema
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
Publish-Subscribe (XEP-0060) [1] in conjuction with Entity Capabilities (XEP-0115) [2] defines a way for a client to get rid of unwanted pubsub notifications and hence save significant amount of traffic. The protocol is quite flexible and reliable and is able to work even with servers that don't support filtering. Unfortunately, this reliability has its costs and the protocol has the following disadvantages:
The most actual example of the problems that are beget with these disadvantages is the Microblogging Over XMPP (XEP-0277) [3]: you won't be able to subscribe to a user's blog if he doesn't want to read your blog as well. This will be a big problem for popular bloggers that can't read all the feeds of their readers.
Another one is a bot which want to gather information from a lot of users. For instance, we can want to write a bot which gather geo-location from a lot of devices, then it will subscribe to these devices but they may not want to do so. The new protocol will allow such bots to operate this way.
Also, some clients may want to receive retract items events to appropriately update their feed data storage but some other clients may not want to store feeds at all and just show the recent events and corollary don't need in these events. This standard allows the first one to receive those events and the last one to get rid of them saving traffic, regardless of node settings which can be configured solely by the node's owner.
The new protocol is needed to solve the stated problems that will allow to move the notifications filtering process from the sender side to the recipient side, that will allow us to filter them in a more flexible way. Also, we must care of:
This document should cover the following use cases:
Since we require the implementations to be backwards compatible, we need a mechanism for a sender to know if the recipient's server supports the modern protocol or not.
To know this, sender's server should check recipient's capabilities as described at Entity Capabilities (XEP-0115) [2] in the "Stream Feature" section: if the server supports the "urn:xmpp:rsf:0" feature then the server SHOULD use the protocol that's described here, if the server lacks support of this feature or doesn't provide its capabilities at all then the sender MUST NOT use this protocol.
When using this protocol to deliver notifications, the server MUST follow these rules:
<message from='user@example.net' to='user1@example.com'> <event xmlns='http://jabber.org/protocol/pubsub#event'> <items node='n48ad4fj78zn38st734'> <item id='i1s2d3f4g5h6bjeh936'> <geoloc xmlns='http://jabber.org/protocol/geoloc'> <description>Venice</description> <lat>45.44</lat> <lon>12.33</lon> </geoloc> </item> </items> </event> </message> <message from='user@example.net' to='user2@example.com'> <event xmlns='http://jabber.org/protocol/pubsub#event'> <items node='n48ad4fj78zn38st734'> <item id='i1s2d3f4g5h6bjeh936'> <geoloc xmlns='http://jabber.org/protocol/geoloc'> <description>Venice</description> <lat>45.44</lat> <lon>12.33</lon> </geoloc> </item> </items> </event> </message> ... and so on
Recipient server is responsible now to filter out and broadcast that messages with events that were request by each user's resource.
As described at Publish-Subscribe (XEP-0060) [1]'s "Filtered notifications" section, client should add payload's NodeID and "+notify" postfix to tell which types of content it can and want to process.
This document extends this filtering feature to allow clients also select which event types it wants to receive.
To advertise user's preferences it should add a feature in its capabilities that MUST consist of payload's NodeID with appended "+events-" postfix and then append a list of necessary payload types. Here are the rules of generating this list:
For example, the following string will mean that user wants to receive new items, node configuration changes and new subscriptions geolocation events, it should add the following features in its capabilities:
The recipient's server MUST drop the notifications that are not in the list. New items notifications are implied by the "+notify" filter. If user doesn't specify the "+events" filter then the server SHOULD treat it as absence of any filtering at all.
PENDING
This document requires no interaction with the Internet Assigned Numbers Authority (IANA).
REQUIRED.
This protocol doesn't define any XML stanzas.
Series: XEP
Number: 0351
Publisher: XMPP Standards Foundation
Status:
Experimental
Type:
Standards Track
Version: 0.1
Last Updated: 2014-08-28
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-0001, XEP-0060, XEP-0115
Supersedes: None
Superseded By: None
Short Name: NOT_YET_ASSIGNED
Source Control:
HTML
This document in other formats:
XML
PDF
Email:
Binary@JRuDevels.org
JabberID:
Binary@JRuDevels.org
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.
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>.
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".
1. XEP-0060: Publish-Subscribe <https://xmpp.org/extensions/xep-0060.html>.
2. XEP-0115: Entity Capabilities <https://xmpp.org/extensions/xep-0115.html>.
3. XEP-0277: Microblogging over XMPP <https://xmpp.org/extensions/xep-0277.html>.
Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/
Initial published version approved by the XMPP Council.
(XEP Editor(aw))Updated based on Council feedback.
(sd)First draft.
(sd)END