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

Class LibPstParser

java.lang.Object

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

All Implemented Interfaces:

Serializable, org.apache.tika.config.Initializable, org.apache.tika.parser.Parser

public class LibPstParser
extends Object
implements org.apache.tika.parser.Parser, org.apache.tika.config.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 org.apache.tika.mime.MediaType	MS_OUTLOOK_PST_MIMETYPE

Constructor Summary

Constructors

Constructor	Description
LibPstParser()

Method Summary

Modifier and Type	Method	Description
void	checkInitialization(org.apache.tika.config.InitializableProblemHandler initializableProblemHandler)
boolean	checkQuietly()
Set<org.apache.tika.mime.MediaType>	getSupportedTypes(org.apache.tika.parser.ParseContext parseContext)
void	initialize(Map<String,org.apache.tika.config.Param> map)
void	parse(InputStream inputStream, ContentHandler contentHandler, org.apache.tika.metadata.Metadata metadata, org.apache.tika.parser.ParseContext parseContext)
void	setIncludeDeleted(boolean includeDeleted)
void	setMaxEmails(int maxEmails)
void	setProcessEmailAsMsg(boolean processEmailAsMsg)
void	setReadPstPath(String readPstPath)	This should include the path up to but not including 'readpst', e.g.
void	setTimeoutSeconds(long timeoutSeconds)

Methods inherited from class java.lang.Object

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

Field Detail

MS_OUTLOOK_PST_MIMETYPE

public static final org.apache.tika.mime.MediaType MS_OUTLOOK_PST_MIMETYPE

Constructor Detail

LibPstParser

public LibPstParser()

Method Detail

getSupportedTypes

public Set<org.apache.tika.mime.MediaType> getSupportedTypes(org.apache.tika.parser.ParseContext parseContext)

Specified by:

getSupportedTypes in interface org.apache.tika.parser.Parser

parse

public void parse(InputStream inputStream,
                  ContentHandler contentHandler,
                  org.apache.tika.metadata.Metadata metadata,
                  org.apache.tika.parser.ParseContext parseContext)
           throws IOException,
                  SAXException,
                  org.apache.tika.exception.TikaException

Specified by:

parse in interface org.apache.tika.parser.Parser

Throws:

IOException

SAXException

org.apache.tika.exception.TikaException

initialize

public void initialize(Map<String,org.apache.tika.config.Param> map)
                throws org.apache.tika.exception.TikaConfigException

Specified by:

initialize in interface org.apache.tika.config.Initializable

Throws:

org.apache.tika.exception.TikaConfigException

checkInitialization

public void checkInitialization(org.apache.tika.config.InitializableProblemHandler initializableProblemHandler)
                         throws org.apache.tika.exception.TikaConfigException

Specified by:

checkInitialization in interface org.apache.tika.config.Initializable

Throws:

org.apache.tika.exception.TikaConfigException

checkQuietly

public boolean checkQuietly()

setTimeoutSeconds

@Field
public void setTimeoutSeconds(long timeoutSeconds)

setProcessEmailAsMsg

@Field
public void setProcessEmailAsMsg(boolean processEmailAsMsg)

setIncludeDeleted

@Field
public void setIncludeDeleted(boolean includeDeleted)

setMaxEmails

@Field
public void setMaxEmails(int maxEmails)

setReadPstPath

@Field
public void setReadPstPath(String readPstPath)

This should include the path up to but not including 'readpst', e.g. "C:\my_bin" where readpst is at "C:\my_bin\readpst"

Parameters:

readPstPath -