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 a protocol for making annotations about roster items and other entities.</abstract>
    &LEGALNOTICE;
    <number>0145</number>
    <status>Active</status>
    <type>Historical</type>
    <jig>Standards JIG</jig>
    <approver>Council</approver>
    <dependencies>
      <spec>XMPP Core</spec>
      <spec>XEP-0049</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>
    <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>JEP Editor revisions: 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 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.</p>

    <p>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. &xep0049; 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 &xep0048; is reused, and a new namespace of 'storage:rosternotes' is added.</p>

  </section1>

  <section1 topic='The storage:rosternotes Namespace' anchor='ns_storage_notes'>
    
    <p>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 &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. Along with the annotation a client MAY choose to store creation time ('cdate') and modification time ('mdate') as attributes to the &lt;note/&gt; element containing the note; these attributes MUST conform to the DateTime profile specified in &xep0082; and the timezone SHOULD be UTC.</p>

    <example caption='Storing Annotations'>
    <![CDATA[
<iq type='set' id='a1'>
  <query xmlns='jabber:iq:private'>
    <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>
  </query>
</iq>
]]></example>

    <p>Note: All notes are stored as a "bundle" within the same &lt;storage/&gt; element.</p>

    <p>Retrieving notes uses the protocol described in <cite>XEP-0049</cite>.</p>

    <example caption='Retrieving Annotations'>
    <![CDATA[
<iq type='get' id='a2'>
  <query xmlns='jabber:iq:private'>
    <storage xmlns='storage:rosternotes'/>
  </query>
</iq>
]]></example>

    <example caption='Server response'>
    <![CDATA[
<iq type='result' id='a2'>
  <query xmlns='jabber:iq:private'>
    <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>
  </query>
</iq>
]]></example>

    <p>For error conditions please refer to <cite>XEP-0049</cite>.</p>

  </section1>

  <section1 topic='Security Considerations' anchor='security'>
    <p>Security considerations related to private XML storage are described in <cite>XEP-0049</cite>.</p>
  </section1>

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

  <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
    <p>No namespaces or parameters need to be registered with the &REGISTRAR; as a result of this JEP.</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>