Abstract: | This document specifies best practices for roster and subscription management in Jabber/XMPP clients. |
Author: | Lucas Nussbaum |
Copyright: | © 1999 – 2017 XMPP Standards Foundation. SEE LEGAL NOTICES. |
Status: | Deferred |
Type: | Informational |
Version: | 0.2 |
Last Updated: | 2005-12-06 |
WARNING: This document has been automatically Deferred after 12 months of inactivity in its previous Experimental state. Implementation of the protocol described herein is not recommended for production systems. However, exploratory implementations are encouraged to resume the standards process.
1. Introduction
1.1. Motivation
1.2. Overview of subscription states
2. Removal of Contacts
3. Display of Contacts in the Roster
3.1. Name of the Hidden group
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
RFC 3921 [1] explains how subscriptions and rosters integrate. However, several points are left to the client author's discretion, and this can lead to some confusion among client developers. This document specifies best practices that enable all Jabber clients to manage subscriptions and roster in a coherent way, thus making sure that such clients will not surprise end users with unexpected behavior.
As defined in RFC 3921 (sections 6, 7, 8), a roster item can have one of the following subscription states:
Additionally, if subscription='from' or subscription='none', you can have ask='suscribe', which means you sent a subscription request to the item but haven't received an answer yet.
It is necessary to distinguish two things:
Three problems have to be taken into consideration here:
Therefore, the following behavior is RECOMMENDED for Jabber clients:
When the user asks for the removal of an item with subscription='both', the Jabber client SHOULD ask the user whether he wants to revoke the contact's authorization to see the user's presence too. This action SHOULD be called "Remove" since this is the convention used by other IM systems.
The Jabber client SHOULD NOT remove the contact from the roster. There are two exceptions:
The Jabber client MAY remove the contact from the roster if the user explicitely asked (so the user has to be informed he might remove both presence subscriptions).
The jabber client MAY transparently remove the contact from the roster if the user asked to, and if subscription='none' or subscription='to'.
In addition to the "Remove" action described above, the client MAY provide a way to revoke the contact's subscription to the user's presence. This action, if provided, SHOULD be called "Block" since this is the convention used by other IM networks.
Defining a sensible roster policy is difficult, because many users have different, special needs. We have to ensure that:
The user's roster contains both contacts of interest for the user (contacts with subscription='both' or subscription='to') and contacts which are only interested in receiving the user's presence information. Also, the user might be interested in having some contacts even with subscription='none', because he often send messages to them but isn't interested in their presence.
Therefore, the following types of contacts SHOULD be displayed by clients:
The client MAY display contacts with subscription='from' which don't match one of the above cases in an additional 'Observers' group. If no 'Observers' group is used, the client SHOULD NOT display contacts which don't match one of the above rules.
Some users give nicknames to contacts they do not want to see, to be able to remember who they are when cleaning the roster. An additional 'Hidden' group MAY be used to handle such contacts. The client SHOULD NOT display contacts if one of their groups is the 'Hidden' group. (This mean that if contact 'C' is in groups 'G' and 'Hidden', 'C' should never be displayed, even in group 'G'.)
The name of the 'Hidden' group can be managed in two different ways :
This is left as an open issue since no clients (to the author's knowledge) implement this 'Hidden' group. But the preference should go to the first solution, which avoids relying on Private XML Storage (XEP-0049) [3].
Series: XEP
Number: 0162
Publisher: XMPP Standards Foundation
Status:
Deferred
Type:
Informational
Version: 0.2
Last Updated: 2005-12-06
Approving Body: XMPP Council
Dependencies: None
Supersedes: None
Superseded By: None
Short Name: N/A
Source Control:
HTML
This document in other formats:
XML
PDF
Email:
lucas@lucas-nussbaum.net
JabberID:
lucas@nussbaum.fr
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. RFC 3921: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence <http://tools.ietf.org/html/rfc3921>.
2. XEP-0083: Nested Roster Groups <https://xmpp.org/extensions/xep-0083.html>.
3. XEP-0049: Private XML Storage <https://xmpp.org/extensions/xep-0049.html>.
Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/
END