Package org.apache.tika.io

Class TikaInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.TaggedInputStream

org.apache.tika.io.TikaInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class TikaInputStream
extends org.apache.commons.io.input.TaggedInputStream

Input stream with extended capabilities for detection and parsing.

This implementation uses backing strategies to handle different input types:

• ByteArraySource for byte[] inputs - no caching needed
• FileSource for Path/File inputs - direct file access
• CachingSource for InputStream inputs - passthrough by default; caches bytes only after enableRewind()

Since:

Apache Tika 0.8

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.io.input.ProxyInputStream

org.apache.commons.io.input.ProxyInputStream.AbstractBuilder<T,B extends org.apache.commons.io.build.AbstractStreamBuilder<T,B>>

Field Summary

Fields inherited from class java.io.FilterInputStream

in

Method Summary

Modifier and Type	Method	Description
void	addCloseableResource(Closeable closeable)
protected void	afterRead(int n)
void	close()
void	enableRewind()	Enables full rewind capability for this stream.
static TikaInputStream	get(byte[] data)
static TikaInputStream	get(byte[] data, Metadata metadata)
static TikaInputStream	get(File file)
static TikaInputStream	get(File file, Metadata metadata)
static TikaInputStream	get(InputStream stream)
static TikaInputStream	get(InputStream stream, TemporaryResources tmp, Metadata metadata)
static TikaInputStream	get(InputStream stream, Metadata metadata)
static TikaInputStream	get(URI uri)
static TikaInputStream	get(URI uri, Metadata metadata)
static TikaInputStream	get(URL url)
static TikaInputStream	get(URL url, Metadata metadata)
static TikaInputStream	get(Path path)
static TikaInputStream	get(Path path, Metadata metadata)
static TikaInputStream	get(Path path, Metadata metadata, TemporaryResources tmp)
static TikaInputStream	get(Blob blob)
static TikaInputStream	get(Blob blob, Metadata metadata)
File	getFile()
FileChannel	getFileChannel()
static TikaInputStream	getFromContainer(Object openContainer, long length, Metadata metadata)
long	getLength()	The stream length.
Object	getOpenContainer()
Path	getPath()
long	getPosition()
boolean	hasFile()
boolean	hasLength()
boolean	isCloseShield()
void	mark(int readlimit)
boolean	markSupported()
int	peek(byte[] buffer)
void	removeCloseShield()
void	reset()
void	rewind()	Rewind the stream to the beginning.
void	setCloseShield()
void	setOpenContainer(Object container)
long	skip(long n)	Skips up to n bytes.
String	toString()

Methods inherited from class org.apache.commons.io.input.TaggedInputStream

handleIOException, isCauseOf, throwIfCauseOf

Methods inherited from class org.apache.commons.io.input.ProxyInputStream

available, beforeRead, read, read, read, setReference, unwrap

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Method Details

get

public static TikaInputStream get(InputStream stream,
 TemporaryResources tmp,
 Metadata metadata)

get

public static TikaInputStream get(InputStream stream)

get

public static TikaInputStream get(InputStream stream,
 Metadata metadata)

get

public static TikaInputStream get(byte[] data)

get

public static TikaInputStream get(byte[] data,
 Metadata metadata)

get

public static TikaInputStream get(Path path)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(Path path,
 Metadata metadata)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(Path path,
 Metadata metadata,
 TemporaryResources tmp)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(File file)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(File file,
 Metadata metadata)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(Blob blob)
                           throws SQLException,
IOException

Throws:

SQLException

IOException

get

public static TikaInputStream get(Blob blob,
 Metadata metadata)
                           throws SQLException,
IOException

Throws:

SQLException

IOException

get

public static TikaInputStream get(URI uri)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(URI uri,
 Metadata metadata)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(URL url)
                           throws IOException

Throws:

IOException

get

public static TikaInputStream get(URL url,
 Metadata metadata)
                           throws IOException

Throws:

IOException

getFromContainer

public static TikaInputStream getFromContainer(Object openContainer,
 long length,
 Metadata metadata)

skip

public long skip(long n)
          throws IOException

Skips up to n bytes. Returns the actual number of bytes skipped, which may be less than requested if the end of stream is reached.

This method does NOT throw EOFException if fewer bytes are available. Callers must check the return value to determine how many bytes were actually skipped.

Overrides:

skip in class org.apache.commons.io.input.ProxyInputStream

Parameters:

n - the number of bytes to skip

Returns:

the actual number of bytes skipped (may be less than n)

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class org.apache.commons.io.input.ProxyInputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class org.apache.commons.io.input.ProxyInputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class org.apache.commons.io.input.ProxyInputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class org.apache.commons.io.input.ProxyInputStream

Throws:

IOException

afterRead

protected void afterRead(int n)
                  throws IOException

Overrides:

afterRead in class org.apache.commons.io.input.ProxyInputStream

Throws:

IOException

peek

public int peek(byte[] buffer)
         throws IOException

Throws:

IOException

getOpenContainer

public Object getOpenContainer()

setOpenContainer

public void setOpenContainer(Object container)

addCloseableResource

public void addCloseableResource(Closeable closeable)

hasFile

public boolean hasFile()

getPath

public Path getPath()
             throws IOException

Throws:

IOException

getFile

public File getFile()
             throws IOException

Throws:

IOException

getFileChannel

public FileChannel getFileChannel()
                           throws IOException

Throws:

IOException

hasLength

public boolean hasLength()

getLength

public long getLength()
               throws IOException

The stream length. For a stream-backed instance with no declared length this spools the entire remaining stream to a temporary file to measure it.

Throws:

IOException

getPosition

public long getPosition()

setCloseShield

public void setCloseShield()

removeCloseShield

public void removeCloseShield()

isCloseShield

public boolean isCloseShield()

rewind

public void rewind()
            throws IOException

Rewind the stream to the beginning.

For streams created from byte arrays or files, this always works. For streams created from raw InputStreams, this requires enableRewind() to have been called first.

Throws:

IOException

enableRewind

public void enableRewind()
                  throws IOException

Enables full rewind capability for this stream.

For streams backed by byte arrays or files, this is a no-op since they are inherently rewindable. For streams backed by raw InputStreams, this switches from passthrough mode to caching mode, enabling subsequent rewind(), mark(int)/reset(), and random access.

Must be called when position is 0 (before any reading), otherwise throws IOException.

Use this method when you know you'll need to rewind the stream later (e.g., for detection followed by parsing, or digest calculation). For streaming-only operations (e.g., HTML parsing), skip this call to avoid unnecessary caching overhead.

Throws:

IOException - if bytes have already been read from the stream (position is not 0); rewind support cannot be enabled retroactively

toString

public String toString()

Overrides:

toString in class Object