Class POIFSContainerDetector

  • All Implemented Interfaces:
    Serializable, Detector

    public class POIFSContainerDetector
    extends Object
    implements Detector
    A detector that works on a POIFS OLE2 document to figure out exactly what the file is. This should work for all OLE2 documents, whether they are ones supported by POI or not.
    See Also:
    Serialized Form
    • Field Detail

      • OLE

        public static final MediaType OLE
        The OLE base file format

        public static final MediaType OOXML_PROTECTED
        The protected OOXML base file format

        public static final MediaType DRM_ENCRYPTED
        TIKA-3666 MSOffice or other file encrypted with DRM in an OLE container

        public static final MediaType GENERAL_EMBEDDED
        General embedded document type within an OLE2 container
      • OLE10_NATIVE

        public static final MediaType OLE10_NATIVE
        An OLE10 Native embedded document within another OLE2 document
      • COMP_OBJ

        public static final MediaType COMP_OBJ
        Some other kind of embedded document, in a CompObj container within another OLE2 document

        public static final MediaType MS_GRAPH_CHART
        Graph/Charts embedded in PowerPoint and Excel

        public static final MediaType MS_EQUATION
        Equation embedded in Office docs
      • XLS

        public static final MediaType XLS
        Microsoft Excel
      • DOC

        public static final MediaType DOC
        Microsoft Word
      • PPT

        public static final MediaType PPT
        Microsoft PowerPoint
      • PUB

        public static final MediaType PUB
        Microsoft Publisher
      • VSD

        public static final MediaType VSD
        Microsoft Visio
      • WPS

        public static final MediaType WPS
        Microsoft Works
      • XLR

        public static final MediaType XLR
        Microsoft Works Spreadsheet 7.0
      • MSG

        public static final MediaType MSG
        Microsoft Outlook
      • MPP

        public static final MediaType MPP
        Microsoft Project
      • SDC

        public static final MediaType SDC
        StarOffice Calc
      • SDA

        public static final MediaType SDA
        StarOffice Draw
      • SDD

        public static final MediaType SDD
        StarOffice Impress
      • SDW

        public static final MediaType SDW
        StarOffice Writer
      • SLDWORKS

        public static final MediaType SLDWORKS
        SolidWorks CAD file
      • ESRI_LAYER

        public static final MediaType ESRI_LAYER
    • Constructor Detail

      • POIFSContainerDetector

        public POIFSContainerDetector()
    • Method Detail

      • detect

        public static MediaType detect​(Set<String> names)
        Use detect(Set, DirectoryEntry) and pass the root entry of the filesystem whose type is to be detected, as a second argument.
        Internal detection of the specific kind of OLE2 document, based on the names of the top level streams within the file.
      • detect

        public static MediaType detect​(Set<String> anyCaseNames,
                                       org.apache.poi.poifs.filesystem.DirectoryEntry root)
        Internal detection of the specific kind of OLE2 document, based on the names of the top-level streams within the file. In some cases the detection may need access to the root DirectoryEntry of that file for best results. The entry can be given as a second, optional argument.

        Following 2.6.1 of MS-CFB , The detection is performed on case insensitive entry names.

        anyCaseNames -
        root -
      • setMarkLimit

        public void setMarkLimit​(int markLimit)
        If a TikaInputStream is passed in to detect(InputStream, Metadata), and there is not an underlying file, this detector will spool up to markLimit to disk. If the stream was read in entirety (e.g. the spooled file is not truncated), this detector will open the file with POI and perform detection. If the spooled file is truncated, the detector will return OLE (or MediaType.OCTET_STREAM if there's no OLE header).

        As of Tika 1.21, this detector respects the legacy behavior of not performing detection on a non-TikaInputStream.

        markLimit -
      • 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
        input - document input stream, or null
        metadata - input metadata for the document
        detected media type, or application/octet-stream
        IOException - if the document input stream could not be read