Package org.apache.tika.detect

Class FileCommandDetector

java.lang.Object
org.apache.tika.detect.FileCommandDetector
All Implemented Interfaces:
Serializable, Detector
public class FileCommandDetector extends Object implements Detector
This runs the linux 'file' command against a file. If this is called on a TikaInputStream, it will use the underlying Path or spool the full file to disk and then run file against that.

If this is run against any other type of InputStream, it will spool up to maxBytes to disk and then run the detector.

As with all detectors, mark must be supported.

If you want to use file's mime type in the parse, e.g. to select the parser in AutoDetectParser, set setUseMime(boolean) to true. The default behavior is to store the value as FILE_MIME but rely on other detectors for the "active" mime used by Tika.

See Also:

  • Field Details

    • FILE_MIME

      public static Property FILE_MIME

  • Constructor Details

    • FileCommandDetector

      public FileCommandDetector()

  • Method Details

    • checkHasFile

      public static boolean checkHasFile()

    • checkHasFile

      public static boolean checkHasFile(String fileCommandPath)

    • detect

      public MediaType detect(InputStream input, Metadata metadata) throws IOException
      Description copied from interface: Detector
      Detects the content type of the given input document. Returns application/octet-stream if the type of the document can not be detected.

      If the document input stream is not available, then the first argument may be null. Otherwise the detector may read bytes from the start of the stream to help in type detection. The given stream is guaranteed to support the mark feature and the detector is expected to mark the stream before reading any bytes from it, and to reset the stream before returning. The stream must not be closed by the detector.

      The given input metadata is only read, not modified, by the detector.

      Specified by:
      detect in interface Detector
      Parameters:
      input - document input stream, or null
      metadata - input metadata for the document
      Returns:
      mime as identified by the file command or application/octet-stream otherwise
      Throws:
      IOException

    • setFilePath

      @Field public void setFilePath(String fileCommandPath)

    • setUseMime

      @Field public void setUseMime(boolean useMime)

    • isUseMime

      public boolean isUseMime()

    • setMaxBytes

      @Field public void setMaxBytes(int maxBytes)
      If this is not called on a TikaInputStream, this detector will spool up to this many bytes to a file to be detected by the 'file' command.
      Parameters:
      maxBytes -

    • setTimeoutMs

      @Field public void setTimeoutMs(long timeoutMs)