Package org.apache.tika.detect.siegfried

Class SiegfriedDetector

java.lang.Object

org.apache.tika.detect.siegfried.SiegfriedDetector

All Implemented Interfaces:

Serializable, SelfConfiguring, Detector

public class SiegfriedDetector
extends Object
implements Detector

Simple wrapper around Siegfried https://github.com/richardlehane/siegfried The default behavior is to run detection, report the results in the metadata and then return null so that other detectors will be used.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SiegfriedDetector.Config	Configuration class for JSON deserialization.
static class	SiegfriedDetector.RuntimeConfig	RuntimeConfig blocks modification of security-sensitive path fields at runtime.

Field Summary

Fields

Modifier and Type	Field	Description
static String	BASIS
static String	ERRORS
static String	FORMAT
static String	ID
static String	MIME
static Property	SIEGFRIED_ERRORS
static Property	SIEGFRIED_IDENTIFIERS_DETAILS
static Property	SIEGFRIED_IDENTIFIERS_NAME
static final String	SIEGFRIED_PREFIX
static Property	SIEGFRIED_SIGNATURE
static Property	SIEGFRIED_STATUS
static Property	SIEGFRIED_VERSION
static String	VERSION
static String	WARNING

Constructor Summary

Constructors

Constructor	Description
SiegfriedDetector()	Default constructor.
SiegfriedDetector(JsonConfig jsonConfig)	Constructor for JSON configuration.

Method Summary

Modifier and Type	Method	Description
static boolean	checkHasSiegfried(String siegfriedCommandPath)
MediaType	detect(TikaInputStream tis, Metadata metadata, ParseContext parseContext)	Detects the content type of the given input document.
SiegfriedDetector.Config	getDefaultConfig()
protected static MediaType	processResult(FileProcessResult result, Metadata metadata, boolean returnMime)

Methods inherited from class java.lang.Object

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

Field Details

SIEGFRIED_PREFIX

public static final String SIEGFRIED_PREFIX

See Also:

• Constant Field Values

SIEGFRIED_STATUS

public static Property SIEGFRIED_STATUS

SIEGFRIED_VERSION

public static Property SIEGFRIED_VERSION

SIEGFRIED_SIGNATURE

public static Property SIEGFRIED_SIGNATURE

SIEGFRIED_IDENTIFIERS_NAME

public static Property SIEGFRIED_IDENTIFIERS_NAME

SIEGFRIED_IDENTIFIERS_DETAILS

public static Property SIEGFRIED_IDENTIFIERS_DETAILS

SIEGFRIED_ERRORS

public static Property SIEGFRIED_ERRORS

ID

public static String ID

FORMAT

public static String FORMAT

VERSION

public static String VERSION

MIME

public static String MIME

WARNING

public static String WARNING

BASIS

public static String BASIS

ERRORS

public static String ERRORS

Constructor Details

SiegfriedDetector

public SiegfriedDetector()

Default constructor.

SiegfriedDetector

public SiegfriedDetector(JsonConfig jsonConfig)

Constructor for JSON configuration. Requires tika-serialization on the classpath.

Parameters:

jsonConfig - JSON configuration

Method Details

checkHasSiegfried

public static boolean checkHasSiegfried(String siegfriedCommandPath)

detect

public MediaType detect(TikaInputStream tis,
 Metadata metadata,
 ParseContext parseContext)
                 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 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:

tis - document input stream, or null

metadata - input metadata for the document

parseContext - the parse context

Returns:

mime as identified by the file command or application/octet-stream otherwise

Throws:

IOException

getDefaultConfig

public SiegfriedDetector.Config getDefaultConfig()

processResult

protected static MediaType processResult(FileProcessResult result,
 Metadata metadata,
 boolean returnMime)