No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

xep-0182.xml 4.5KB

  1. <?xml version='1.0' encoding='UTF-8'?>
  2. <!DOCTYPE xep SYSTEM 'xep.dtd' [
  3. <!ENTITY % ents SYSTEM 'xep.ent'>
  4. %ents;
  5. ]>
  6. <?xml-stylesheet type='text/xsl' href='xep.xsl'?>
  7. <xep>
  8. <header>
  9. <title>Application-Specific Error Conditions</title>
  10. <abstract>This document defines a registry of application-specific error conditions.</abstract>
  12. <number>0182</number>
  13. <status>Active</status>
  14. <type>Procedural</type>
  15. <sig>Standards</sig>
  16. <approver>Council</approver>
  17. <dependencies>
  18. <spec>XMPP Core</spec>
  19. </dependencies>
  20. <supersedes/>
  21. <supersededby/>
  22. <shortname>errors</shortname>
  23. <registry/>
  24. &stpeter;
  25. <revision>
  26. <version>1.1</version>
  27. <date>2008-03-05</date>
  28. <initials>psa</initials>
  29. <remark><p>Changed namespace from to urn:xmpp:errors.</p></remark>
  30. </revision>
  31. <revision>
  32. <version>1.0</version>
  33. <date>2006-05-16</date>
  34. <initials>psa</initials>
  35. <remark><p>Per a vote of the Jabber Council, advanced status to Active; also added example.</p></remark>
  36. </revision>
  37. <revision>
  38. <version>0.2</version>
  39. <date>2006-04-28</date>
  40. <initials>psa</initials>
  41. <remark><p>Added note about scope of registry.</p></remark>
  42. </revision>
  43. <revision>
  44. <version>0.1</version>
  45. <date>2006-03-23</date>
  46. <initials>psa</initials>
  47. <remark><p>Initial version.</p></remark>
  48. </revision>
  49. <revision>
  50. <version>0.0.1</version>
  51. <date>2006-03-21</date>
  52. <initials>psa</initials>
  53. <remark><p>First draft.</p></remark>
  54. </revision>
  55. </header>
  56. <section1 topic='Introduction' anchor='intro'>
  57. <p>&xmppcore; specifies that an XMPP error stanza may include a child element qualified by an XML namespace other than 'urn:ietf:params:xml:ns:xmpp-stanzas'. This enables any XMPP protocol extension to define its own application-specific error conditions, such as the following:</p>
  58. <example caption='An Application-Specific Error Condition (invalid-jid)'><![CDATA[
  59. <iq type='error' from='pubsub.shakespeare.lit' to='francisco@denmark.lit/barracks' id='sub1'>
  60. <pubsub xmlns=''>
  61. <subscribe node='blogs/princely_musings' jid='bernardo@denmark.lit'/>
  62. </pubsub>
  63. <error type='modify'>
  64. <bad-request xmlns='urn:ietf:params:xml:ns:xmpp-stanzas'/>
  65. <invalid-jid xmlns=''/>
  66. </error>
  67. </iq>
  68. ]]></example>
  69. <p>Although the inclusion of application-specific error conditions introduces a great deal of flexibility, it may also lead to confusion regarding possible conditions. Therefore, this document defines a registry of application-specific error conditions, to be maintained by the &REGISTRAR;. In addition, this document registers a namespace of 'urn:xmpp:errors' as a fallback namespace for generalized error conditions that are not specific to a particular protocol (e.g., &lt;stanza-too-big/&gt; as a particular form of the &notacceptable; condition).</p>
  70. </section1>
  71. <section1 topic='XMPP Registrar Considerations' anchor='registrar'>
  72. <section2 topic='Application-Specific Error Conditions Registry' anchor='registrar-conditions'>
  73. <p>The XMPP Registrar maintains a registry of application-specific error conditions (see &APPERRORS;).</p>
  74. <p>All application-specific error conditions that are defined in XMPP Extension Protocol specifications MUST be included in this registry. Application-specific error conditions that are defined outside of the XMPP Standards Foundation's standards process (see &xep0001;) MAY be included in this registry, but it is not required for them to be so registered.</p>
  75. <section3 topic='Registration Process' anchor='registrar-conditions-process'>
  77. <code><![CDATA[
  78. <condition>
  79. <ns>the XML namespace that qualifies the condition</ns>
  80. <element>the XML element of the error condition</element>
  81. <desc>a natural-language description of the error condition</desc>
  82. <doc>the document in which the condition is specified</doc>
  83. </condition>
  84. ]]></code>
  85. <p>The registrant may register more than one condition at a time, each contained in a separate &lt;condition/&gt; element.</p>
  86. </section3>
  87. </section2>
  88. <section2 topic='Protocol Namespaces' anchor='registrar-ns'>
  89. <p>The &REGISTRAR; includes 'urn:xmpp:errors' in its registry of protocol namespaces.</p>
  90. </section2>
  91. </section1>
  92. <section1 topic='Security Considerations' anchor='security'>
  93. <p>This document introduces no known security vulnerabilities.</p>
  94. </section1>
  95. <section1 topic='IANA Considerations' anchor='iana'>
  96. <p>This document requires no interaction with &IANA;.</p>
  97. </section1>
  98. </xep>