Package org.apache.tika.parser.pkg

Class ZipContainerDetector

java.lang.Object

org.apache.tika.parser.pkg.ZipContainerDetector

All Implemented Interfaces:

Serializable, Detector

public class ZipContainerDetector
extends Object
implements Detector

A detector that works on Zip documents and other archive and compression formats to figure out exactly what the file is.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ZipContainerDetector()

Method Summary

Modifier and Type	Method	Description
MediaType	detect(InputStream input, Metadata metadata)	Detects the content type of the given input document.
static MediaType	detectOfficeOpenXML(OPCPackage pkg)	Detects the type of an OfficeOpenXML (OOXML) file from opened Package
void	setMarkLimit(int markLimit)	If this is less than 0, the file will be spooled to disk, and detection will run on the full file.

Methods inherited from class java.lang.Object

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

Constructor Details

ZipContainerDetector

public ZipContainerDetector()

Method Details

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:

detected media type, or application/octet-stream

Throws:

IOException - if the document input stream could not be read

setMarkLimit

@Field
public void setMarkLimit(int markLimit)

If this is less than 0, the file will be spooled to disk, and detection will run on the full file. If this is greater than 0, the StreamingZipContainerDetector will be called only up to the markLimit.

Parameters:

markLimit - mark limit for streaming detection

detectOfficeOpenXML

public static MediaType detectOfficeOpenXML(OPCPackage pkg)

Detects the type of an OfficeOpenXML (OOXML) file from opened Package