Package org.apache.tika.detect

Class FileCommandDetector

  • All Implemented Interfaces:
    java.io.Serializable, Detector
    public class FileCommandDetector
extends java.lang.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.
    See Also:
    Serialized Form

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static boolean checkHasFile()  
      static boolean checkHasFile​(java.lang.String fileCommandPath)  
      MediaType detect​(java.io.InputStream input, Metadata metadata)
      Detects the content type of the given input document.
      void setFilePath​(java.lang.String fileCommandPath)  
      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.
      void setTimeoutMs​(long timeoutMs)  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • FileCommandDetector

        public FileCommandDetector()

    • Method Detail

      • checkHasFile

        public static boolean checkHasFile()

      • checkHasFile

        public static boolean checkHasFile​(java.lang.String fileCommandPath)

      • detect

        public MediaType detect​(java.io.InputStream input,
                        Metadata metadata)
                 throws java.io.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:
        java.io.IOException

      • setFilePath

        @Field
public void setFilePath​(java.lang.String fileCommandPath)

      • 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)