Class AccessChecker

  • All Implemented Interfaces:
    Serializable

    public class AccessChecker
    extends Object
    implements Serializable
    Checks whether or not a document allows extraction generally or extraction for accessibility only.
    See Also:
    Serialized Form
    • Constructor Detail

      • AccessChecker

        public AccessChecker()
        This constructs an AccessChecker that will not perform any checking and will always return without throwing an exception.

        This constructor is available to allow for Tika's legacy (<= v1.7) behavior.

      • AccessChecker

        public AccessChecker​(boolean allowExtractionForAccessibility)
        This constructs an AccessChecker that will check for whether or not content should be extracted from a document.
        Parameters:
        allowExtractionForAccessibility - if general extraction is not allowed, is extraction for accessibility allowed
    • Method Detail

      • isAllowExtractionForAccessibility

        public boolean isAllowExtractionForAccessibility()
      • check

        public void check​(Metadata metadata)
                   throws AccessPermissionException
        Checks to see if a document's content should be extracted based on metadata values and the value of allowExtractionForAccessibility in the constructor.
        Parameters:
        metadata -
        Throws:
        AccessPermissionException - if access is not permitted
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object