Package org.apache.tika.parser.microsoft.libpst

Class LibPstParser

java.lang.Object

org.apache.tika.parser.microsoft.libpst.LibPstParser

All Implemented Interfaces:

Serializable, Initializable, SelfConfiguring, Parser

public class LibPstParser
extends Object
implements Parser, Initializable

This is an optional PST parser that relies on the user installing the GPL-3 libpst/readpst commandline tool and configuring Tika to call this library via tika-config.xml

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final MediaType	MS_OUTLOOK_PST_MIMETYPE

Constructor Summary

Constructors

Constructor	Description
LibPstParser()
LibPstParser(JsonConfig jsonConfig)
LibPstParser(LibPstParserConfig config)

Method Summary

Modifier and Type	Method	Description
boolean	checkQuietly()
LibPstParserConfig	getDefaultConfig()
Set<MediaType>	getSupportedTypes(ParseContext parseContext)	Returns the set of media types supported by this parser when used with the given parse context.
void	initialize()	Called after all properties have been set to allow for validation and initialization that depends on multiple properties.
void	parse(TikaInputStream tis, ContentHandler contentHandler, Metadata metadata, ParseContext parseContext)	Parses a document stream into a sequence of XHTML SAX events.

Methods inherited from class java.lang.Object

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

Field Details

MS_OUTLOOK_PST_MIMETYPE

public static final MediaType MS_OUTLOOK_PST_MIMETYPE

Constructor Details

LibPstParser

public LibPstParser()

LibPstParser

public LibPstParser(LibPstParserConfig config)

LibPstParser

public LibPstParser(JsonConfig jsonConfig)

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext parseContext)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Specified by:

getSupportedTypes in interface Parser

Parameters:

parseContext - parse context

Returns:

immutable set of media types

parse

public void parse(TikaInputStream tis,
 ContentHandler contentHandler,
 Metadata metadata,
 ParseContext parseContext)
           throws IOException,
SAXException,
TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Specified by:

parse in interface Parser

contentHandler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

parseContext - parse context

Throws:

IOException - if the document stream could not be read

SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

initialize

public void initialize()
                throws TikaConfigException

Description copied from interface: Initializable

Called after all properties have been set to allow for validation and initialization that depends on multiple properties.

Specified by:

initialize in interface Initializable

Throws:

TikaConfigException - if there is a problem with the configuration

checkQuietly

public boolean checkQuietly()

getDefaultConfig

public LibPstParserConfig getDefaultConfig()