The QName URN Namespace

This specification defines a Uniform Resource Name namespace for XML namespace-qualified names, QNames. As long as the URN is encoded in the same character set as the document containing the original QName, the Qname URN provides enough information to maintain the semantics, and optionally the exact syntax, of the original name.¶

This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79.¶

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at http://datatracker.ietf.org/drafts/current/.¶

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress”.¶

This Internet-Draft will expire in April 2011.¶

Copyright (c) 2010 IETF Trust and the persons identified as the document authors. All rights reserved.¶

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.¶

This document may contain material from IETF Documents or IETF Contributions published or made publicly available before November 10, 2008. The person(s) controlling the copyright in some of this material may not have granted the IETF Trust the right to allow modifications of such material outside the IETF Standards Process. Without obtaining an adequate license from the person(s) controlling the copyright in such materials, this document may not be modified outside the IETF Standards Process, and derivative works of it may not be created outside the IETF Standards Process, except to format it for publication as an RFC or to translate it into languages other than English.¶

This specification defines a Uniform Resource Name namespace for XML namespace-qualified names, QNames. As long as the URN is encoded in the same character set as the document containing the original QName, the Qname URN provides enough information to maintain the semantics, and optionally the exact syntax, of the original name.¶

There are a variety of situations when a QName may need to be mapped to a URI. For example, when exchanging (or referencing) an identifier for an XML element contained within a document, and the medium of exchange prefers URIs to QNames, such as an XML Schema anyURI data type. Another scenario is for comparing the identifiers, which can be simpler by comparing just a string without having to also compare the context setting XML namespace attribute that may be declared arbitrarily earlier in the document.¶

The XML Namespaces specification [XMLNS] does not provide a canonical mapping between QNames and URIs. Any XML specification that wants to enable identifier exchanges must define a language specific QName to URI mapping. There have emerged a variety of different algorithms and solutions for the mapping. To date, there have been no standardized algorithms available that they can re-use, which has increased their efforts. A standardized mapping, such as this, should provide increased productivity.¶

Almost all of the algorithms for Qname to URI mappings are based upon concatenation of the URI and the name with variations based upon prefix inclusion, namespace name and name separator, etc. These are typically problematic because it is difficult to recover the QName from the URI as the namespace name and name separator may have already been used in the namespace name. Having the namespace name at the end of the identifier string avoids these and other problems.¶

The following paragraphs contain the URN namespace registration data, as defined in [RFC3406].¶

Namespace ID: ¶

• qname

Registration Information: ¶

• Version number: 2
• Registration date: 2010-03-07

Declared registrant of the namespace: ¶

• Julian Reschke <julian.reschke@greenbytes.de> (see Authors' Adresses Section).

Declaration of syntactic structure: ¶

• The QName URN is structured as four colon-separated fields. Note that colons within the fourth field, the URI part, are not significant; the entire fourth field is treated as a single opaque entity by this URN scheme.
• The first field identifies the naming scheme. The second contains the QName prefix, or an empty string if the QName comes from the default namespace, or an asterisk if the prefix is not significant.

I  any-uri   (type: change, status: open)
julian.reschke@greenbytes.de	2009-12-12	Need a grammar for "any valid URI". Do we follow stricly XMLNS, which would make it a "URI reference" as per RFC 3986, or do we tolerate junk and/or IRIs (no offense). Also, we need to state that this part of the URN will be empty for elements that are in no namespace (right?).
julian.reschke@greenbytes.de	2010-03-07	In particular: how do we treat namespace names that use a fragment identifier? We can't allow the "#" character in the URN (by definition).

• A QName URN is defined by the following ABNF [RFC5234]:

  qnameURN     = "qname" ":" prefix ":" localname ":" uri
  prefix       = ncname / "" / "*"
  localname    = ncname
  uri          = <any valid URI>
  ncname       = <see Production 4 of [XMLNS], Section 3>
  

• Here are three examples of a QName URN:

  urn:qname:foo:OK:http://example.com/ws/foo.xsd
  urn:qname::OK:http://example.com/ws/foo.xsd
  urn:qname:*:Reject:http://w3.org/2002/xkms#
  

  The first correspond to the following element content QNames (the element name is not significant):

  I  examples   (type: change, status: open)
  julian.reschke@greenbytes.de	2009-12-11	Having just examples of QNames in element content might be confusing to people not familiar with that use case; we also should have at least one example for an XML element name, and for a QName in content. (potentially also move the examples out of the registration template?)

  <foo xmlns:foo="http://example.com/ws/foo.xsd">foo:OK</foo>
  <foo xmlns="http://example.com/ws/foo.xsd">foo:OK</foo>
  

  The third example would match both of the others, as well as an inifinite number of QNames, since the namespace prefix is explicitly marked as "don't-care."

Identifier uniqueness considerations: ¶

• An XML QName is semantically defined as a (namespace-uri, localname) pair; the namespace prefix is not significant. For some applications, such as signature functions, the prefix is important and must be preserved.
• The QName URN provides both a one-to-one mapping, that preserves the uniquess of the underlying QName, and an explicit many-to-one mapping, that does not preserve the uniquess when it is not important to do so.

Identifier persistence considerations: ¶

• QName URN's have the same persistance as the underlying XML QName from which they are derived.

Process of identifier assignment: ¶

• Assignment of identifiers depends on the original XML QName, typically deferring to the namespace URI. Anyone with access to an XML QName can create an equivalent QName URN; no registration is required.

Process for identifier resolution: ¶

• Inherited from the QName resolution rules (typically the namespace URI) from which the QName URN is created.

Rules for Lexical Equivalence: ¶

• If necessary, convert each QName URN to the same encoding. The encoding of a QName URN is determined by context, and depends on the encoding of the document in which it appears.
• To be lexically equivalent the resultant QName URN's must be identical when compared byte-for-byte. To be semantically equivalent, ignore the prefix field when comparing bytes.

Conformance with URN Syntax: ¶

• Fully conformant.

Validation mechanism: ¶

• Inherited from the namespace URI of the original QName.

Scope: ¶

• Inherited from the original QName.

QName URN's provide a way to transcribe XML QName's into and out of URN syntax. Any security considerations are inherited from the original QName.¶

4. Normative References

[XML]

Bray, T., Paoli, J., Sperberg-McQueen, C., Maler, E., and F. Yergeau, “Extensible Markup Language (XML) 1.0 (Fifth Edition)”, W3C REC-xml-20081126, November 2008, <http://www.w3.org/TR/2008/REC-xml-20081126/>.

[XMLNS]

Bray, T., Hollander, D., Layman, A., Tobin, R., and H. Henry, “Namespaces in XML 1.0 (Third Edition)”, W3C REC-xml-names-20091208, December 2009, <http://www.w3.org/TR/2009/REC-xml-names-20091208/>.

[RFC3406]

Daigle, L., van Gulik, D., Iannella, R., and P. Faltstrom, “Uniform Resource Names (URN) Namespace Definition Mechanisms”, BCP 33, RFC 3406, October 2002.

[RFC5234]

Crocker, D., Ed. and P. Overell, “Augmented BNF for Syntax Specifications: ABNF”, STD 68, RFC 5234, January 2008.