Package org.apache.tika.pipes.core.extractor

Class TempFileUnpackHandler

java.lang.Object

org.apache.tika.pipes.core.extractor.AbstractUnpackHandler

org.apache.tika.pipes.core.extractor.TempFileUnpackHandler

All Implemented Interfaces:

Closeable, AutoCloseable, UnpackHandler

public class TempFileUnpackHandler
extends AbstractUnpackHandler
implements Closeable

An UnpackHandler that writes embedded bytes to a temporary directory for later zipping. Files are stored with their emit key names (flattened, with path separators replaced).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TempFileUnpackHandler.EmbeddedFileInfo	Information about an embedded file stored in the temp directory.

Constructor Summary

Constructors

Constructor	Description
TempFileUnpackHandler(EmitKey containerEmitKey, UnpackConfig unpackConfig)

Method Summary

Modifier and Type	Method	Description
void	add(int id, Metadata metadata, InputStream inputStream)
void	close()
List<TempFileUnpackHandler.EmbeddedFileInfo>	getEmbeddedFiles()	Returns information about all embedded files stored.
String	getOriginalDocumentName()	Returns the name of the original document if stored.
Path	getOriginalDocumentPath()	Returns the path to the original document if stored.
Path	getTempDirectory()	Returns the temporary directory where embedded files are stored.
boolean	hasEmbeddedFiles()	Returns true if there are any embedded files stored.
boolean	hasOriginalDocument()	Returns true if the original document was stored.
void	storeOriginalDocument(InputStream inputStream, String fileName)	Stores the original container document for inclusion in the zip.

Methods inherited from class org.apache.tika.pipes.core.extractor.AbstractUnpackHandler

getEmitKey, getIds

Methods inherited from class java.lang.Object

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

Constructor Details

TempFileUnpackHandler

public TempFileUnpackHandler(EmitKey containerEmitKey,
 UnpackConfig unpackConfig)
                      throws IOException

Throws:

IOException

Method Details

add

public void add(int id,
 Metadata metadata,
 InputStream inputStream)
         throws IOException

Specified by:

add in interface UnpackHandler

Overrides:

add in class AbstractUnpackHandler

Throws:

IOException

getTempDirectory

public Path getTempDirectory()

Returns the temporary directory where embedded files are stored.

getEmbeddedFiles

public List<TempFileUnpackHandler.EmbeddedFileInfo> getEmbeddedFiles()

Returns information about all embedded files stored.

hasEmbeddedFiles

public boolean hasEmbeddedFiles()

Returns true if there are any embedded files stored.

storeOriginalDocument

public void storeOriginalDocument(InputStream inputStream,
 String fileName)
                           throws IOException

Stores the original container document for inclusion in the zip. Call this before parsing if includeOriginal is enabled.

Parameters:

inputStream - the original document input stream

fileName - the file name for the original document

Throws:

IOException

getOriginalDocumentPath

public Path getOriginalDocumentPath()

Returns the path to the original document if stored.

getOriginalDocumentName

public String getOriginalDocumentName()

Returns the name of the original document if stored.

hasOriginalDocument

public boolean hasOriginalDocument()

Returns true if the original document was stored.

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException