Package org.apache.tika.parser.pdf

Enum Class PDFParserConfig.AccessCheckMode

java.lang.Object

java.lang.Enum<PDFParserConfig.AccessCheckMode>

org.apache.tika.parser.pdf.PDFParserConfig.AccessCheckMode

All Implemented Interfaces:

Serializable, Comparable<PDFParserConfig.AccessCheckMode>, Constable

Enclosing class:

PDFParserConfig

public static enum PDFParserConfig.AccessCheckMode
extends Enum<PDFParserConfig.AccessCheckMode>

Mode for checking document access permissions.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW_EXTRACTION_FOR_ACCESSIBILITY	Check permissions, but allow extraction for accessibility purposes if extraction for accessibility is allowed.
DONT_CHECK	Don't check extraction permissions.
IGNORE_ACCESSIBILITY_ALLOWANCE	If extraction is blocked, throw an AccessPermissionException even if the document allows extraction for accessibility.

Method Summary

Modifier and Type	Method	Description
static PDFParserConfig.AccessCheckMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PDFParserConfig.AccessCheckMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DONT_CHECK

public static final PDFParserConfig.AccessCheckMode DONT_CHECK

Don't check extraction permissions. Content will always be extracted regardless of document permissions. This is the default for backwards compatibility with Tika's legacy behavior (<= v1.7).

ALLOW_EXTRACTION_FOR_ACCESSIBILITY

public static final PDFParserConfig.AccessCheckMode ALLOW_EXTRACTION_FOR_ACCESSIBILITY

Check permissions, but allow extraction for accessibility purposes if extraction for accessibility is allowed.

IGNORE_ACCESSIBILITY_ALLOWANCE

public static final PDFParserConfig.AccessCheckMode IGNORE_ACCESSIBILITY_ALLOWANCE

If extraction is blocked, throw an AccessPermissionException even if the document allows extraction for accessibility.

Method Details

values

public static PDFParserConfig.AccessCheckMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static PDFParserConfig.AccessCheckMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null