Package org.apache.tika.sax

Class SafeContentHandler

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.apache.tika.sax.ContentHandlerDecorator

org.apache.tika.sax.SafeContentHandler

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

Direct Known Subclasses:

XHTMLContentHandler, XMPContentHandler

@Deprecated(since="2026-04-30")
public class SafeContentHandler
extends ContentHandlerDecorator

Deprecated.

This version of the Apache Tika library is deprecated. Use your own version of Apache Tika.

Content handler decorator that makes sure that the character events (characters(char[], int, int) or ignorableWhitespace(char[], int, int)) passed to the decorated content handler contain only valid XML characters. All invalid characters are replaced with the Unicode replacement character U+FFFD (though a subclass may change this by overriding the writeReplacement(Output) method).

The XML standard defines the following Unicode character ranges as valid XML characters:

  #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF]
  

Note that currently this class only detects those invalid characters whose UTF-16 representation fits a single char. Also, this class does not ensure that the UTF-16 encoding of incoming characters is correct.

Constructor Summary

Constructors

Constructor	Description
SafeContentHandler(ContentHandler handler)	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Deprecated.
void	endDocument()	Deprecated.
void	endElement(String uri, String localName, String name)	Deprecated.
void	ignorableWhitespace(char[] ch, int start, int length)	Deprecated.
void	startElement(String uri, String localName, String name, Attributes atts)	Deprecated.

Methods inherited from class org.apache.tika.sax.ContentHandlerDecorator

endPrefixMapping, processingInstruction, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, toString

Methods inherited from class org.xml.sax.helpers.DefaultHandler

error, fatalError, notationDecl, resolveEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

SafeContentHandler

public SafeContentHandler(ContentHandler handler)

Deprecated.

Method Details

startElement

public void startElement(String uri,
 String localName,
 String name,
 Attributes atts)
                  throws SAXException

Deprecated.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class ContentHandlerDecorator

Throws:

SAXException

endElement

public void endElement(String uri,
 String localName,
 String name)
                throws SAXException

Deprecated.

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class ContentHandlerDecorator

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Deprecated.

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class ContentHandlerDecorator

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Deprecated.

Specified by:

characters in interface ContentHandler

Overrides:

characters in class ContentHandlerDecorator

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
 int start,
 int length)
                         throws SAXException

Deprecated.

Specified by:

ignorableWhitespace in interface ContentHandler

Overrides:

ignorableWhitespace in class ContentHandlerDecorator

Throws:

SAXException