0.2

git-svn-id: file:///home/ksmith/gitmigration/svn/xmpp/trunk@1718 4b5297f7-1745-476d-ba37-a9c6900126ab

xep-0222.xml

@@ -6,12 +6,12 @@
 <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
 <xep>
 <header>
-  <title>Persisting Objects via Pubsub</title>
+  <title>Best Practices for Persistent Storage of Public Data via Publish-Subscribe</title>
-  <abstract>This document specifies protocol semantics for using the XMPP publish-subscribe extension to persistently store semi-public data objects such as public keys and personal profiles.</abstract>
+  <abstract>This specification defines best practices for using the XMPP publish-subscribe extension to persistently store semi-public data objects such as public keys and personal profiles.</abstract>
   &LEGALNOTICE;
   <number>0222</number>
   <status>Experimental</status>
-  <type>Standards Track</type>
+  <type>Informational</type>
   <sig>Standards JIG</sig>
   <approver>Council</approver>
   <dependencies>
@@ -25,6 +25,12 @@
   <supersededby/>
   <shortname>TO BE ASSIGNED</shortname>
   &stpeter;
+  <revision>
+    <version>0.2</version>
+    <date>2008-03-03</date>
+    <initials>psa</initials>
+    <remark><p>Removed hokey acronym; changed type to Informational; clarified text.</p></remark>
+  </revision>
   <revision>
     <version>0.1</version>
     <date>2007-08-08</date>
@@ -41,10 +47,9 @@
 
 <section1 topic='Introduction' anchor='intro'>
   <section2 topic='Motivation' anchor='motivation'>
-    <p>&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID &LOCALBARE;. However, personal eventing (PEP) is not optimized for the persistent storage of semi-public data objects such as public keys or user profiles. Therefore this document defines a set of best practices that enable an IM user to persistently store semi-public data objects at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for persisting objects (we call such a node a "POP node").</p>
+    <p>&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID &LOCALBARE;. However, the default node configuration options associated with PEP nodes are not optimized for the persistent storage of semi-public data objects such as public keys or user profiles. Therefore this document defines a set of best practices that enable IM users to persistently store semi-public data objects at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for persisting objects.</p>
   </section2>
   <section2 topic='How It Works' anchor='howitworks'>
-    <p>This section provides a friendly introduction to persisting objects via pubsub (a.k.a. POP).</p>
     <p>Imagine that you are a Shakespearean character named Juliet and that you want to persistently store information such as your public keys (see &xep0189;) and user profile (see &xep0154;).</p>
     <p>We assume that you have three contacts with the following relationship to you:</p>
     <ol start='1'>
@@ -57,7 +62,7 @@
     <example caption='Publishing a key'><![CDATA[
 <iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-    <publish node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <publish node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -95,17 +100,17 @@
     <p>Your publish request is a standard pubsub request except that:</p>
     <ol start='1'>
       <li>The item is persisted (pubsub#persist_items is true).</li>
-      <li>The last published item is never sent (i.e., items are pushed out only when modified).</li>
+      <li>The last published item is never sent (pubsub#last_published_item is set to "never" so that items are pushed out only when modified).</li>
-      <li>In this case, access is limited to people in your Friends roster group.</li>
     </ol>
-    <p>If all goes well (see <link url='#publish'>Publishing an Item</link>), your key will be pushed out to all appropriate individuals (in this case only Romeo). In particular, Romeo receives your key because he has auto-subscribed to the virtual pubsub service at your bare JID via a presence subscription and because his &xep0115; data indicated that he is interested in the "http://www.xmpp.org/extensions/xep-0189.html#ns" payload type.</p>
+    <p>(In this case, access is limited to people in your Friends roster group.)</p>
+    <p>If all goes well (see <link url='#publish'>Publishing an Item</link>), your key will be pushed out to all appropriate individuals (in this case only Romeo). In particular, Romeo receives your key because he has auto-subscribed to the virtual pubsub service at your bare JID via a presence subscription and because his &xep0115; data indicated that he is interested in the "urn:xmpp:tmp:pubkey" payload type.</p>
     <example caption='Appropriate entities receive event notifications'><![CDATA[
 <message from='juliet@capulet.lit'
          to='romeo@montague.lit/orchard'
          type='headline'
          id='keyfoo1'>
   <event xmlns='http://jabber.org/protocol/pubsub#event'>
-    <items node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <items node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -128,7 +133,7 @@
          type='headline'
          id='keyfoo2'>
   <event xmlns='http://jabber.org/protocol/pubsub#event'>
-    <items node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <items node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -149,7 +154,7 @@
          type='headline'
          id='keyfoo3'>
   <event xmlns='http://jabber.org/protocol/pubsub#event'>
-    <items node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <items node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -170,7 +175,7 @@
 </section1>
 
 <section1 topic='Concepts and Approach' anchor='approach'>
-  <p>Persisting objects via pubsub ("POP") re-uses the concepts already defined in <cite>XEP-0060</cite> and <cite>XEP-0163</cite>. In order to optimize for object persistence instead of transient event notifications, a POP node MUST be configured as follows:</p>
+  <p>The best practices described herein re-use the concepts already defined in <cite>XEP-0060</cite> and <cite>XEP-0163</cite>. In order to optimize for object persistence instead of transient event notifications, a node MUST be configured as follows:</p>
   <ol start='1'>
     <li>Set pubsub#persist_items to true.</li>
     <li>Set pubsub#last_published_item to "never".</li>
@@ -183,7 +188,7 @@
   <example caption='Account owner publishes item'><![CDATA[
 <iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-    <publish node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <publish node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -204,7 +209,7 @@
   <example caption='Publishing a key'><![CDATA[
 <iq from='juliet@capulet.lit/balcony' type='set' id='pub1'>
   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
-    <publish node='http://www.xmpp.org/extensions/xep-0189.html#ns'>
+    <publish node='urn:xmpp:tmp:pubkey'>
       <item id='julietRSAkey1hash'>
         <KeyInfo xmlns='http://www.w3.org/2000/09/xmldsig#'>
           <KeyName>julietRSAkey1hash</KeyName>
@@ -242,8 +247,8 @@
   <p>If the publication logic dictates that event notifications shall be sent, the account owner's server generates notifications and sends them to all appropriate entities as described in the Receiving Event Notifications section of <cite>XEP-0163</cite>.</p>
 </section1>
 
-<section1 topic='Service Discovery' anchor='disco'>
+<section1 topic='Determining Support' anchor='support'>
-  <p>Before an account owner attempts to complete the use cases defined herein, its client SHOULD verify that the account owner's server supports both PEP and the "publish-options" feature; to do so, it MUST send a &xep0030; information request to the server:</p>
+  <p>Before an account owner attempts to complete the use cases defined herein, its client SHOULD verify that the account owner's server supports both PEP and the "publish-options" feature; to do so, it MUST send a &xep0030; information request to the server (or cache <cite>Entity Capabilities</cite> information received from the server).</p>
   <example caption='Account owner queries server regarding protocol support'><![CDATA[
 <iq from='juliet@capulet.lit/balcony'
     to='capulet.lit'

xep-0223.xml

@@ -6,12 +6,12 @@
 <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
 <xep>
 <header>
-  <title>Private Information via Pubsub</title>
+  <title>Best Practices for Persistent Storage of Private Data via Publish-Subscribe</title>
-  <abstract>This document specifies protocol semantics for using the XMPP publish-subscribe extension to persistently store private information such as bookmarks and client configuration options.</abstract>
+  <abstract>This specification defines best practices for using the XMPP publish-subscribe extension to persistently store private information such as bookmarks and client configuration options.</abstract>
   &LEGALNOTICE;
   <number>0223</number>
   <status>Experimental</status>
-  <type>Standards Track</type>
+  <type>Informational</type>
   <sig>Standards JIG</sig>
   <approver>Council</approver>
   <dependencies>
@@ -25,6 +25,12 @@
   <supersededby/>
   <shortname>TO BE ASSIGNED</shortname>
   &stpeter;
+  <revision>
+    <version>0.2</version>
+    <date>2008-03-03</date>
+    <initials>psa</initials>
+    <remark><p>Removed hokey acronym; changed type to Informational; clarified text.</p></remark>
+  </revision>
   <revision>
     <version>0.1</version>
     <date>2007-08-08</date>
@@ -41,13 +47,12 @@
 
 <section1 topic='Introduction' anchor='intro'>
   <section2 topic='Motivation' anchor='motivation'>
-    <p>&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID &LOCALBARE;. However, personal eventing (PEP) is not optimized for the persistent storage of data objects that are meant to be accessed only by the account owner, &#224; la &xep0049;. Therefore this document defines a set of best practices that enable a user to persistently store private information at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for storing private information (we call such a node a "PIP node").</p>
+    <p>&xep0163; introduced the idea of a virtual &xep0060; service associated with an IM user's bare JID &LOCALBARE;. However, the default configuration of PEP nodes is not optimized for the persistent storage of data objects that are meant to be accessed only by the account owner, &#224; la &xep0049;. Therefore this document defines a set of best practices that enable IM users to persistently store private information at their virtual pubsub service; in effect, we "sub-class" PEP by showing how a particular pubsub node can be configured for storing private data.</p>
   </section2>
   <section2 topic='How It Works' anchor='howitworks'>
-    <p>This section provides a friendly introduction to private information via pubsub (a.k.a. PIP).</p>
     <p>Imagine that you are a Shakespearean character named Juliet and that you want to persistently store some private information such as bookmarks (&xep0048;).</p>
     <p>We assume that your server (capulet.lit) supports PEP along with the "publish-options" feature, and that your client discovered that support when you logged in.</p>
-    <p>You want to start bookmarking &xep0045; rooms so your client stores that data privately:</p>
+    <p>You want to start bookmarking &xep0045; rooms, so your client stores that data privately.</p>
     <example caption='Storing bookmarks'><![CDATA[
 <iq from='juliet@capulet.lit/balcony' type='set' id='pdp1'>
   <pubsub xmlns='http://jabber.org/protocol/pubsub'>
@@ -81,7 +86,7 @@
     ]]></example>
     <p>Your publish request is a standard pubsub request except that:</p>
     <ol start='1'>
-      <li>The item is persisted (pubsub#persist_items is true).</li>
+      <li>The item is persisted (pubsub#persist_items is set to true).</li>
       <li>In this case, access is limited to yourself (the "whitelist" access model defaults to allowing access for the account owner, i.e., you).</li>
     </ol>
     <p>If all goes well (see <link url='#publish'>Storing Data</link>), your bookmarks will be stored and the information will be pushed out to all of your resources (here "balcony" and "chamber").</p>
@@ -131,10 +136,10 @@
 </section1>
 
 <section1 topic='Concepts and Approach' anchor='approach'>
-  <p>Personal information via pubsub ("PIP") re-uses the concepts already defined in <cite>XEP-0060</cite> and <cite>XEP-0163</cite>. In order to optimize for object persistence of private information instead of transient event notifications related to semi-public data, a PIP node MUST be configured as follows:</p>
+  <p>The best practices defined herein re-use the concepts already defined in <cite>XEP-0060</cite> and <cite>XEP-0163</cite>. In order to optimize for object persistence of private information instead of transient event notifications related to semi-public data, a node MUST be configured as follows:</p>
   <ol start='1'>
-    <li>Set pubsub#access_model to "whitelist".</li>
     <li>Set pubsub#persist_items to true.</li>
+    <li>Set pubsub#access_model to "whitelist".</li>
   </ol>
 </section1>
 
@@ -194,8 +199,8 @@
   <p>If the publication logic dictates that event notifications shall be sent, the account owner's server generates notifications and sends them to all appropriate entities as described in the Receiving Event Notifications section of <cite>XEP-0163</cite>.</p>
 </section1>
 
-<section1 topic='Service Discovery' anchor='disco'>
+<section1 topic='Determining Support' anchor='support'>
-  <p>Before an account owner attempts to complete any of the use cases defined herein, its client SHOULD verify that the account owner's server supports both PEP and the "publish-options" feature; to do so, it MUST send a &xep0030; information request to the server:</p>
+  <p>Before an account owner attempts to complete any of the use cases defined herein, its client SHOULD verify that the account owner's server supports both PEP and the "publish-options" feature; to do so, it MUST send a &xep0030; information request to the server (or cache <cite>Entity Capabilities</cite> information received from the server).</p>
   <example caption='Account owner queries server regarding protocol support'><![CDATA[
 <iq from='juliet@capulet.lit/balcony'
     to='capulet.lit'