Package org.projecthusky.common.utils.xml

Class XmlFactories

java.lang.Object

org.projecthusky.common.utils.xml.XmlFactories

@DefaultQualifier(value=org.checkerframework.checker.nullness.qual.NonNull.class,
                  locations={PARAMETER,RETURN})
public class XmlFactories
extends Object

Factories for XML-related classes.

Author:

Quentin Ligier

Method Summary

Modifier and Type	Method	Description
static DocumentBuilder	newSafeDocumentBuilder()	Initializes and configures a DocumentBuilder that is not vulnerable to XXE injections (XInclude, Billions Laugh Attack, ...).
static Schema	newSafeSchema(URL schema)	Initializes and configures a Schema.
static XPath	newSafeXpath()	Initializes and configures a XPath.
static Transformer	newTransformer()	Initializes and configures a Transformer.
static Transformer	newTransformer(Source source)	Initializes and configures a Transformer from a Source.

Methods inherited from class java.lang.Object

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

Method Details

newSafeDocumentBuilder

public static DocumentBuilder newSafeDocumentBuilder()
                                              throws ParserConfigurationException

Initializes and configures a DocumentBuilder that is not vulnerable to XXE injections (XInclude, Billions Laugh Attack, ...).

Returns:

a configured DocumentBuilder.

Throws:

ParserConfigurationException - if the parser is not Xerces2 compatible.

See Also:

• XML External Entity Prevention Cheat Sheet

newSafeSchema

public static Schema newSafeSchema(URL schema)
                            throws SAXException

Initializes and configures a Schema.

Parameters:

schema - URL that represents a schema.

Returns:

a configured Schema.

Throws:

SAXException - if a SAX error occurs during parsing.

newSafeXpath

public static XPath newSafeXpath()
                          throws XPathFactoryConfigurationException

Initializes and configures a XPath.

Returns:

a configured XPath.

Throws:

XPathFactoryConfigurationException - if the configuration fails.

newTransformer

public static Transformer newTransformer()
                                  throws TransformerConfigurationException

Initializes and configures a Transformer.

Returns:

a configured Transformer.

Throws:

TransformerConfigurationException - if it is not possible to create a Transformer instance.

newTransformer

public static Transformer newTransformer(Source source)
                                  throws TransformerConfigurationException

Initializes and configures a Transformer from a Source. You can use Sources to convert different objects to Sources.

Parameters:

source - The source.

Returns:

a configured Transformer.

Throws:

TransformerConfigurationException - if it is not possible to create a Transformer instance.