Package org.apache.tika.parser.microsoft.rtf.jflex

Class RTFObjDataStreamParser

java.lang.Object

org.apache.tika.parser.microsoft.rtf.jflex.RTFObjDataStreamParser

All Implemented Interfaces:

Closeable, AutoCloseable

public class RTFObjDataStreamParser
extends Object
implements Closeable

Parses OLE objdata from an RTF stream inline, byte by byte.

The OLE objdata structure is:

   [4 bytes version][4 bytes formatId]
   [4 bytes classNameLen][classNameLen bytes className]
   [4 bytes topicNameLen][topicNameLen bytes topicName]
   [4 bytes itemNameLen][itemNameLen bytes itemName]
   [4 bytes dataSz][dataSz bytes payload]
 

The small header fields are parsed byte-by-byte via a state machine. Once the header is complete and dataSz is known, the payload bytes stream directly to a temp file -- never buffered in memory.

On onComplete(Metadata, AtomicInteger), the payload is interpreted based on className (Package, PBrush, POIFS, etc.) and the extracted content is returned as a TikaInputStream whose close will clean up all temp files via TemporaryResources.

Constructor Summary

Constructors

Constructor	Description
RTFObjDataStreamParser(long maxBytes)

Method Summary

Modifier and Type	Method	Description
void	close()
void	onByte(int b)	Receive a single decoded byte from the objdata hex stream.
TikaInputStream	onComplete(Metadata metadata, AtomicInteger unknownFilenameCount)	Called when the objdata group closes.

Methods inherited from class java.lang.Object

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

Constructor Details

RTFObjDataStreamParser

public RTFObjDataStreamParser(long maxBytes)

Parameters:

maxBytes - maximum payload bytes to accept (-1 for unlimited)

Method Details

onByte

public void onByte(int b)
            throws IOException,
TikaException

Receive a single decoded byte from the objdata hex stream.

Throws:

IOException

TikaException

onComplete

public TikaInputStream onComplete(Metadata metadata,
 AtomicInteger unknownFilenameCount)
                           throws IOException,
TikaException

Called when the objdata group closes. Populates metadata and returns a TikaInputStream with the extracted embedded content, or null if the object couldn't be parsed.

The caller owns the returned TikaInputStream -- closing it will clean up all temp files via TemporaryResources.

Throws:

IOException

TikaException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException