Package org.docx4j.org.apache.poi.util

Class XMLHelper

java.lang.Object

org.docx4j.org.apache.poi.util.XMLHelper

@Internal
public final class XMLHelper
extends Object

Helper methods for working with javax.xml classes.

See Also:

• OWASP XXE

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	XMLHelper.DocHelperErrorHandler
private static interface	XMLHelper.SecurityFeature
private static interface	XMLHelper.SecurityProperty

Field Summary

Fields

Modifier and Type	Field	Description
private static final DocumentBuilderFactory	documentBuilderFactory
(package private) static final String	FEATURE_DISALLOW_DOCTYPE_DECL
(package private) static final String	FEATURE_EXTERNAL_ENTITIES
(package private) static final String	FEATURE_LOAD_DTD_GRAMMAR
(package private) static final String	FEATURE_LOAD_EXTERNAL_DTD
(package private) static final String	FEATURE_PARAMETER_ENTITIES
private static long	lastLog
private static org.slf4j.Logger	LOG
(package private) static final String	METHOD_ENTITY_EXPANSION_XERCES
(package private) static final String	PROPERTY_ENTITY_EXPANSION_LIMIT
(package private) static final String	PROPERTY_SECURITY_MANAGER
private static final SAXParserFactory	saxFactory
(package private) static final String[]	SECURITY_MANAGERS

Constructor Summary

Constructors

Modifier	Constructor	Description
private	XMLHelper()

Method Summary

Modifier and Type	Method	Description
static DocumentBuilderFactory	getDocumentBuilderFactory()	Creates a new DocumentBuilderFactory, with sensible defaults
static SAXParserFactory	getSaxParserFactory()
static SchemaFactory	getSchemaFactory()
static TransformerFactory	getTransformerFactory()
private static Object	getXercesSecurityManager()
private static InputSource	ignoreEntity(String publicId, String systemId)
private static void	logThrowable(Throwable t, String message, String name)
static DocumentBuilder	newDocumentBuilder()	Creates a new document builder, with sensible defaults
static Transformer	newTransformer()
static XMLEventFactory	newXMLEventFactory()	Creates a new StAX XMLEventFactory, with sensible defaults
static XMLInputFactory	newXMLInputFactory()	Creates a new StAX XMLInputFactory, with sensible defaults
static XMLOutputFactory	newXMLOutputFactory()	Creates a new StAX XMLOutputFactory, with sensible defaults
static XMLReader	newXMLReader()	Creates a new SAX XMLReader, with sensible defaults
private static boolean	quietSet(XMLHelper.SecurityProperty property, String name, Object value)
private static boolean	trySet(XMLHelper.SecurityFeature feature, String name, boolean value)
private static boolean	trySet(XMLHelper.SecurityProperty property, String name, Object value)

Methods inherited from class java.lang.Object

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

Field Details

FEATURE_LOAD_DTD_GRAMMAR

static final String FEATURE_LOAD_DTD_GRAMMAR

See Also:

• Constant Field Values

FEATURE_LOAD_EXTERNAL_DTD

static final String FEATURE_LOAD_EXTERNAL_DTD

See Also:

• Constant Field Values

FEATURE_DISALLOW_DOCTYPE_DECL

static final String FEATURE_DISALLOW_DOCTYPE_DECL

See Also:

• Constant Field Values

FEATURE_PARAMETER_ENTITIES

static final String FEATURE_PARAMETER_ENTITIES

See Also:

• Constant Field Values

FEATURE_EXTERNAL_ENTITIES

static final String FEATURE_EXTERNAL_ENTITIES

See Also:

• Constant Field Values

PROPERTY_ENTITY_EXPANSION_LIMIT

static final String PROPERTY_ENTITY_EXPANSION_LIMIT

See Also:

• Constant Field Values

PROPERTY_SECURITY_MANAGER

static final String PROPERTY_SECURITY_MANAGER

See Also:

• Constant Field Values

METHOD_ENTITY_EXPANSION_XERCES

static final String METHOD_ENTITY_EXPANSION_XERCES

See Also:

• Constant Field Values

SECURITY_MANAGERS

static final String[] SECURITY_MANAGERS

LOG

private static org.slf4j.Logger LOG

lastLog

private static long lastLog

documentBuilderFactory

private static final DocumentBuilderFactory documentBuilderFactory

saxFactory

private static final SAXParserFactory saxFactory

Constructor Details

XMLHelper

private XMLHelper()

Method Details

getDocumentBuilderFactory

public static DocumentBuilderFactory getDocumentBuilderFactory()

Creates a new DocumentBuilderFactory, with sensible defaults

newDocumentBuilder

public static DocumentBuilder newDocumentBuilder()

Creates a new document builder, with sensible defaults

Throws:

IllegalStateException - If creating the DocumentBuilder fails, e.g. due to ParserConfigurationException.

getSaxParserFactory

public static SAXParserFactory getSaxParserFactory()

newXMLReader

public static XMLReader newXMLReader()
                              throws SAXException,
ParserConfigurationException

Creates a new SAX XMLReader, with sensible defaults

Throws:

SAXException

ParserConfigurationException

newXMLInputFactory

public static XMLInputFactory newXMLInputFactory()

Creates a new StAX XMLInputFactory, with sensible defaults

newXMLOutputFactory

public static XMLOutputFactory newXMLOutputFactory()

Creates a new StAX XMLOutputFactory, with sensible defaults

newXMLEventFactory

public static XMLEventFactory newXMLEventFactory()

Creates a new StAX XMLEventFactory, with sensible defaults

getTransformerFactory

public static TransformerFactory getTransformerFactory()

newTransformer

public static Transformer newTransformer()
                                  throws TransformerConfigurationException

Throws:

TransformerConfigurationException

getSchemaFactory

public static SchemaFactory getSchemaFactory()

getXercesSecurityManager

private static Object getXercesSecurityManager()

trySet

private static boolean trySet(XMLHelper.SecurityFeature feature,
 String name,
 boolean value)

trySet

private static boolean trySet(XMLHelper.SecurityProperty property,
 String name,
 Object value)

quietSet

private static boolean quietSet(XMLHelper.SecurityProperty property,
 String name,
 Object value)

logThrowable

private static void logThrowable(Throwable t,
 String message,
 String name)

ignoreEntity

private static InputSource ignoreEntity(String publicId,
 String systemId)