XEP-xxxx: Pubsub Subscription

Abstract:This specification describe a method that allow a user to share a list of nodes on which it is Pubsub registered
Authors:Christine nodpounod, Timothée edhelas
Copyright:© 1999 - 2013 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status:ProtoXEP
Type:Standards Track
Version:0.0.1
Last Updated:2013-03-04

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.


Table of Contents


1. Introduction
2. Protocol
    2.1. Item ID generation method
       2.1.1. Generation Example
3. Requirements
4. Glossary
5. Use Cases
    5.1. Requesting the list of subscription
    5.2. Adding a subscription to the list
    5.3. Removing a subscription from the list
    5.4. Modifiying a subscription of the list
6. Internationalization Considerations
7. Security Considerations
8. IANA Considerations
9. XMPP Registrar Considerations
10. 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


1. Introduction

Publish-Subscribe [1] nodes are commonly used by XMPP users to subscribe to news feeds. This document describe a way, for them, to share some of the nodes to which they have subscribed with other users.

The list of Publish-Subscribe [2] subcribed nodes is stored on a classic Personal Eventing Protocol [3] node qualified by the 'urn:xmpp:subscription' namespace. If an entity wishes to make pubsub subscriptions publicly available then the entity MAY publish them on this node. The entity SHOULD ensure that this information is kept up to date.

2. Protocol

Information about the subscribed node is provided by the user client. The subscription container is defined as a classic element with theses specific constraints :

Table 1: attributes

Name Type Description Support
server attribute Any server's address REQUIRED
node attribute REQUIRED
id node RECOMMENDED
title node OPTIONAL

2.1 Item ID generation method

The aim of this XEP is to handle a list of subscriptions. To simplify the managment of this list the ID of the Publish-Subscribe [4] items MUST be generated according to the following method :

  1. Initialize an empty string S
  2. Append the name of the server, followed by the '<' character
  3. Append the name of the node, followed by the '<' character
  4. Append the jid of the current account
  5. Compute the ID by hashing the S string using the SHA1 algorythm

2.1.1 Generation Example

  1. S = ''
  2. S = 'pubsub.montague.lit<'
  3. S = 'pubsub.montague.lit<party'
  4. id = de6c6772ff43d9a604ea78e51ce28b63ab8692eb

3. Requirements

The motivations for this document are to :

4. Glossary

Personnal Eventing
A simplified subset of Publish-Subscribe for use in the context of instant messaging and presence applications, whereby each IM user's JID is a virtual pubsub service; for details, see Personal Eventing Protocol.

5. Use Cases

5.1 Requesting the list of subscription

Example 1. Requests the list of subscriptions

            <iq type='get'
                from='romeo@montague.lit'
                to='pubsub.shakespeare.lit'
                id='items1'>
              <pubsub xmlns='http://jabber.org/protocol/pubsub'>
                <items node='urn:xmpp:pubsub:subscription'/>
              </pubsub>
            </iq>

5.2 Adding a subscription to the list

Example 2. Add a subscription to the list

            <iq type="set" from="romeo@montague.lit" id="sub123">
            <pubsub xmlns="http://jabber.org/protocol/pubsub">
                <publish node="urn:xmpp:pubsub:subscription">
                  <item id="0bc0e76cb803b3b107aa369169d8c0d45086f844">
                    <subscription xmlns="urn:xmpp:pubsub:subscription:0"
            server="pubsub.shakespeare.lit" node="party">
                      <title>Party at the Capulets</title>
                    </subscription>
                  </item>
                </publish>
              </pubsub>
            </iq>
              
            

5.3 Removing a subscription from the list

Example 3. Remove a subscription from the list

            <iq type='set'
                from='romeo@montague.lit'
                to='pubsub.shakespeare.lit'
                id='unsub1'>
            <pubsub xmlns='http://jabber.org/protocol/pubsub'>
                <retract node='urn:xmpp:pubsub:subscription'>
                  <item id='0bc0e76cb803b3b107aa369169d8c0d45086f844'/>
                </retract>
            </pubsub>
            </iq>
              
            

5.4 Modifiying a subscription of the list

Example 4. Change the information of a subscription of the list

            <iq type='set'
                from='romeo@montague.lit'
                to='pubsub.shakespeare.lit'
                id='unsub1'>
            <pubsub xmlns='http://jabber.org/protocol/pubsub'>
             <publish node='urn:xmpp:pubsub:subscription'>
                  <item id='0bc0e76cb803b3b107aa369169d8c0d45086f844'>
                    <subscription xmlns='urn:xmpp:pubsub:subscription:0'
            server='pubsub.shakespeare.lit' node='party'>
                      <title>Party at the Capulets [canceled !]</title>
                    </subscription>
                  </item>
            </publish>
            </pubsub>
            </iq>
              
            

6. Internationalization Considerations

The title element of a item SHOULD be in the same language as the contents of the node in question.

7. Security Considerations

The publication of user tune information is not known to introduce any new security considerations above and beyond those defined in XEP-0060: Publish-Subscribe.

8. IANA Considerations

This document requires no interaction with the Internet Assigned Numbers Authority (IANA) [7].

9. XMPP Registrar Considerations

The XMPP Registrar [8] is requested to issue an initial namespace of "urn:xmpp:pubsub:subscription".

10. XML Schema

REQUIRED for protocol specifications.


Appendices


Appendix A: Document Information

Series: XEP
Number: xxxx
Publisher: XMPP Standards Foundation
Status: ProtoXEP
Type: Standards Track
Version: 0.0.1
Last Updated: 2013-03-04
Approving Body: XMPP Council
Dependencies: XMPP Core, XEP-0001, XEP-0163, XEP-0060
Supersedes: None
Superseded By: None
Short Name: subscription
This document in other formats: XML  PDF


Appendix B: Author Information

Christine nodpounod

Email: nodpounod@gmail.com
JabberID: christine.ho.dev@gmail.com

Timothée edhelas

Email: edhelas@gmail.com
JabberID: edhelas@movim.eu


Appendix C: Legal Notices

Copyright

This XMPP Extension Protocol is copyright (c) 1999 - 2013 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. In no event shall the XMPP Standards Foundation or the authors of this Specification be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification. ##

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 out of the use or inability to use 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 may be found at <http://www.xmpp.org/extensions/ipr-policy.shtml> or obtained by writing to XSF, P.O. Box 1641, Denver, CO 80201 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

1. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

2. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

3. XEP-0163: Personal Eventing Protocol <http://xmpp.org/extensions/xep-0163.html>.

4. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

5. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

6. XEP-0060: Publish-Subscribe <http://xmpp.org/extensions/xep-0060.html>.

7. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

8. The XMPP Registrar maintains a list of reserved protocol namespaces as well as registries of parameters used in the context of XMPP extension protocols approved by the XMPP Standards Foundation. For further information, see <http://xmpp.org/registrar/>.


Appendix H: Revision History

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

Version 0.0.1 (2013-03-04)

First draft.

(psa)

END