xep-0168.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>Resource Application Priority</title>
  <abstract>This document defines an XMPP protocol extension to indicate the presence priority of XMPP resources for applications other than standard XMPP messaging.</abstract>
  &LEGALNOTICE;
  <number>0168</number>
  <status>Deferred</status>
  <type>Standards Track</type>
  <sig>Standards</sig>
  <approver>Council</approver>
  <dependencies>
    <spec>XMPP Core</spec>
    <spec>XMPP IM</spec>
    <spec>XEP-0030</spec>
  </dependencies>
  <supersedes/>
  <supersededby/>
  <shortname>NOT_YET_ASSIGNED</shortname>
  &stpeter;
  &hildjj;
  <revision>
    <version>0.7</version>
    <date>2008-09-26</date>
    <initials>psa</initials>
    <remark>
      <ul>
        <li>More clearly defined the meaning of "application type".</li>
        <li>Modified namespaces to incorporate namespace versioning.</li>
      </ul>
    </remark>
  </revision>
  <revision>
    <version>0.6</version>
    <date>2007-11-19</date>
    <initials>psa</initials>
    <remark><p>Documented optional pubsub transport for RAP data.</p></remark>
  </revision>
  <revision>
    <version>0.5</version>
    <date>2007-11-15</date>
    <initials>psa</initials>
    <remark><p>Editorial review and consistency check.</p></remark>
  </revision>
  <revision>
    <version>0.4</version>
    <date>2007-06-06</date>
    <initials>psa</initials>
    <remark>
      <ul>
        <li>Added section on RAP-based routing of messages sent to bare JIDs.</li>
        <li>Removed RAP request protocol.</li>
        <li>Changed app attribute to ns attribute.</li>
        <li>Removed the application types registry since it is unnecessary if the ns attribute specifies the XML namespace of the data most closely associated with the application type.</li>
        <li>Updated namespaces to conform to XMPP Registrar processes.</li>
      </ul>
    </remark>
  </revision>
  <revision>
    <version>0.3</version>
    <date>2006-09-17</date>
    <initials>psa</initials>
    <remark><p>Changed im application type to messaging; added jingle-video.</p></remark>
  </revision>
  <revision>
    <version>0.2</version>
    <date>2005-12-19</date>
    <initials>psa</initials>
    <remark><p>Clarified structure of, and added schema for, RAP request namespace.</p></remark>
  </revision>
  <revision>
    <version>0.1</version>
    <date>2005-12-15</date>
    <initials>psa</initials>
    <remark><p>Initial published version.</p></remark>
  </revision>
  <revision>
    <version>0.0.6</version>
    <date>2005-11-29</date>
    <initials>psa</initials>
    <remark><p>Document cleanup.</p></remark>
  </revision>
  <revision>
    <version>0.0.5</version>
    <date>2005-11-17</date>
    <initials>psa</initials>
    <remark><p>Added support for RAP requests via IQ.</p></remark>
  </revision>
  <revision>
    <version>0.0.4</version>
    <date>2005-10-27</date>
    <initials>psa/jjh</initials>
    <remark><p>Defined registry of application types; clarified business rules; corrected schema.</p></remark>
  </revision>
  <revision>
    <version>0.0.3</version>
    <date>2005-10-24</date>
    <initials>psa/jjh</initials>
    <remark><p>Broadened previous resource flagging proposal to include priority for applications other than messaging.</p></remark>
  </revision>
  <revision>
    <version>0.0.2</version>
    <date>2005-09-26</date>
    <initials>psa/jjh</initials>
    <remark><p>Added more business rules and examples; defined service discovery guidelines.</p></remark>
  </revision>
  <revision>
    <version>0.0.1</version>
    <date>2005-09-23</date>
    <initials>psa/jjh</initials>
    <remark><p>First draft.</p></remark>
  </revision>
</header>
<section1 topic='Introduction' anchor='intro'>
  <p>Within the Extensible Messaging and Presence Protocol (&xmppcore;), presence indicates availability for communication. Specifically, in systems that bundle presence and instant messaging (see &xmppim;), the &lt;priority/&gt; child of the XMPP &PRESENCE; stanza indicates availability for communications qualified by the "jabber:client" namespace, especially instant messaging. However, a wide variety of entities might provide XMPP presence, including entities that are not primarily focused on IM (e.g., phones) or even entities that do not support XMPP messaging at all.</p>
  <p>Consider a scenario in which a contact wants to initiate a voice chat (see &xep0167;) with a user who has the following three XMPP resources:</p>
  <table caption='Application Presence'>
  <tr>
    <th>Resource</th>
    <th>Messaging Priority</th>
    <th>Voice Chat Priority</th>
  </tr>
  <tr>
    <td>desktop</td>
    <td>10</td>
    <td>5</td>
  </tr>
  <tr>
    <td>pda</td>
    <td>5</td>
    <td>-1</td>
  </tr>
  <tr>
    <td>mobile</td>
    <td>-1</td>
    <td>10</td>
  </tr>
  </table>
  <p>If the contact chooses the resource with which it initiates a voice chat based on the standard XMPP &lt;priority/&gt; element, the resulting behavior could be misleading (i.e., initiating the voice chat with the "desktop" resource rather than the "mobile" resource).</p>
  <p>What is needed is a way for the user's clients to indicate that the application priority for the three resources is different from the standard XMPP priority. This document defines such a mechanism via an optional XMPP presence extension.</p>
  <p>As applications of that core use case, this document also defines:</p>
  <ul>
    <li>A way for an XMPP server to mark which resource it considers to be primary for any given application type, if it has information -- such as communication preferences -- that can help it determine the primary resource.</li>
    <li>A way for an XMPP server to use application priority data for more intelligent routing of specially-labelled XMPP &MESSAGE; stanzas directed to a user's bare JID &LOCALBARE;.</li>
  </ul>
</section1>

<section1 topic='What Is An Application?' anchor='app'>
  <p>This specification deliberately leaves the meaning of the term "application" or "application type" fairly loose. Possible examples include:</p>
  <ul>
    <li>Messaging</li>
    <li>Voice chat</li>
    <li>Video chat</li>
    <li>Calendaring</li>
    <li>Whiteboarding</li>
    <li>Collaborative editing</li>
  </ul>
  <p>A future version of this specificaiton might establish a registry for application types.</p>
</section1>

<section1 topic='Application Priority' anchor='rap'>
  <section2 topic='Format' anchor='rap-format'>
    <p>Application priority is encapsulated by a &lt;rap/&gt; element qualified by the 'urn:xmpp:rap:0' namespace &VNOTE;. The attributes of the &lt;rap/&gt; element are as follows.</p>
    <table caption='RAP Attributes'>
      <tr>
        <th>Attribute</th>
        <th>Definition</th>
        <th>Inclusion</th>
      </tr>
      <tr>
        <td>ns</td>
        <td>The primary namespace of the application type.</td>
        <td>REQUIRED</td>
      </tr>
      <tr>
        <td>num</td>
        <td>The resource's priority for this application type. <note>This protocol uses a 'num' attribute rather than a 'priority' attribute to reduce confusion with standard XMPP presence.)</note></td>
        <td>REQUIRED</td>
      </tr>
    </table>
    <p>An example follows.</p>
    <example caption='Data format'><![CDATA[
<rap xmlns='urn:xmpp:rap:0'
     ns='urn:xmpp:jingle:apps:rtp:0'
     num='5'/>
]]></example>
  </section2>
  <section2 topic='Generation' anchor='rap-gen'>
    <p>The following business rules apply to the generation of resource application priority by the client:</p>
    <ol start='1'>
      <li><p>A client SHOULD include a &lt;rap/&gt; element for each application type it prioritizes, but SHOULD NOT do so if the priority for that application is the same as the resource's standard XMPP priority.</p></li>
      <li><p>A client MUST NOT generate a &lt;rap/&gt; element that has a 'ns' attribute whose value is "jabber:client" or that has no 'ns' attribute (since the default 'ns' is "jabber:client").</p></li>
      <li><p>The &lt;rap/&gt; element SHOULD be empty.</p></li>
    </ol>
    <p>As explained in the following sections, there are two possible transports for RAP data: standard XMPP presence and the XMPP publish-subscribe extension.</p>
  </section2>
  <section2 topic='Presence Transport' anchor='rap-presence'>
    <p>RAP data MAY be included as extended content within a standard XMPP presence stanza. This is consistent with the rule that presence stanzas need to be related to the network availability or communication preferences of the entity that provides presence information.</p>
    <p>For the three resources ("desktop", "pda", and "mobile") mentioned above, the presence stanzas received by a contact would be as follows.</p>
    <example caption='Contact receives presence from user'><![CDATA[
<presence from='juliet@capulet.lit/desktop' to='romeo@montague.lit/home'>
  <priority>10</priority>
  <rap xmlns='urn:xmpp:rap:0'
       ns='urn:xmpp:jingle:apps:rtp:0'
       num='5'/>
</presence>

<presence from='juliet@capulet.lit/pda' to='romeo@montague.lit/home'>
  <priority>5</priority>
  <rap xmlns='urn:xmpp:rap:0'
       ns='urn:xmpp:jingle:apps:rtp:0'
       num='-1'/>
</presence>

<presence from='juliet@capulet.lit/mobile' to='romeo@montague.lit/home'>
  <priority>-1</priority>
  <rap xmlns='urn:xmpp:rap:0'
       ns='urn:xmpp:jingle:apps:rtp:0'
       num='10'/>
</presence>
]]></example>
  </section2>
  <section2 topic='Pubsub Transport' anchor='rap-pubsub'>
    <p>Alternatively, RAP data MAY be provided via the XMPP &xep0060; publish-subscribe extension, specifically the &xep0163; profile thereof.</p>
    <p>For the three resources ("desktop", "pda", and "mobile") mentioned above, the pubsub notifications received by a contact would be as follows.</p>
    <example caption='Contact receives pubsub notifications from user'><![CDATA[
<message from='juliet@capulet.lit'
         id='rap1'
         to='romeo@montague.lit'
         type='headline'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:rap:0'>
      <item>
        <rap xmlns='urn:xmpp:rap:0'
             ns='urn:xmpp:jingle:apps:rtp:0'
             num='5'/>
      </item>
    </items>
  </event>
  <addresses xmlns='http://jabber.org/protocol/address'>
    <address type='replyto' jid='juliet@capulet.lit/desktop'/>
  </addresses>
</message>

<message from='juliet@capulet.lit'
         id='rap2'
         to='romeo@montague.lit'
         type='headline'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:rap:0'>
      <item>
      <rap xmlns='urn:xmpp:rap:0'
           ns='urn:xmpp:jingle:apps:rtp:0'
           num='-1'/>
      </item>
    </items>
  </event>
  <addresses xmlns='http://jabber.org/protocol/address'>
    <address type='replyto' jid='juliet@capulet.lit/pda'/>
  </addresses>
</message>

<message from='juliet@capulet.lit'
         id='rap3'
         to='romeo@montague.lit'
         type='headline'>
  <event xmlns='http://jabber.org/protocol/pubsub#event'>
    <items node='urn:xmpp:rap:0'>
      <item>
      <rap xmlns='urn:xmpp:rap:0'
           ns='urn:xmpp:jingle:apps:rtp:0'
           num='10'/>
      </item>
    </items>
  </event>
  <addresses xmlns='http://jabber.org/protocol/address'>
    <address type='replyto' jid='juliet@capulet.lit/mobile'/>
  </addresses>
</message>
]]></example>
  </section2>
</section1>

<section1 topic='Flagging the Primary Resource' anchor='flag'>
  <p>The user's XMPP server might have special information that enables it to flag a resource as primary for a given application type. For instance, the server may include a communication policy service that enables the user to define (outside the context of any presence priorities) that she would prefer to be called at her desktop computer only between the hours of 9:00 AM and 5:00 PM local time, prefer to be called on her mobile phone at all other times, and so on.</p>
  <p>To flag the primary resource related to a specific application type, the server shall add a &lt;primary/&gt; child to the relevant RAP element. Here is an example:</p>
  <example caption='Primary resource flag'><![CDATA[
<presence from='juliet@capulet.lit/mobile'>
  <priority>-1</priority>
  <rap xmlns='urn:xmpp:rap:0'
       ns='urn:xmpp:jingle:apps:rtp:0'
       num='10'>
    <primary/>
  </rap>
</presence>
]]></example>
  <p>The following business rules apply to primary resource flagging by the server:</p>
  <ol start='1'>
    <li><p>A server MAY add the &lt;primary/&gt; element to RAP data generated by the resource it determines is "most available" for a given application type.</p></li>
    <li><p>Because the default 'ns' is "jabber:client", to flag the primary resource for standard XMPP communications the server SHOULD NOT include a 'ns' attribute, SHOULD NOT include a 'num' attribute, and MUST include a &lt;primary/&gt; child.</p></li>
    <li><p>An available resource that has specified a negative priority for an application type MUST NOT be flagged as the primary resource for that application type.</p></li>
    <li><p>A client SHOULD NOT include the &lt;primary/&gt; element in RAP data that it generates; however, if a client includes a &lt;primary/&gt; element, the server SHOULD remove or overwrite the element.</p></li>
    <li><p>In response to a presence probe, a server SHOULD send presence from the primary resource first (this enables the receiving client to skip any local "most-available-resource" algorithms it might implement) if the client includes RAP data in presence.</p></li>
    <li><p>If the primary resource changes for a given application type and the client includes RAP data in presence, a server MUST broadcast updated presence information (including the &lt;primary/&gt; element) for the new primary resource. If the change in primary resource occurs because of a presence broadcast from the current primary resource, the server MUST push presence from the current primary resource (without the &lt;primary/&gt; element) before pushing presence from the new primary resource (including the &lt;primary/&gt; element).</p></li>
  </ol>
</section1>

<section1 topic='RAP-Based Message Routing' anchor='route'>
  <p>A server MAY use the RAP data provided by a client in determining how to route incoming &MESSAGE; stanzas directed to the bare JID &LOCALBARE; of a registered account. In order to enable such routing, the sender MUST include an empty &lt;route/&gt; element qualified by the 'urn:xmpp:raproute:0' namespace &VNOTE; including an 'ns' attribute corresponding to the desired application type.</p>
  <p>For example, consider a &xep0155; request sent from one user (Romeo) to another (Juliet), where the users do not share presence. Romeo wants the request to be delivered to the highest-priority resource for the "urn:xmpp:jingle:apps:rtp:0" application type.</p>
  <example caption="User requests session"><![CDATA[
<message from='romeo@montague.lit/orchard'
         to='juliet@capulet.lit'
         type='headline'>
  <thread>ffd7076498744578d10edabfe7f4a866</thread>
  <feature xmlns='http://jabber.org/protocol/feature-neg'>
    <x xmlns='jabber:x:data' type='form'>
      <title>Open chat with Romeo?</title>
      <field var='FORM_TYPE' type='hidden'>
        <value>urn:xmpp:ssn</value>
      </field>
      <field label='Accept this session?' type='boolean' var='accept'>
        <value>true</value>
        <required/>
      </field>
    </x>
  </feature>
  <route xmlns='urn:xmpp:raproute:0'
         ns='urn:xmpp:jingle:apps:rtp:0'/>
</message>
]]></example>
    <p>If Juliet's server supports RAP routing, it would then deliver the message to whichever of Juliet's resources has the highest priority for the "urn:xmpp:jingle:apps:rtp:0" application type.</p>
</section1>

<section1 topic='Determining Support' anchor='support'>
  <p>If an entity supports resource application priorities, it MUST advertise that fact by returning a feature of "urn:xmpp:rap:0", "urn:xmpp:raproute:0", or both &VNOTE; in response to &xep0030; information requests.</p>
  <example caption='Entity queries a server regarding protocol support'><![CDATA[
<iq from='juliet@capulet.lit/balcony'
    id='disco1'
    to='capulet.lit'
    type='get'>
  <query xmlns='http://jabber.org/protocol/disco#info'/>
</iq>
]]></example>
  <example caption='Server communicates protocol support for RAP'><![CDATA[
<iq from='capulet.lit'
    id='disco1'
    to='juliet@capulet.lit/balcony'
    type='result'>
  <query xmlns='http://jabber.org/protocol/disco#info'>
    <feature var='urn:xmpp:rap:0'/>
    <feature var='urn:xmpp:raproute:0'/>
  </query>
</iq>
]]></example>
  <p>In order for an application to determine whether an entity supports this protocol, where possible it SHOULD use the dynamic, presence-based profile of service discovery defined in &xep0115;. However, if an application has not received entity capabilities information from an entity, it SHOULD use explicit service discovery instead.</p>
</section1>

<section1 topic='Security Considerations' anchor='security'>
  <p>When the pubsub transport is used, client publishing of resource application priority can result in a presence leak if the node access model is "open". Care should be taken in properly configuring the pubsub node so that unauthorized entities are not able to retrieve information about the user's available resources.</p>
  <p>Server flagging of the primary resource is not known to introduce any vulnerabilities or compromises of user privacy.</p>
</section1>

<section1 topic='IANA Considerations' anchor='iana'>
  <p>This document requires no interaction with &IANA;.</p>
</section1>

<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
    <p>This specification defines the following XML namespaces:</p>
    <ul>
      <li>urn:xmpp:rap:0</li>
      <li>urn:xmpp:raproute:0</li>
    </ul>
    <p>Upon advancement of this specification from a status of Experimental to a status of Draft, the &REGISTRAR; shall add the foregoing namespaces to the registry located at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
  </section2>
  <section2 topic='Namespace Versioning' anchor='registrar-versioning'>
    &NSVER;
  </section2>
</section1>

<section1 topic='XML Schemas' anchor='schema'>
  <section2 topic='RAP' anchor='schema-rap'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:rap:0'
    xmlns='urn:xmpp:rap:0'
    elementFormDefault='qualified'>

  <xs:element name='rap'>
    <xs:complexType>
      <xs:sequence>
        <xs:element name='primary' type='empty' minOccurs='0' maxOccurs='1'/>
      </xs:sequence>
      <xs:attribute name='ns' type='xs:string' default='jabber:client'/>
      <xs:attribute name='num' type='xs:byte'/>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

]]></code>
  </section2>
  <section2 topic='RAP Routing' anchor='schema-raproute'>
    <code><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>

<xs:schema
    xmlns:xs='http://www.w3.org/2001/XMLSchema'
    targetNamespace='urn:xmpp:raproute:0'
    xmlns='urn:xmpp:raproute:0'
    elementFormDefault='qualified'>

  <xs:element name='route'>
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base='empty'>
          <xs:attribute name='ns' type='xs:string' default='jabber:client'/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>

  <xs:simpleType name='empty'>
    <xs:restriction base='xs:string'>
      <xs:enumeration value=''/>
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

]]></code>
  </section2>
</section1>
</xep>