Package org.apache.ivy.util

Class XMLHelper

java.lang.Object

org.apache.ivy.util.XMLHelper

public abstract class XMLHelper
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	XMLHelper.ExternalResources
private static class	XMLHelper.NoopEntityResolver
private static class	XMLHelper.NoopEntityResolverDefaultHandler

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ALLOW_DOCTYPE_PROCESSING
private static final InputSource	EMPTY_INPUT_SOURCE
static final String	EXTERNAL_RESOURCES
(package private) static final String	JAXP_SCHEMA_LANGUAGE
(package private) static final String	JAXP_SCHEMA_SOURCE
(package private) static final String	W3C_XML_SCHEMA
(package private) static final String	XERCES_LOAD_EXTERNAL_DTD
private static final String	XML_ACCESS_EXTERNAL_DTD
private static final String	XML_ACCESS_EXTERNAL_SCHEMA
(package private) static final String	XML_NAMESPACE_PREFIXES

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XMLHelper()

Method Summary

Modifier and Type	Method	Description
static boolean	canUseSchemaValidation()
private static void	configureSafeFeatures(DocumentBuilderFactory factory, boolean allowXmlDoctypeProcessing, XMLHelper.ExternalResources externalResources)
private static void	configureSafeFeatures(SAXParserFactory factory, boolean allowXmlDoctypeProcessing, XMLHelper.ExternalResources externalResources)
private static void	configureSafeFeatures(TransformerFactory factory)
static String	escape(String text)	Escapes invalid XML characters in the given character data using XML entities.
static DocumentBuilder	getDocBuilder(EntityResolver entityResolver)
static DocumentBuilder	getDocBuilder(EntityResolver entityResolver, boolean allowXmlDoctypeProcessing, XMLHelper.ExternalResources externalResources)
static Transformer	getTransformer(Source source)
private static SAXTransformerFactory	getTransformerFactory()
static TransformerHandler	getTransformerHandler()
private static boolean	isAttributeSupported(TransformerFactory factory, String attribute)
private static boolean	isFeatureSupported(DocumentBuilderFactory factory, String feature)
private static boolean	isFeatureSupported(SAXParserFactory factory, String feature)
static boolean	isXmlDoctypeProcessingAllowed()
private static SAXParser	newSAXParser(URL schema, InputStream schemaStream, boolean allowXmlDoctypeProcessing, XMLHelper.ExternalResources externalResources)
static void	parse(InputStream xmlStream, URL schema, DefaultHandler handler, LexicalHandler lHandler)
static void	parse(InputStream xmlStream, URL schema, DefaultHandler handler, LexicalHandler lHandler, XMLHelper.ExternalResources externalResources)
static void	parse(URL xmlURL, URL schema, DefaultHandler handler)
static void	parse(URL xmlURL, URL schema, DefaultHandler handler, LexicalHandler lHandler)
static void	parse(URL xmlURL, URL schema, DefaultHandler handler, LexicalHandler lHandler, XMLHelper.ExternalResources externalResources)
static void	parse(InputSource xmlStream, URL schema, DefaultHandler handler, LexicalHandler lHandler)
static void	parse(InputSource xmlStream, URL schema, DefaultHandler handler, LexicalHandler lHandler, boolean loadExternalDtds)
static void	parse(InputSource xmlStream, URL schema, DefaultHandler handler, LexicalHandler lHandler, XMLHelper.ExternalResources externalResources)
static Document	parseToDom(InputSource source, EntityResolver entityResolver)
static Document	parseToDom(InputSource source, EntityResolver entityResolver, boolean allowXmlDoctypeProcessing, XMLHelper.ExternalResources externalResources)
static String	toSystemId(URL url)	Convert an URL to a valid systemId according to RFC 2396.
private static boolean	trySetAttribute(TransformerFactory factory, String attribute, String val)
private static boolean	trySetFeature(DocumentBuilderFactory factory, String feature, boolean val)
private static boolean	trySetFeature(SAXParserFactory factory, String feature, boolean val)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JAXP_SCHEMA_LANGUAGE

static final String JAXP_SCHEMA_LANGUAGE

See Also:

• Constant Field Values

JAXP_SCHEMA_SOURCE

static final String JAXP_SCHEMA_SOURCE

See Also:

• Constant Field Values

XERCES_LOAD_EXTERNAL_DTD

static final String XERCES_LOAD_EXTERNAL_DTD

See Also:

• Constant Field Values

XML_NAMESPACE_PREFIXES

static final String XML_NAMESPACE_PREFIXES

See Also:

• Constant Field Values

W3C_XML_SCHEMA

static final String W3C_XML_SCHEMA

See Also:

• Constant Field Values

XML_ACCESS_EXTERNAL_SCHEMA

private static final String XML_ACCESS_EXTERNAL_SCHEMA

See Also:

• Constant Field Values

XML_ACCESS_EXTERNAL_DTD

private static final String XML_ACCESS_EXTERNAL_DTD

See Also:

• Constant Field Values

ALLOW_DOCTYPE_PROCESSING

public static final String ALLOW_DOCTYPE_PROCESSING

See Also:

• Constant Field Values

EXTERNAL_RESOURCES

public static final String EXTERNAL_RESOURCES

See Also:

• Constant Field Values

EMPTY_INPUT_SOURCE

private static final InputSource EMPTY_INPUT_SOURCE

Constructor Details

XMLHelper

private XMLHelper()

Method Details

newSAXParser

private static SAXParser newSAXParser(URL schema,
 InputStream schemaStream,
 boolean allowXmlDoctypeProcessing,
 XMLHelper.ExternalResources externalResources)
                               throws ParserConfigurationException,
SAXException

Throws:

ParserConfigurationException

SAXException

toSystemId

public static String toSystemId(URL url)

Convert an URL to a valid systemId according to RFC 2396.

Parameters:

url - URL

Returns:

String

parse

public static void parse(URL xmlURL,
 URL schema,
 DefaultHandler handler)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(URL xmlURL,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(URL xmlURL,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler,
 XMLHelper.ExternalResources externalResources)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(InputStream xmlStream,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(InputStream xmlStream,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler,
 XMLHelper.ExternalResources externalResources)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(InputSource xmlStream,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(InputSource xmlStream,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler,
 boolean loadExternalDtds)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

parse

public static void parse(InputSource xmlStream,
 URL schema,
 DefaultHandler handler,
 LexicalHandler lHandler,
 XMLHelper.ExternalResources externalResources)
                  throws SAXException,
IOException,
ParserConfigurationException

Throws:

SAXException

IOException

ParserConfigurationException

canUseSchemaValidation

public static boolean canUseSchemaValidation()

escape

public static String escape(String text)

Escapes invalid XML characters in the given character data using XML entities. For the moment, only the following characters are being escaped: (<), (&), (') and ("). Remark: we don't escape the (>) character to keep the readability of the configuration mapping! The XML spec only requires that the (&) and (<) characters are being escaped inside character data.

Parameters:

text - the character data to escape

Returns:

the escaped character data

parseToDom

public static Document parseToDom(InputSource source,
 EntityResolver entityResolver)
                           throws IOException,
SAXException

Throws:

IOException

SAXException

parseToDom

public static Document parseToDom(InputSource source,
 EntityResolver entityResolver,
 boolean allowXmlDoctypeProcessing,
 XMLHelper.ExternalResources externalResources)
                           throws IOException,
SAXException

Throws:

IOException

SAXException

getDocBuilder

public static DocumentBuilder getDocBuilder(EntityResolver entityResolver)

getDocBuilder

public static DocumentBuilder getDocBuilder(EntityResolver entityResolver,
 boolean allowXmlDoctypeProcessing,
 XMLHelper.ExternalResources externalResources)

getTransformer

public static Transformer getTransformer(Source source)
                                  throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getTransformerHandler

public static TransformerHandler getTransformerHandler()
                                                throws TransformerConfigurationException

Throws:

TransformerConfigurationException

isXmlDoctypeProcessingAllowed

public static boolean isXmlDoctypeProcessingAllowed()

getTransformerFactory

private static SAXTransformerFactory getTransformerFactory()

configureSafeFeatures

private static void configureSafeFeatures(DocumentBuilderFactory factory,
 boolean allowXmlDoctypeProcessing,
 XMLHelper.ExternalResources externalResources)

configureSafeFeatures

private static void configureSafeFeatures(SAXParserFactory factory,
 boolean allowXmlDoctypeProcessing,
 XMLHelper.ExternalResources externalResources)

configureSafeFeatures

private static void configureSafeFeatures(TransformerFactory factory)

isFeatureSupported

private static boolean isFeatureSupported(SAXParserFactory factory,
 String feature)

isFeatureSupported

private static boolean isFeatureSupported(DocumentBuilderFactory factory,
 String feature)

isAttributeSupported

private static boolean isAttributeSupported(TransformerFactory factory,
 String attribute)

trySetFeature

private static boolean trySetFeature(DocumentBuilderFactory factory,
 String feature,
 boolean val)

trySetFeature

private static boolean trySetFeature(SAXParserFactory factory,
 String feature,
 boolean val)

trySetAttribute

private static boolean trySetAttribute(TransformerFactory factory,
 String attribute,
 String val)