moparisthebest/xeps
1
0
Fork 0
mirror of https://github.com/moparisthebest/xeps synced 2024-11-21 16:55:07 -05:00
Code Issues Releases Wiki Activity

1.1pre3

Browse Source 
git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1260 4b5297f7-1745-476d-ba37-a9c6900126ab
This commit is contained in:
Peter Saint-Andre 2007-09-27 22:55:53 +00:00
parent 6b6c5b5ce7
commit b93fcce851
2 changed files with 50 additions and 147 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
xep-0048.xml
View File

@ -15,7 +15,7 @@
<sig>Standards</sig>
<dependencies>
<spec>XMPP Core</spec>
<spec>XEP-0049</spec>
<spec>XEP-0060</spec>
<spec>XEP-0223</spec>
</dependencies>
<supersedes/>
@ -33,10 +33,10 @@
&pgmillard;
&stpeter;
<revision>
<version>1.1pre2</version>
<date>in progress, last updated 2007-09-24</date>
<version>1.1pre3</version>
<date>in progress, last updated 2007-09-27</date>
<initials>psa</initials>
<remark><p>Specified use of PEP as a storage mechanism in addition to existing jabber:iq:private method.</p></remark>
<remark><p>Specified use of publish-subscribe private information nodes as the preferred storage mechanism.</p></remark>
</revision>
<revision>
<version>1.0</version>
@ -72,7 +72,7 @@
<p>A storage element marked by the storage:bookmarks namespace will contain a collection of child elements, each representing a 'bookmark' to be displayed in the client. At present, only two sub-elements are defined, 'conference' for conference rooms and 'url' for normal URLs.</p>
<p>All elements under storage MUST allow a 'name' tag, which is the friendly name by which they will be displayed in the client. If an element lacks a 'name' tag, the client SHOULD generate an appropriate substitution based on the other available data.</p>
<section2 topic='The conference element' anchor='format-conference'>
<p>One of the most common uses of bookmarks will likely be to bookmark conference rooms on various Jabber servers. It is this aspect of the bookmark system which is used today by existing clients such as Exodus <note>Exodus, see &lt;<link url='http://exodus.jabberstudio.org/'>http://exodus.jabberstudio.org/</link>&gt;.</note> and Rival Messenger <note>Rival Messenger, see &lt;<link url='http://rival.chote.net'>http://rival.chote.net/</link>&gt;.</note>. In addition to the required 'jid' attribute, the conference element also possesses an 'autojoin' attribute, which determines whether or not the client should automatically join that conference room on login; this attribute is of type xs:boolean (see &w3xmlschema2;) and the default value is "false". &BOOLEANNOTE;</p>
<p>One of the most common uses of bookmarks will likely be to bookmark conference rooms on various Jabber servers. It is this aspect of the bookmark system which is used today by existing clients. In addition to the required 'jid' attribute, the conference element also possesses an 'autojoin' attribute, which determines whether or not the client should automatically join that conference room on login; this attribute is of type xs:boolean (see &w3xmlschema2;) and the default value is "false". &BOOLEANNOTE;</p>
<p>The conference element MAY also contain 'nick' and 'password' sub-elements; the XML character data from these elements should be used when joining the room from the bookmark. Password is, of course, important for joining potentially password-protected &xep0045; rooms.</p>
<example caption='An example of the conference element'><![CDATA[
<storage xmlns='storage:bookmarks'>
@ -99,12 +99,11 @@
</section2>
</section1>
<section1 topic='Storage Methods' anchor='storage'>
<p>It is recommended to use either &xep0060; or &xep0049; in order to store the data format defined above; however, other methods could be used, such as HTTP.</p>
<section2 topic='Publish-Subscribe' anchor='storage-pubsub'>
<p>A client may use Publish-Subscribe (XEP-0060) for data storage, specifically through the use of personal data nodes hosted at the user's virtual publish-subscribe service as described in &xep0223;.</p>
<section3 topic='Uploading Data' anchor='storage-pubsub-upload'>
<example caption='Client uploads data'><![CDATA[
<section1 topic='Storage' 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-0048-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:bookmarks'>
@ -134,14 +133,14 @@
</publish-options>
</pubsub>
</iq>
]]></example>
<example caption='Server acknowledges successful storage'><![CDATA[
]]></example>
<example caption='Server acknowledges successful storage'><![CDATA[
<iq to='juliet@capulet.lit/balcony' type='result' id='pip1'/>
]]></example>
</section3>
<section3 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[
]]></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'
@ -181,18 +180,18 @@
</items>
</event>
</message>
]]></example>
</section3>
<section3 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[
]]></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:bookmarks'/>
</pubsub>
</iq>
]]></example>
<example caption='Server returns all items'><![CDATA[
]]></example>
<example caption='Server returns all items'><![CDATA[
<iq type='result'
to='juliet@capulet.lit/randomID'
id='retrieve1'>
@ -211,60 +210,12 @@
</items>
</pubsub>
</iq>
]]></example>
</section3>
</section2>
<section2 topic='Private XML Storage' anchor='storage-privatexml'>
<p>A client may use Private Data Storage (XEP-0049) for data storage.</p>
<section3 topic='Uploading Data' anchor='storage-privatexml-upload'>
<example caption='Client uploads data'><![CDATA[
<iq type='set' id='a1'>
<query xmlns='jabber:iq:private'>
<storage xmlns='storage:bookmarks'>
<conference name='Council of Oberon'
autojoin='true'
jid='council@conference.underhill.org'>
<nick>Puck</nick>
<password>titania</password>
</conference>
</storage>
</query>
</iq>
]]></example>
<example caption='Server acknowledges successful storage'><![CDATA[
<iq type='result' id='priv1'/>
]]></example>
<p>Note: The private XML storage protocol does not provide notifications to all connected resources, only an acknowledgement to the uploading resource.</p>
</section3>
<section3 topic='Retrieving Data' anchor='storage-privatexml-retrieve'>
<example caption='Client requests stored data'><![CDATA[
<iq type='get' id='a2'>
<query xmlns='jabber:iq:private'>
<storage xmlns='storage:bookmarks'/>
</query>
</iq>
]]></example>
<example caption='Server returns stored data'><![CDATA[
<iq type='result' id='a2'>
<query xmlns='jabber:iq:private'>
<storage xmlns='storage:bookmarks'>
<conference name='Council of Oberon'
autojoin='true'
jid='council@conference.underhill.org'>
<nick>Puck</nick>
<password>titania</password>
</conference>
</storage>
</query>
</iq>
]]></example>
</section3>
]]></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>
<p>Security considerations related to private XML storage are described in XEP-0049.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>

98
xep-0145.xml
View File

@ -16,7 +16,8 @@
<approver>Council</approver>
<dependencies>
<spec>XMPP Core</spec>
<spec>XEP-0049</spec>
<spec>XEP-0060</spec>
<spec>XEP-0223</spec>
</dependencies>
<supersedes/>
<supersededby/>
@ -32,10 +33,10 @@
</author>
&stpeter;
<revision>
<version>1.1pre2</version>
<date>in progress, last updated 2007-09-24</date>
<version>1.1pre3</version>
<date>in progress, last updated 2007-09-27</date>
<initials>psa</initials>
<remark><p>Specified use of PEP as a storage mechanism in addition to existing jabber:iq:private method.</p></remark>
<remark><p>Specified use of publish-subscribe private information nodes as the preferred storage mechanism.</p></remark>
</revision>
<revision>
<version>1.0</version>
@ -78,11 +79,10 @@
</section1>
<section1 topic='Storage Methods' anchor='storage'>
<p>It is recommended to use either &xep0060; or &xep0049; in order to store the data format defined above; however, other methods could be used, such as HTTP.</p>
<section2 topic='Publish-Subscribe' anchor='storage-pubsub'>
<p>A client may use Publish-Subscribe (XEP-0060) for data storage, specifically through the use of personal data nodes hosted at the user's virtual publish-subscribe service as described in &xep0223;.</p>
<section3 topic='Uploading Data' anchor='storage-pubsub-upload'>
<example caption='Client uploads data'><![CDATA[
<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'>
@ -112,14 +112,14 @@
</publish-options>
</pubsub>
</iq>
]]></example>
<example caption='Server acknowledges successful storage'><![CDATA[
<iq to='juliet@capulet.lit/balcony' type='result' id='pip1'/>
]]></example>
</section3>
<section3 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[
]]></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'
@ -159,18 +159,18 @@
</items>
</event>
</message>
]]></example>
</section3>
<section3 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[
]]></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[
]]></example>
<example caption='Server returns all items'><![CDATA[
<iq type='result'
to='juliet@capulet.lit/randomID'
id='retrieve1'>
@ -189,60 +189,12 @@
</items>
</pubsub>
</iq>
]]></example>
</section3>
</section2>
<section2 topic='Private XML Storage' anchor='storage-privatexml'>
<p>A client may use Private Data Storage (XEP-0049) for data storage.</p>
<section3 topic='Uploading Data' anchor='storage-privatexml-upload'>
<example caption='Client uploads data'><![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>
<example caption='Server acknowledges successful storage'><![CDATA[
<iq type='result' id='priv1'/>
]]></example>
<p>Note: The private XML storage protocol does not provide notifications to all connected resources, only an acknowledgement to the uploading resource.</p>
</section3>
<section3 topic='Retrieving Data' anchor='storage-privatexml-retrieve'>
<example caption='Client requests stored data'><![CDATA[
<iq type='get' id='a2'>
<query xmlns='jabber:iq:private'>
<storage xmlns='storage:rosternotes'/>
</query>
</iq>
]]></example>
<example caption='Server returns stored data'><![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>
</section3>
]]></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>
<p>Security considerations related to private XML storage are described in <cite>XEP-0049</cite>.</p>
</section1>
<section1 topic='IANA Considerations' anchor='iana'>