org.apache.tika.utils

Class XMLReaderUtils

java.lang.Object

org.apache.tika.utils.XMLReaderUtils

public class XMLReaderUtils
extends java.lang.Object

Utility functions for reading XML. If you are doing SAX parsing, make sure to use the OfflineContentHandler to guard against XML External Entity attacks.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.xml.sax.EntityResolver	IGNORING_SAX_ENTITY_RESOLVER
private static javax.xml.stream.XMLResolver	IGNORING_STAX_ENTITY_RESOLVER
private static java.util.logging.Logger	LOG

Constructor Summary

Constructors

Constructor and Description
XMLReaderUtils()

Method Summary

Modifier and Type	Method and Description
static javax.xml.parsers.DocumentBuilder	getDocumentBuilder() Returns the DOM builder specified in this parsing context.
static javax.xml.parsers.DocumentBuilderFactory	getDocumentBuilderFactory() Returns the DOM builder factory specified in this parsing context.
static javax.xml.parsers.SAXParser	getSAXParser() Returns the SAX parser specified in this parsing context.
static javax.xml.parsers.SAXParserFactory	getSAXParserFactory() Returns the SAX parser factory specified in this parsing context.
static javax.xml.transform.Transformer	getTransformer() Returns a new transformer The transformer instance is configured to to use secure XML processing.
static javax.xml.stream.XMLInputFactory	getXMLInputFactory() Returns the StAX input factory specified in this parsing context.
static org.xml.sax.XMLReader	getXMLReader() Returns the XMLReader specified in this parsing context.
private static void	trySetSAXFeature(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory, java.lang.String feature, boolean enabled)
private static void	tryToSetStaxProperty(javax.xml.stream.XMLInputFactory factory, java.lang.String key, boolean value)

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final java.util.logging.Logger LOG

IGNORING_SAX_ENTITY_RESOLVER

private static final org.xml.sax.EntityResolver IGNORING_SAX_ENTITY_RESOLVER

IGNORING_STAX_ENTITY_RESOLVER

private static final javax.xml.stream.XMLResolver IGNORING_STAX_ENTITY_RESOLVER

Constructor Detail

XMLReaderUtils

public XMLReaderUtils()

Method Detail

getXMLReader

public static org.xml.sax.XMLReader getXMLReader()
                                          throws TikaException

Returns the XMLReader specified in this parsing context. If a reader is not explicitly specified, then one is created using the specified or the default SAX parser.

Returns:

XMLReader

Throws:

TikaException

Since:

Apache Tika 1.13

See Also:

getSAXParser()

getSAXParser

public static javax.xml.parsers.SAXParser getSAXParser()
                                                throws TikaException

Returns the SAX parser specified in this parsing context. If a parser is not explicitly specified, then one is created using the specified or the default SAX parser factory.

Make sure to wrap your handler in the OfflineContentHandler to prevent XML External Entity attacks

Returns:

SAX parser

Throws:

TikaException - if a SAX parser could not be created

Since:

Apache Tika 0.8

See Also:

getSAXParserFactory()

getSAXParserFactory

public static javax.xml.parsers.SAXParserFactory getSAXParserFactory()

Returns the SAX parser factory specified in this parsing context. If a factory is not explicitly specified, then a default factory instance is created and returned. The default factory instance is configured to be namespace-aware, not validating, and to use secure XML processing.

Make sure to wrap your handler in the OfflineContentHandler to prevent XML External Entity attacks

Returns:

SAX parser factory

Since:

Apache Tika 0.8

getDocumentBuilderFactory

public static javax.xml.parsers.DocumentBuilderFactory getDocumentBuilderFactory()

Returns the DOM builder factory specified in this parsing context. If a factory is not explicitly specified, then a default factory instance is created and returned. The default factory instance is configured to be namespace-aware and to apply reasonable security features.

Returns:

DOM parser factory

Since:

Apache Tika 1.13

getDocumentBuilder

public static javax.xml.parsers.DocumentBuilder getDocumentBuilder()
                                                            throws TikaException

Returns the DOM builder specified in this parsing context. If a builder is not explicitly specified, then a builder instance is created and returned. The builder instance is configured to apply an IGNORING_SAX_ENTITY_RESOLVER, and it sets the ErrorHandler to null.

Returns:

DOM Builder

Throws:

TikaException

Since:

Apache Tika 1.13

getXMLInputFactory

public static javax.xml.stream.XMLInputFactory getXMLInputFactory()

Returns the StAX input factory specified in this parsing context. If a factory is not explicitly specified, then a default factory instance is created and returned. The default factory instance is configured to be namespace-aware and to apply reasonable security using the IGNORING_STAX_ENTITY_RESOLVER.

Returns:

StAX input factory

Since:

Apache Tika 1.13

trySetSAXFeature

private static void trySetSAXFeature(javax.xml.parsers.DocumentBuilderFactory documentBuilderFactory,
                                     java.lang.String feature,
                                     boolean enabled)

tryToSetStaxProperty

private static void tryToSetStaxProperty(javax.xml.stream.XMLInputFactory factory,
                                         java.lang.String key,
                                         boolean value)

getTransformer

public static javax.xml.transform.Transformer getTransformer()
                                                      throws TikaException

Returns a new transformer The transformer instance is configured to to use secure XML processing.

Returns:

Transformer

Throws:

TikaException - when the transformer can not be created

Since:

Apache Tika 1.17