/* * Copyright (c) 2003, 2015, Oracle and/or its affiliates. All rights reserved. * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * This code is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License version 2 only, as * published by the Free Software Foundation. Oracle designates this * particular file as subject to the "Classpath" exception as provided * by Oracle in the LICENSE file that accompanied this code. * * This code is distributed in the hope that it will be useful, but WITHOUT * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License * version 2 for more details (a copy is included in the LICENSE file that * accompanied this code). * * You should have received a copy of the GNU General Public License version * 2 along with this work; if not, write to the Free Software Foundation, * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. * * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA * or visit www.oracle.com if you need additional information or have any * questions. */ package javax.xml; /** *

Utility class to contain basic XML values as constants. * * @author Jeff Suttor * @see Extensible Markup Language (XML) 1.1 * @see Extensible Markup Language (XML) 1.0 (Second Edition) * @see XML 1.0 Second Edition Specification Errata * @see Namespaces in XML 1.1 * @see Namespaces in XML * @see Namespaces in XML Errata * @see XML Schema Part 1: Structures * @since 1.5 **/ public final class XMLConstants { /** * Private constructor to prevent instantiation. */ private XMLConstants() { } /** * Namespace URI to use to represent that there is no Namespace. * *

Defined by the Namespace specification to be "". * * @see * Namespaces in XML, 5.2 Namespace Defaulting */ public static final String NULL_NS_URI = ""; /** * Prefix to use to represent the default XML Namespace. * *

Defined by the XML specification to be "". * * @see * Namespaces in XML, 3. Qualified Names */ public static final String DEFAULT_NS_PREFIX = ""; /** * The official XML Namespace name URI. * *

Defined by the XML specification to be * "{@code http://www.w3.org/XML/1998/namespace}". * * @see * Namespaces in XML, 3. Qualified Names */ public static final String XML_NS_URI = "http://www.w3.org/XML/1998/namespace"; /** * The official XML Namespace prefix. * *

Defined by the XML specification to be "{@code xml}". * * @see * Namespaces in XML, 3. Qualified Names */ public static final String XML_NS_PREFIX = "xml"; /** * The official XML attribute used for specifying XML Namespace * declarations, {@link #XMLNS_ATTRIBUTE * XMLConstants.XMLNS_ATTRIBUTE}, Namespace name URI. * *

Defined by the XML specification to be * "{@code http://www.w3.org/2000/xmlns/}". * * @see * Namespaces in XML, 3. Qualified Names * @see * Namespaces in XML Errata */ public static final String XMLNS_ATTRIBUTE_NS_URI = "http://www.w3.org/2000/xmlns/"; /** * The official XML attribute used for specifying XML Namespace * declarations. * *

It is NOT valid to use as a * prefix. Defined by the XML specification to be * "{@code xmlns}". * * @see * Namespaces in XML, 3. Qualified Names */ public static final String XMLNS_ATTRIBUTE = "xmlns"; /** * W3C XML Schema Namespace URI. * *

Defined to be "{@code http://www.w3.org/2001/XMLSchema}". * * @see * XML Schema Part 1: * Structures, 2.6 Schema-Related Markup in Documents Being Validated */ public static final String W3C_XML_SCHEMA_NS_URI = "http://www.w3.org/2001/XMLSchema"; /** * W3C XML Schema Instance Namespace URI. * *

Defined to be "{@code http://www.w3.org/2001/XMLSchema-instance}". * * @see * XML Schema Part 1: * Structures, 2.6 Schema-Related Markup in Documents Being Validated */ public static final String W3C_XML_SCHEMA_INSTANCE_NS_URI = "http://www.w3.org/2001/XMLSchema-instance"; /** * W3C XPath Datatype Namespace URI. * *

Defined to be "{@code http://www.w3.org/2003/11/xpath-datatypes}". * * @see XQuery 1.0 and XPath 2.0 Data Model */ public static final String W3C_XPATH_DATATYPE_NS_URI = "http://www.w3.org/2003/11/xpath-datatypes"; /** * XML Document Type Declaration Namespace URI as an arbitrary value. * *

Since not formally defined by any existing standard, arbitrarily define to be "{@code http://www.w3.org/TR/REC-xml}". */ public static final String XML_DTD_NS_URI = "http://www.w3.org/TR/REC-xml"; /** * RELAX NG Namespace URI. * *

Defined to be "{@code http://relaxng.org/ns/structure/1.0}". * * @see RELAX NG Specification */ public static final String RELAXNG_NS_URI = "http://relaxng.org/ns/structure/1.0"; /** * Feature for secure processing. * *

* {@code true} instructs the implementation to process XML securely. * This may set limits on XML constructs to avoid conditions such as denial of service attacks. *
* {@code false} instructs the implementation to process XML in accordance with the XML specifications * ignoring security issues such as limits on XML constructs to avoid conditions such as denial of service attacks. *

*/ public static final String FEATURE_SECURE_PROCESSING = "http://javax.xml.XMLConstants/feature/secure-processing"; /** * Property: accessExternalDTD * *

* Restrict access to external DTDs and external Entity References to the protocols specified. * If access is denied due to the restriction of this property, a runtime exception that * is specific to the context is thrown. In the case of {@link javax.xml.parsers.SAXParser} * for example, {@link org.xml.sax.SAXException} is thrown. * *

* Value: a list of protocols separated by comma. A protocol is the scheme portion of a * {@link java.net.URI}, or in the case of the JAR protocol, "jar" plus the scheme portion * separated by colon. * A scheme is defined as: * *

* scheme = alpha *( alpha | digit | "+" | "-" | "." )
* where alpha = a-z and A-Z.

* * And the JAR protocol:
* * jar[:scheme]

* * Protocols including the keyword "jar" are case-insensitive. Any whitespaces as defined by * {@link java.lang.Character#isSpaceChar } in the value will be ignored. * Examples of protocols are file, http, jar:file. * *

* *

* Default value: The default value is implementation specific and therefore not specified. * The following options are provided for consideration: *

*
*
an empty string to deny all access to external references;
*
a specific protocol, such as file, to give permission to only the protocol;
*
the keyword "all" to grant permission to all protocols.
*

* When FEATURE_SECURE_PROCESSING is enabled, it is recommended that implementations * restrict external connections by default, though this may cause problems for applications * that process XML/XSD/XSL with external references. *

* *

* Granting all access: the keyword "all" grants permission to all protocols. * *

* System Property: The value of this property can be set or overridden by * system property {@code javax.xml.accessExternalDTD}. * * *

* jaxp.properties: This configuration file is in standard * {@link java.util.Properties} format and typically located in the {@code conf} * directory of the Java installation. If the file exists and the system * property is specified, its value will be used to override the default * of the property. * * * @since 1.7 */ public static final String ACCESS_EXTERNAL_DTD = "http://javax.xml.XMLConstants/property/accessExternalDTD"; /** *

Property: accessExternalSchema

* *

* Restrict access to the protocols specified for external reference set by the * schemaLocation attribute, Import and Include element. If access is denied * due to the restriction of this property, a runtime exception that is specific * to the context is thrown. In the case of {@link javax.xml.validation.SchemaFactory} * for example, org.xml.sax.SAXException is thrown. * *

* scheme = alpha *( alpha | digit | "+" | "-" | "." )
* where alpha = a-z and A-Z.

* * And the JAR protocol:
* * jar[:scheme]

* * Protocols including the keyword "jar" are case-insensitive. Any whitespaces as defined by * {@link java.lang.Character#isSpaceChar } in the value will be ignored. * Examples of protocols are file, http, jar:file. * *

* *

* Default value: The default value is implementation specific and therefore not specified. * The following options are provided for consideration: *

*
*
an empty string to deny all access to external references;
*
a specific protocol, such as file, to give permission to only the protocol;
*
the keyword "all" to grant permission to all protocols.
*

* When FEATURE_SECURE_PROCESSING is enabled, it is recommended that implementations * restrict external connections by default, though this may cause problems for applications * that process XML/XSD/XSL with external references. *

* *

* Granting all access: the keyword "all" grants permission to all protocols. * *

* System Property: The value of this property can be set or overridden by * system property {@code javax.xml.accessExternalSchema} * *

* jaxp.properties: This configuration file is in standard * {@link java.util.Properties} format and typically located in the {@code conf} * directory of the Java installation. If the file exists and the system * property is specified, its value will be used to override the default * of the property. * * @since 1.7 */ public static final String ACCESS_EXTERNAL_SCHEMA = "http://javax.xml.XMLConstants/property/accessExternalSchema"; /** * Property: accessExternalStylesheet * *

* Restrict access to the protocols specified for external references set by the * stylesheet processing instruction, Import and Include element, and document function. * If access is denied due to the restriction of this property, a runtime exception * that is specific to the context is thrown. In the case of constructing new * {@link javax.xml.transform.Transformer} for example, * {@link javax.xml.transform.TransformerConfigurationException} * will be thrown by the {@link javax.xml.transform.TransformerFactory}. * *

* scheme = alpha *( alpha | digit | "+" | "-" | "." )
* where alpha = a-z and A-Z.

* * And the JAR protocol:
* * jar[:scheme]

* * Protocols including the keyword "jar" are case-insensitive. Any whitespaces as defined by * {@link java.lang.Character#isSpaceChar } in the value will be ignored. * Examples of protocols are file, http, jar:file. * *

* *

* Default value: The default value is implementation specific and therefore not specified. * The following options are provided for consideration: *

*
*
an empty string to deny all access to external references;
*
a specific protocol, such as file, to give permission to only the protocol;
*
the keyword "all" to grant permission to all protocols.
*

* When FEATURE_SECURE_PROCESSING is enabled, it is recommended that implementations * restrict external connections by default, though this may cause problems for applications * that process XML/XSD/XSL with external references. *

* *

* Granting all access: the keyword "all" grants permission to all protocols. * *

* System Property: The value of this property can be set or overridden by * system property {@code javax.xml.accessExternalStylesheet} * *

* jaxp.properties: This configuration file is in standard * {@link java.util.Properties} format and typically located in the {@code conf} * directory of the Java installation. If the file exists and the system * property is specified, its value will be used to override the default * of the property. * * @since 1.7 */ public static final String ACCESS_EXTERNAL_STYLESHEET = "http://javax.xml.XMLConstants/property/accessExternalStylesheet"; }