Package org.apache.tika.parser.executable

Class ExecutableParser

java.lang.Object

org.apache.tika.parser.executable.ExecutableParser

All Implemented Interfaces:

Serializable, MachineMetadata, Parser

public class ExecutableParser
extends Object
implements Parser, MachineMetadata

Parser for executable files. Currently supports ELF and PE

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tika.metadata.MachineMetadata

MachineMetadata.Endian

Field Summary

Fields inherited from interface org.apache.tika.metadata.MachineMetadata

ARCHITECTURE_BITS, ENDIAN, MACHINE_ALPHA, MACHINE_ARM, MACHINE_EFI, MACHINE_IA_64, MACHINE_M32R, MACHINE_M68K, MACHINE_M88K, MACHINE_MIPS, MACHINE_PPC, MACHINE_S370, MACHINE_S390, MACHINE_SH3, MACHINE_SH4, MACHINE_SH5, MACHINE_SPARC, MACHINE_TYPE, MACHINE_UNKNOWN, MACHINE_VAX, MACHINE_x86_32, MACHINE_x86_64, PLATFORM, PLATFORM_AIX, PLATFORM_ARM, PLATFORM_EMBEDDED, PLATFORM_FREEBSD, PLATFORM_HPUX, PLATFORM_IRIX, PLATFORM_LINUX, PLATFORM_NETBSD, PLATFORM_SOLARIS, PLATFORM_SYSV, PLATFORM_TRU64, PLATFORM_WINDOWS, PREFIX

Constructor Summary

Constructors

Constructor	Description
ExecutableParser()

Method Summary

Modifier and Type	Method	Description
Set<MediaType>	getSupportedTypes(ParseContext context)	Returns the set of media types supported by this parser when used with the given parse context.
void	parse(InputStream stream, ContentHandler handler, Metadata metadata, ParseContext context)	Parses a document stream into a sequence of XHTML SAX events.
void	parseELF(XHTMLContentHandler xhtml, Metadata metadata, InputStream stream, byte[] first4)	Parses a Unix ELF file
void	parseMachO(XHTMLContentHandler xhtml, Metadata metadata, InputStream stream, byte[] first4)	Parses a Mach-O file
void	parsePE(XHTMLContentHandler xhtml, Metadata metadata, InputStream stream, byte[] first4)	Parses a DOS or Windows PE file

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutableParser

public ExecutableParser()

Method Details

getSupportedTypes

public Set<MediaType> getSupportedTypes(ParseContext context)

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:

context - parse context

Returns:

immutable set of media types

parse

public void parse(InputStream stream,
 ContentHandler handler,
 Metadata metadata,
 ParseContext context)
           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:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - 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

parsePE

public void parsePE(XHTMLContentHandler xhtml,
 Metadata metadata,
 InputStream stream,
 byte[] first4)
             throws TikaException,
IOException

Parses a DOS or Windows PE file

Throws:

TikaException

IOException

parseELF

public void parseELF(XHTMLContentHandler xhtml,
 Metadata metadata,
 InputStream stream,
 byte[] first4)
              throws TikaException,
IOException

Parses a Unix ELF file

Throws:

TikaException

IOException

parseMachO

public void parseMachO(XHTMLContentHandler xhtml,
 Metadata metadata,
 InputStream stream,
 byte[] first4)
                throws TikaException,
IOException

Parses a Mach-O file

Throws:

TikaException

IOException