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

Class LibPstParser

java.lang.Object
org.apache.tika.parser.microsoft.libpst.LibPstParser
All Implemented Interfaces:
Serializable, Initializable, 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:

  • Field Details

    • MS_OUTLOOK_PST_MIMETYPE

      public static final MediaType MS_OUTLOOK_PST_MIMETYPE

  • Constructor Details

    • LibPstParser

      public LibPstParser()

  • 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(InputStream inputStream, 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
      Parameters:
      inputStream - the document stream (input)
      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(Map<String,Param> map) throws TikaConfigException
      Specified by:
      initialize in interface Initializable
      Parameters:
      map - params to use for initialization
      Throws:
      TikaConfigException

    • checkInitialization

      public void checkInitialization(InitializableProblemHandler initializableProblemHandler) throws TikaConfigException
      Specified by:
      checkInitialization in interface Initializable
      Parameters:
      initializableProblemHandler - if there is a problem and no custom initializableProblemHandler has been configured via Initializable parameters, this is called to respond.
      Throws:
      TikaConfigException

    • checkQuietly

      public static 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)