Package org.apache.tika.detect.zip

Class DefaultZipContainerDetector

java.lang.Object

org.apache.tika.detect.zip.DefaultZipContainerDetector

All Implemented Interfaces:

Serializable, Detector

Direct Known Subclasses:

StreamingZipContainerDetector

public class DefaultZipContainerDetector
extends Object
implements Detector

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DefaultZipContainerDetector()
DefaultZipContainerDetector(List<ZipContainerDetector> zipDetectors)
DefaultZipContainerDetector(ServiceLoader loader)

Method Summary

Modifier and Type	Method	Description
MediaType	detect(InputStream input, Metadata metadata)	Detects the content type of the given input document.
int	getMarkLimit()
void	setMarkLimit(int markLimit)	If this is less than 0 and a TikaInputStream is used, the file will be spooled to disk, and detection will run on the full file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultZipContainerDetector

public DefaultZipContainerDetector()

DefaultZipContainerDetector

public DefaultZipContainerDetector(ServiceLoader loader)

DefaultZipContainerDetector

public DefaultZipContainerDetector(List<ZipContainerDetector> zipDetectors)

Method Detail

setMarkLimit

@Field
public void setMarkLimit(int markLimit)

If this is less than 0 and a TikaInputStream is used, the file will be spooled to disk, and detection will run on the full file.

If this is greater than 0 and a TikaInputStream is used, this will try detection on the stream up to the markLimit, and if that is greater than the length of the file, the streaming result will be returned. If the BoundedInputStream hits its bound during detection, the file will be spooled to disk, and detection will be run on the full file.

If a non-TikaInputStream is used, detection will only work up to the markLimit, potentially leading to lack of precision in zip-based file detection.

Parameters:

markLimit - mark limit for streaming detection

getMarkLimit

public int getMarkLimit()

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