This JEP defines a protocol for making annotations about roster items and other entities.
NOTICE: This JEP is currently within Last Call or under consideration by the Jabber Council for advancement to the next stage in the JSF standards process. For further details, visit <http://www.jabber.org/council/queue.shtml>.
Last Updated: 2005-07-15
JIG: Standards JIG
Approving Body: Jabber Council
Dependencies: XMPP Core, JEP-0049
Superseded By: None
Short Name: rosternotes
Wiki Page: <http://wiki.jabber.org/index.php/Annotations (JEP-0145)>
This Jabber Enhancement Proposal is copyright 1999 - 2006 by the Jabber Software Foundation (JSF) and is in full conformance with the JSF's Intellectual Property Rights Policy <http://www.jabber.org/jsf/ipr-policy.shtml>. This material may be distributed only subject to the terms and conditions set forth in the Creative Commons Attribution License (<http://creativecommons.org/licenses/by/2.5/>).
The preferred venue for discussion of this document is the Standards-JIG discussion list: <http://mail.jabber.org/mailman/listinfo/standards-jig>.
The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 3920) and XMPP IM (RFC 3921) specifications contributed by the Jabber Software 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 JEP 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 keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
Many modern IM clients offer functionality that enables users to make notes about items in their roster. This comes in handy if users don't have meaningful information in their vCard or if you need to remember additional things related to a roster item.
This specification defines a protocol for storing annotations about a given set of entities. Its primary goal is to enable users to store some personal piece of information with their roster items. Private XML Storage  provides with a convenient method for storing user data on the server using the 'jabber:iq:private' namespace; all we need to do is define a namespace and schema for storing this sort of information. For this the 'storage' element introduced in Bookmark Storage  is reused, and a new namespace of 'storage:rosternotes' is added.
Annotations are stored using server-side private XML storage (the 'jabber:iq:private' namespace). A storage element marked by the storage:rosternotes namespace contains a collection of one or more <note/> elements, each representing a note about a given entity. For any given JID there MUST NOT be more than one note.
The 'jid' attribute of the <note/> element SHOULD be used without a resource. Along with the annotation a client MAY choose to store creation time ('cdate') and modification time ('mdate') as attributes to the <note/> element containing the note; these attributes MUST conform to the DateTime profile specified in Jabber Date and Time Profiles  and the timezone SHOULD be UTC.
<iq type='set' id='a1'> <query xmlns='jabber:iq:private'> <storage xmlns='storage:rosternotes'> <note email@example.com' cdate='2004-09-24T15:23:21Z' mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note> <note firstname.lastname@example.org' cdate='2004-09-27T17:23:14Z' mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note> </storage> </query> </iq>
Note: All notes are stored as a "bundle" within the same <storage/> element.
Retrieving notes uses the protocol described in JEP-0049.
<iq type='get' id='a2'> <query xmlns='jabber:iq:private'> <storage xmlns='storage:rosternotes'/> </query> </iq>
<iq type='result' id='a2'> <query xmlns='jabber:iq:private'> <storage xmlns='storage:rosternotes'> <note email@example.com' cdate='2004-09-24T15:23:21Z' mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note> <note firstname.lastname@example.org' cdate='2004-09-27T17:23:14Z' mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note> </storage> </query> </iq>
For error conditions please refer to JEP-0049.
Security considerations related to private XML storage are described in JEP-0049.
No interaction with the Internet Assigned Numbers Authority (IANA)  is required as a result of this JEP.
The Jabber Registrar  shall include 'storage:rosternotes' in its registry of protocol namespaces.
<?xml version='1.0' encoding='UTF-8'?> <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' targetNamespace='storage:rosternotes' xmlns='storage:rosternotes' elementFormDefault='qualified'> <xs:element name='storage'> <xs:complexType> <xs:sequence> <xs:element ref='note' minOccurs='0' maxOccurs='unbounded'/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name='note'> <xs:complexType> <xs:simpleContent> <xs:extension base='xs:string'> <xs:attribute name='jid' type='xs:string' use='required'/> <xs:attribute name='cdate' type='xs:dateTime' use='optional'/> <xs:attribute name='mdate' type='xs:dateTime' use='optional'/> </xs:extension> </xs:simpleContent> </xs:complexType> </xs:element> </xs:schema>
4. 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/>.
5. The Jabber Registrar maintains a list of reserved Jabber protocol namespaces as well as registries of parameters used in the context of protocols approved by the Jabber Software Foundation. For further information, see <http://www.jabber.org/registrar/>.