Package org.apache.tika.config

Class ExceptionReporting

java.lang.Object

org.apache.tika.config.ExceptionReporting

All Implemented Interfaces:

Serializable

public class ExceptionReporting
extends Object
implements Serializable

How much detail Tika reports when an exception is turned into a string: the tk:exception:* metadata values, tika-server error bodies and pipes result messages.

Stack traces and exception messages can carry file paths, hostnames and fragments of the document being parsed. Operators who expose Tika to untrusted callers can reduce that with ExceptionReporting.Level and bound the size with maxLength.

• ExceptionReporting.Level.FULL - the complete stack trace (default)
• ExceptionReporting.Level.MESSAGE_REDACTED - the complete stack trace with every exception message removed; class names, frames and the cause chain are kept
• ExceptionReporting.Level.REDACTED - exception class names only (the cause chain, no frames, no messages)

maxLength caps the formatted string: a longer value is cut to maxLength characters and a ...[truncated] marker is appended (-1 = unlimited).

Loaded from the parse-context section of the config and deliberately not settable per request: a caller could otherwise turn redaction back off.

Since:

Apache Tika 4.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ExceptionReporting.Level

Field Summary

Fields

Modifier and Type	Field	Description
static final int	UNLIMITED

Constructor Summary

Constructors

Constructor	Description
ExceptionReporting()
ExceptionReporting(ExceptionReporting.Level level, int maxLength)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ExceptionReporting	get(ParseContext context)
ExceptionReporting.Level	getLevel()
int	getMaxLength()
int	hashCode()
void	setLevel(ExceptionReporting.Level level)
void	setMaxLength(int maxLength)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNLIMITED

public static final int UNLIMITED

See Also:

• Constant Field Values

Constructor Details

ExceptionReporting

public ExceptionReporting()

ExceptionReporting

public ExceptionReporting(ExceptionReporting.Level level,
 int maxLength)

Method Details

getLevel

public ExceptionReporting.Level getLevel()

setLevel

public void setLevel(ExceptionReporting.Level level)

getMaxLength

public int getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)

get

public static ExceptionReporting get(ParseContext context)

Returns:

the context's policy, or a new instance with the defaults

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object