mirror of
https://github.com/moparisthebest/xeps
synced 2024-11-22 01:02:17 -05:00
e825713fc1
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@287 4b5297f7-1745-476d-ba37-a9c6900126ab
155 lines
7.0 KiB
XML
155 lines
7.0 KiB
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>Delayed Delivery</title>
|
|
<abstract>This document defines an XMPP protocol extension for communicating the fact that an XML stanza has been delivered with a delay.</abstract>
|
|
&LEGALNOTICE;
|
|
<number>0203</number>
|
|
<status>Experimental</status>
|
|
<type>Standards Track</type>
|
|
<jig>Standards JIG</jig>
|
|
<approver>Council</approver>
|
|
<dependencies>
|
|
<spec>XMPP Core</spec>
|
|
<spec>XEP-0082</spec>
|
|
</dependencies>
|
|
<supersedes>
|
|
<spec>XEP-0091</spec>
|
|
</supersedes>
|
|
<supersededby/>
|
|
<shortname>Not yet assigned</shortname>
|
|
&stpeter;
|
|
<revision>
|
|
<version>0.1</version>
|
|
<date>2006-12-20</date>
|
|
<initials>psa</initials>
|
|
<remark><p>Initial version.</p></remark>
|
|
</revision>
|
|
<revision>
|
|
<version>0.0.1</version>
|
|
<date>2006-12-19</date>
|
|
<initials>psa</initials>
|
|
<remark>First draft.</remark>
|
|
</revision>
|
|
</header>
|
|
<section1 topic='Introduction' anchor='intro'>
|
|
<p>Although the XMPP protocol extension defined in &xep0091; provides a way to communicate that an XML stanza (typically a &MESSAGE; or &PRESENCE; stanza) has been delivered with a delay, the timestamp format defined in that document does not adhere to the recommended date and time profiles for XMPP protocols defined in &xep0082;. Therefore, this document defines a replacement for <cite>XEP-0091</cite> which enables communication of delayed delivery information while adhering to <cite>XEP-0082</cite>.</p>
|
|
</section1>
|
|
<section1 topic='Protocol Definition' anchor='protocol'>
|
|
<p>The XML namespace defined herein is used to provide timestamp information about data stored for later delivery. The most common uses of this namespace are to stamp:</p>
|
|
<ul>
|
|
<li>A message that is sent to an offline entity and stored for later delivery (see &xep0160;).</li>
|
|
<li>The last available presence stanza sent by a connected client to a server.</li>
|
|
<li>Messages cached by a &xep0045; room for delivery to new participants when they join the room.</li>
|
|
</ul>
|
|
<p>Information about the delivery delay is communicated by adding to the <message/> or <presence/> stanza one and only one <delay/> child qualified by a namespace to be issued when this specification advances to a status of Draft. This information is added by the server or component that delivers the stanza. The following attributes are defined for the <delay/> element:</p>
|
|
<table caption='Defined Attributes'>
|
|
<tr>
|
|
<th>Element</th>
|
|
<th>Definition</th>
|
|
<th>Inclusion</th>
|
|
</tr>
|
|
<tr>
|
|
<td><from/></td>
|
|
<td>The Jabber ID of the entity that originally sent the XML stanza or that delayed the delivery of the stanza (e.g., the address of a multi-user chat room).</td>
|
|
<td>RECOMMENDED</td>
|
|
</tr>
|
|
<tr>
|
|
<td><stamp/></td>
|
|
<td>The time when the XML stanza was originally sent. The format MUST adhere to the dateTime format specified in <cite>XEP-0082</cite> and MUST be expressed in UTC.</td>
|
|
<td>REQUIRED</td>
|
|
</tr>
|
|
</table>
|
|
<p>In addition, the <delay/> element MAY contain XML character data that provides a natural-language description of the reason for the delay.</p>
|
|
</section1>
|
|
<section1 topic='Examples' anchor='examples'>
|
|
<example caption='Receiving a Message Sent While Offline'><![CDATA[
|
|
<message
|
|
from='romeo@montague.net/orchard'
|
|
to='juliet@capulet.com'
|
|
type='chat'>
|
|
<body>
|
|
O blessed, blessed night! I am afeard.
|
|
Being in night, all this is but a dream,
|
|
Too flattering-sweet to be substantial.
|
|
</body>
|
|
<delay xmlns='http://www.xmpp.org/extensions/xep-0203.html#ns'
|
|
from='capulet.com'
|
|
stamp='2002-09-10T23:08:25Z'>
|
|
Offline Storage
|
|
</delay>
|
|
</message>
|
|
]]></example>
|
|
<example caption='Receiving the Last Presence Update of Another Entity'><![CDATA[
|
|
<presence from='juliet@capulet.com/balcony' to='romeo@montague.net'>
|
|
<status>anon!</status>
|
|
<show>xa</show>
|
|
<priority>1</priority>
|
|
<delay xmlns='http://www.xmpp.org/extensions/xep-0203.html#ns'
|
|
from='juliet@capulet.com/balcony'
|
|
stamp='20020910T23:41:07'/>
|
|
</presence>
|
|
]]></example>
|
|
<example caption='Receiving Cached Messages from a Conference Room'><![CDATA[
|
|
<message
|
|
from='coven@macbeth.shakespeare.lit/secondwitch'
|
|
to='macbeth@shakespeare.lit/laptop'
|
|
type='groupchat'>
|
|
<body>
|
|
By the pricking of my thumbs,
|
|
Something wicked this way comes.
|
|
Open, locks,
|
|
Whoever knocks!
|
|
</body>
|
|
<delay xmlns='http://www.xmpp.org/extensions/xep-0203.html#ns'
|
|
from='coven@macbeth.shakespeare.lit'
|
|
stamp='20020910T23:05:37'/>
|
|
</message>
|
|
]]></example>
|
|
</section1>
|
|
<section1 topic='Implementation Notes' anchor='impl'>
|
|
<p>This protocol was designed in a way that makes migration from <cite>XEP-0091</cite> straightforward. All attributes present in the 'jabber:x:delay' namespace are present in the namespace defined herein. However, this document specifies a different format for the value of the <stamp> attribute (compliant with <cite>XEP-0082</cite>).</p>
|
|
<p>Implementations that support <cite>XEP-0091</cite> should support the protocol defined herein as soon as possible, but should continue to support the protocol defined in <cite>XEP-0091</cite> for backwards compatibility until the status of that specification is changed to Obsolete.</p>
|
|
</section1>
|
|
<section1 topic='Security Considerations' anchor='security'>
|
|
<p>Delayed delivery data can expose information about the sender's presence on the network at some time in the past. However, this introduces no new vulnerabilities, since the same information would have been available in real time.</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 Namespace' anchor='ns'>
|
|
<p>Until this specification advances to a status of Draft, its associated namespace shall be "http://www.xmpp.org/extensions/xep-0203.html#ns"; upon advancement of this specification, the XMPP Registrar shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.</p>
|
|
</section2>
|
|
</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='http://www.xmpp.org/extensions/xep-0203.html#ns'
|
|
xmlns='http://www.xmpp.org/extensions/xep-0203.html#ns'
|
|
elementFormDefault='qualified'>
|
|
|
|
<xs:element name='delay'>
|
|
<xs:complexType>
|
|
<xs:simpleContent>
|
|
<xs:extension base='xs:string'>
|
|
<xs:attribute name='from' type='xs:string' use='optional'/>
|
|
<xs:attribute name='stamp' type='xs:string' use='required'/>
|
|
</xs:extension>
|
|
</xs:simpleContent>
|
|
</xs:complexType>
|
|
</xs:element>
|
|
|
|
</xs:schema>
|
|
]]></code>
|
|
</section1>
|
|
</xep>
|