xeps/xep-0145.xml

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE xep SYSTEM 'xep.dtd' [
  <!ENTITY % ents SYSTEM 'xep.ent'>
%ents;
]>
<?xml-stylesheet type='text/xsl' href='xep.xsl'?>
<xep>
<header>
  <title>Annotations</title>
  <abstract>This document defines an XML data format for making annotations about XMPP roster items and other entities.</abstract>
  &LEGALNOTICE;
  <number>0145</number>
  <status>Proposed</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XEP-0060</spec>
    <spec>XEP-0223</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>rosternotes</shortname>
  <schemaloc>
    <url>http://www.xmpp.org/schemas/rosternotes.xsd</url>
  </schemaloc>
  <author>
    <firstname>Stefan</firstname>
    <surname>Strigler</surname>
    <email>steve@zeank.in-berlin.de</email>
    <jid>zeank@jwchat.org</jid>
  </author>
  &stpeter;
  <revision>
    <version>1.1pre3</version>
    <date>in progress, last updated 2007-09-27</date>
    <initials>psa</initials>
    <remark><p>Specified use of publish-subscribe private information nodes as the preferred storage mechanism.</p></remark>
  </revision>
  <revision>
    <version>1.0</version>
    <date>2006-03-23</date>
    <initials>psa</initials>
    <remark><p>Per a vote of the Jabber Council, advanced to Active.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2005-07-15</date>
    <initials>psa</initials>
    <remark><p>Editorial review: changed type to Historical; changed namespace to storage:rosternotes; corrected schema; specified use of DateTime profile from XEP-0082; corrected some small textual errors.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2004-11-05</date>
    <initials>st</initials>
    <remark><p>Initial version.</p></remark>
  </revision>
</header>

<section1 topic='Introduction' anchor='intro'>
  <p>Many modern IM clients offer functionality that enables a user to make notes about the contacts in their roster. This is helpful if such contacts do not have meaningful information in their vCard or if the user needs to remember additional information related to a roster item. To define such functionality, we specify a &lt;storage&gt; element (similar to that introduced in &xep0048;) and appropriate child elements, qualified by a new namespace of 'storage:rosternotes'. While the &lt;storage/&gt; element can be stored using any XML storage mechanism, this document describes two such methods that are specific to XMPP.</p>
</section1>

<section1 topic='Data Format' anchor='format'>
  <p>Annotations are stored using a &lt;storage/&gt; element qualified by the 'storage:rosternotes' namespace. This element contains a collection of one or more &lt;note/&gt; elements, each representing a note about a given entity.  For any given JID there MUST NOT be more than one note.</p>
  <p>The 'jid' attribute of the &lt;note/&gt; element SHOULD be used without a resource, i.e., it SHOULD be a bare JID (&BAREJID;) rather than a full JID (&FULLJID;). Along with the annotation a client MAY choose to store the creation time ('cdate') and modification time ('mdate') as attributes to the &lt;note/&gt; element containing the annotation; these attributes MUST conform to the DateTime profile specified in &xep0082; and the timezone SHOULD be UTC.</p>
  <example caption='Some annotations'><![CDATA[
    <storage xmlns='storage:rosternotes'>
      <note jid='hamlet@shakespeare.lit'
            cdate='2004-09-24T15:23:21Z'
            mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note>
      <note jid='juliet@capulet.com'
            cdate='2004-09-27T17:23:14Z'
            mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note>
    </storage>
  ]]></example>
  <p>Note: All notes are stored as a "bundle" within the same &lt;storage/&gt; element.</p>
</section1>

<section1 topic='Storage Methods' anchor='storage'>
  <p>It is RECOMMENDED to use &xep0060; for data storage, specifically through the use of personal data nodes hosted at the user's virtual publish-subscribe service as described in &xep0223; and illustrated in the following sections.</p>
  <p>Note: In the past, &xep0049; was the recommended method (see the archived version of this specification at &lt;<link url='http://www.xmpp.org/extensions/attic/xep-0145-1.0.html'>http://www.xmpp.org/extensions/attic/xep-0048-1.0.html</link>&gt;). In addition, other methods could be used, such as HTTP or WebDAV.</p>
  <section2 topic='Uploading Data' anchor='storage-pubsub-upload'>
    <example caption='Client uploads data'><![CDATA[
<iq from='juliet@capulet.lit/balcony' type='set' id='pip1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <publish node='storage:rosternotes'>
      <item id='current'>
        <storage xmlns='storage:rosternotes'>
        <note jid='hamlet@shakespeare.lit'
              cdate='2004-09-24T15:23:21Z'
              mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note>
        <note jid='juliet@capulet.com'
              cdate='2004-09-27T17:23:14Z'
              mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note>
        </storage>
      </item>
    </publish>
    <publish-options>
      <x xmlns='jabber:x:data' type='submit'>
        <field var='FORM_TYPE' type='hidden'>
          <value>http://jabber.org/protocol/pubsub#publish-options</value>
        </field>
        <field var='pubsub#persist_items'>
          <value>true</value>
        </field>
        <field var='pubsub#access_model'>
          <value>whitelist</value>
        </field>
      </x>
    </publish-options>
  </pubsub>
</iq>
    ]]></example>
    <example caption='Server acknowledges successful storage'><![CDATA[
q to='juliet@capulet.lit/balcony' type='result' id='pip1'/>
    ]]></example>
  </section2>
  <section2 topic='Receiving Notifications' anchor='storage-pubsub-notify'>
    <p>The stored data is automatically pushed to all of the user's connected resources.</p>
    <example caption='Publisher receives event notification'><![CDATA[
<message from='juliet@capulet.lit'
         to='juliet@capulet.lit/balcony'
         type='headline'
         id='rnfoo1'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='storage:rosternotes'>
      <item id='current'>
        <storage xmlns='storage:rosternotes'>
        <note jid='hamlet@shakespeare.lit'
              cdate='2004-09-24T15:23:21Z'
              mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note>
        <note jid='juliet@capulet.com'
              cdate='2004-09-27T17:23:14Z'
              mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note>
        </storage>
      </item>
    </items>
  </event>
</message>

<message from='juliet@capulet.lit'
         to='juliet@capulet.lit/chamber'
         type='headline'
         id='rnfoo2'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='storage:rosternotes'>
      <item id='current'>
        <storage xmlns='storage:rosternotes'>
        <note jid='hamlet@shakespeare.lit'
              cdate='2004-09-24T15:23:21Z'
              mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note>
        <note jid='juliet@capulet.com'
              cdate='2004-09-27T17:23:14Z'
              mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note>
        </storage>
      </item>
    </items>
  </event>
</message>
    ]]></example>
  </section2>
  <section2 topic='Retrieving Data' anchor='storage-pubsub-retrieve'>
    <p>In order to retrieve stored data without receiving notifications (e.g., upon initial login), the user's client sends a retrieve-items request as specified in <cite>XEP-0060</cite>.</p>
    <example caption='Client requests all items'><![CDATA[
<iq from='juliet@capulet.lit/randomID' type='get' id='retrieve1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='storage:rosternotes'/>
  </pubsub>
</iq>
    ]]></example>
    <example caption='Server returns all items'><![CDATA[
<iq type='result'
    to='juliet@capulet.lit/randomID'
    id='retrieve1'>
  <pubsub xmlns='http://jabber.org/protocol/pubsub'>
    <items node='storage:rosternotes'>
      <item id='current'>
        <storage xmlns='storage:rosternotes'>
          <note jid='hamlet@shakespeare.lit'
                cdate='2004-09-24T15:23:21Z'
                mdate='2004-09-24T15:23:21Z'>Seems to be a good writer</note>
          <note jid='juliet@capulet.com'
                cdate='2004-09-27T17:23:14Z'
                mdate='2004-09-28T12:43:12Z'>Oh my sweetest love ...</note>
        </storage>
      </item>
    </items>
  </pubsub>
</iq>
    ]]></example>
  </section2>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>Security considerations related to object persistent via publish-subscribe are described in XEP-0060 and <cite>XEP-0223</cite>.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>No interaction with &IANA; is required as a result of this document.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <p>No action by the &REGISTRAR; is required, since the 'storage:rosternotes' namespace is already included in the protocol namespaces registry (see &NAMESPACES;).</p>
</section1>

<section1 topic='XML Schema' anchor='schema'>
  <code><![CDATA[
<?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:annotation>
    <xs:documentation>
      The protocol documented by this schema is defined in
      XEP-0145: http://www.xmpp.org/extensions/xep-0145.html
    </xs:documentation>
  </xs:annotation>

  <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>
 ]]></code>
</section1>

</xep>