moparisthebest
/
xeps
mirror of https://github.com/moparisthebest/xeps
1
0
Fork 0
Code Issues Releases Wiki Activity

1.0 DRAFT 

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@4074 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2010-03-12 17:04:29 +00:00
parent 87799713db
commit c8aca67bc7
1 changed files with 107 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
xep-0227.xml
View File

@ -10,8 +10,7 @@
<abstract>This document specifies a file format for importing and exporting user data to and from XMPP-IM servers.</abstract>
&LEGALNOTICE;
<number>0227</number>
<status>Proposed</status>
<lastcall>2009-11-06</lastcall>
<status>Draft</status>
<type>Standards Track</type>
<sig>Standards</sig>
<approver>Council</approver>
@ -22,7 +21,10 @@
</dependencies>
<supersedes/>
<supersededby/>
<shortname>TO BE ASSIGNED</shortname>
<shortname>pie</shortname>
<schemaloc>
<url>http://xmpp.org/schemas/pie.xsd</url>
</schemaloc>
<author>
<firstname>Magnus</firstname>
<surname>Henoch</surname>
@ -35,6 +37,12 @@
<email>waqas20@gmail.com</email>
<jid>waqas@jaim.at</jid>
</author>
<revision>
<version>1.0</version>
<date>2010-03-12</date>
<initials>psa</initials>
<remark><p>Per a vote of the XMPP Council, advanced specification from Experimental to Draft; simultaneously the XMPP Registrar issued a namespace of "urn:xmpp:pie:0".</p></remark>
</revision>
<revision>
<version>0.3</version>
<date>2009-10-16</date>
@ -100,11 +108,11 @@
</section1>
<section1 topic='File format' anchor='fileformat'>
<p>Data is contained in an XML document, whose root element is &lt;server-data/&gt; qualified by the 'http://www.xmpp.org/extensions/xep-0227.html#ns' namespace &NSNOTE;.</p>
<p>Data is contained in an XML document, whose root element is &lt;server-data/&gt; qualified by the 'urn:xmpp:pie:0' namespace &NSNOTE;.</p>
<example caption='The root element'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
[ ... ]
</server-data>
]]>
@ -121,15 +129,15 @@
<example caption='The host element'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
[ ... ]
</host>
<host jid='montague.net'>
[ ... ]
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='Users' anchor='users'>
@ -137,7 +145,7 @@
<example caption='The user element'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
[ ... ]
@ -157,7 +165,7 @@
<example caption='The roster'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
<query xmlns='jabber:iq:roster'>
@ -169,8 +177,8 @@
</query>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='Offline Messages' anchor='offlinemessages'>
@ -178,7 +186,7 @@
<example caption='Offline messages'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
<offline-messages>
@ -196,8 +204,8 @@
</offline-messages>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='Private XML Storage' anchor='privatexmlstorage'>
@ -205,7 +213,7 @@
<example caption='Private XML Storage'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='shakespeare.lit'>
<user name='hamlet' password='2b0Rnot2B'>
<query xmlns="jabber:iq:private">
@ -215,8 +223,8 @@
</query>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='vCards' anchor='vcards'>
@ -224,7 +232,7 @@
<example caption='vCards'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
<vCard xmlns='vcard-temp'>
@ -232,8 +240,8 @@
</vCard>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='Privacy Lists' anchor='privacy-lists'>
@ -241,7 +249,7 @@
<example caption='Privacy lists'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
<query xmlns='jabber:iq:privacy'>
@ -263,8 +271,8 @@
</query>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
<section2 topic='Incoming Subscription Requests' anchor='incoming-subscription-requests'>
@ -272,7 +280,7 @@
<example caption='Incoming subscription requests'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'>
<server-data xmlns='urn:xmpp:pie:0'>
<host jid='capulet.com'>
<user name='juliet' password='s3crEt'>
<presence xmlns='jabber:client'
@ -286,8 +294,8 @@
from='mercutio@montague.net'/>
</user>
</host>
</server-data> ]]>
</example>
</server-data>
]]></example>
</section2>
</section1>
@ -302,33 +310,30 @@
<example caption='The main file, which includes host files'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<server-data xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'
<server-data xmlns='urn:xmpp:pie:0'
xmlns:xi='http://www.w3.org/2001/XInclude'>
<xi:include href='capulet.com.xml'/>
<xi:include href='montague.net.xml'/>
</server-data>
]]>
</example>
]]></example>
<p>Each host file contains a &lt;host/&gt; element, which contains nothing but one &lt;include/&gt; element for each user of the host. The file included for a certain user is placed in a subdirectory whose name is the JID of the host, and is named by appending ".xml" to the node part of the user's JID, e.g. "capulet.com/juliet.xml".</p>
<example caption='The host file, which includes user files'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<host xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'
<host xmlns='urn:xmpp:pie:0'
xmlns:xi='http://www.w3.org/2001/XInclude'
jid='capulet.com'>
<xi:include href='capulet.com/juliet.xml'/>
<xi:include href='capulet.com/mercutio.xml'/>
</host>
]]>
</example>
]]></example>
<p>Each user file contains a &lt;user/&gt; element, and includes all data relating to that user.</p>
<example caption='The user file'><![CDATA[
<?xml version='1.0' encoding='UTF-8'?>
<user xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'
<user xmlns='urn:xmpp:pie:0'
name='juliet' password='s3crEt'>
<query xmlns='jabber:iq:roster'>
<item jid='romeo@montague.net'
@ -358,6 +363,7 @@
</example>
<p>The definition of JIDs ensures that this generates valid file names on traditional Unix-like file systems, except for possible length constraints. However, various constraints may force an exporting server to alter this scheme. In any case, the importing server MUST NOT rely on this layout, but MUST do proper XInclude processing.</p>
</section2>
</section1>
@ -368,12 +374,19 @@
</section1>
<section1 topic='IANA Considerations' anchor='iana'>
<p>This document requires no interaction with the Internet Assigned Numbers Authority (IANA).</p>
<p>This document requires no interaction with &IANA;.</p>
</section1>
<section1 topic='XMPP Registrar Considerations' anchor='registrar'>
<section2 topic='Protocol Namespaces' anchor='ns'>
<p>Until this specification advances to a status of Draft, its associated namespace shall be "http://www.xmpp.org/extensions/xep-0227.html#ns"; upon advancement of this specification, the &REGISTRAR; shall issue a permanent namespace in accordance with the process defined in Section 4 of &xep0053;.</p>
<section2 topic='Protocol Namespaces' anchor='registrar-ns'>
<p>This specification defines the following XML namespace:</p>
<ul>
<li>urn:xmpp:pie:0</li>
</ul>
<p>The &REGISTRAR; includes the foregoing namespace in its registry at &NAMESPACES;, as described in Section 4 of &xep0053;.</p>
</section2>
<section2 topic='Protocol Versioning' anchor='registrar-versioning'>
&NSVER;
</section2>
</section1>
@ -383,10 +396,17 @@
<xs:schema
xmlns:xs='http://www.w3.org/2001/XMLSchema'
targetNamespace='http://www.xmpp.org/extensions/xep-0227.html#ns'
xmlns='http://www.xmpp.org/extensions/xep-0227.html#ns'
targetNamespace='urn:xmpp:pie:0'
xmlns='urn:xmpp:pie:0'
elementFormDefault='qualified'>
<xs:annotation>
<xs:documentation>
The protocol documented by this schema is defined in
XEP-0227: http://xmpp.org/extensions/xep-0227.html
</xs:documentation>
</xs:annotation>
<xs:element name='server-data'>
<xs:complexType>
<xs:sequence>