JEP-0182: Application-Specific Error Conditions

This document defines a registry of application-specific error conditions.

NOTICE: This JEP is currently within Last Call or under consideration by the Jabber Council for advancement to the next stage in the JSF standards process. For further details, visit <http://www.jabber.org/council/queue.shtml>.

JEP Information

Status: Proposed
Type: Procedural
Number: 0182
Version: 0.2
Last Updated: 2006-04-28
JIG: Standards JIG
Approving Body: Jabber Council
Dependencies: XMPP Core
Supersedes: None
Superseded By: None
Short Name: N/A
Wiki Page: <http://wiki.jabber.org/index.php/Application-Specific Error Conditions (JEP-0182)>

Author Information

Peter Saint-Andre

Email: stpeter@jabber.org
JID: stpeter@jabber.org

Legal Notice

This Jabber Enhancement Proposal is copyright 1999 - 2006 by the Jabber Software Foundation (JSF) and is in full conformance with the JSF's Intellectual Property Rights Policy <http://www.jabber.org/jsf/ipr-policy.shtml>. This material may be distributed only subject to the terms and conditions set forth in the Creative Commons Attribution License (<http://creativecommons.org/licenses/by/2.5/>).

Discussion Venue

The preferred venue for discussion of this document is the Standards-JIG discussion list: <http://mail.jabber.org/mailman/listinfo/standards-jig>.

Table of Contents

1. Introduction
2. Jabber Registrar Considerations
2.1. Application-Specific Error Conditions Registry
2.1.1. Registration Process
2.2. Protocol Namespaces
3. Security Considerations
4. IANA Considerations
Notes
Revision History

1. Introduction

XMPP Core [1] 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. Although this introduces a great deal of flexibility, it may also introduce confusion regarding possible conditions. Therefore, this document defines a registry of application-specific error conditions, to be maintained by the Jabber Registrar [2]. In addition, this document registers a namespace of 'http://jabber.org/protocol/errors' as a fallback namespace for defining generalized error conditions that are not specific to a particular protocol (e.g., <stanza-too-big/> as a particular form of the <not-acceptable/> condition).

2. Jabber Registrar Considerations

2.1 Application-Specific Error Conditions Registry

The Jabber Registrar shall create a registry of application-specific error conditions.

All application-specific error conditions that are defined in Jabber Enhancement Proposals MUST be included in this registry. Application-specific error conditions that are defined outside of the JEP process MAY be included in this registry, but it is not required for them to be so registered.

2.1.1 Registration Process

In order to submit new values to this registry, the registrant must define an XML fragment of the following form and either include it in the relevant Jabber Enhancement Proposal or send it to the email address <registrar@jabber.org>:

<condition>
  <ns>the XML namespace that qualifies the condition</ns>
  <element>the XML element of the error condition</element>
  <desc>a natural-language description of the error condition</desc>
  <doc>the document in which the condition is specified</doc>
</condition>

The registrant may register more than one condition at a time, each contained in a separate <condition/> element.

2.2 Protocol Namespaces

The Jabber Registrar [3] shall include 'http://jabber.org/protocol/errors' in its registry of protocol namespaces.

3. Security Considerations

This document introduces no known security vulnerabilities.

4. IANA Considerations

This JEP requires no interaction with the Internet Assigned Numbers Authority (IANA) [4].

Notes

1. RFC 3920: Extensible Messaging and Presence Protocol (XMPP): Core <http://www.ietf.org/rfc/rfc3920.txt>.

2. The Jabber Registrar maintains a list of reserved Jabber protocol namespaces as well as registries of parameters used in the context of protocols approved by the Jabber Software Foundation. For further information, see <http://www.jabber.org/registrar/>.

3. The Jabber Registrar maintains a list of reserved Jabber protocol namespaces as well as registries of parameters used in the context of protocols approved by the Jabber Software Foundation. For further information, see <http://www.jabber.org/registrar/>.

4. The Internet Assigned Numbers Authority (IANA) is the central coordinator for the assignment of unique parameter values for Internet protocols, such as port numbers and URI schemes. For further information, see <http://www.iana.org/>.

Revision History

Version 0.2 (2006-04-28)

Added note about scope of registry.

(psa)

Version 0.1 (2006-03-23)

Initial JEP version.

(psa)

Version 0.0.1 (2006-03-21)

First draft.

(psa)

END