Package org.apache.tika.pipes.core.fetcher

Class PayloadRouter

java.lang.Object

org.apache.tika.pipes.core.fetcher.PayloadRouter

public final class PayloadRouter
extends Object

Decides how a document reaches the forked worker: as bytes on the wire, or as a file the worker opens itself.

Every host that hands pipes an already-open stream needs this same decision, so it lives here rather than in each of them -- three copies would be three thresholds that drift apart.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PayloadRouter.Route
static final class	PayloadRouter.Routed	The outcome.
static interface	PayloadRouter.SpoolTarget	Creates the file a SPOOLED payload is written to.

Method Summary

Modifier and Type	Method	Description
static PayloadRouter.Routed	route(InputStream is, int maxInlineBytes, PayloadRouter.SpoolTarget spoolTarget)	Reads a stream the same way route(org.apache.tika.io.TikaInputStream, int, org.apache.tika.pipes.core.fetcher.PayloadRouter.SpoolTarget) does; for callers holding a plain stream.
static PayloadRouter.Routed	route(TikaInputStream tis, int maxInlineBytes, PayloadRouter.SpoolTarget spoolTarget)	Routes tis, reading no more than it must to decide.

Methods inherited from class java.lang.Object

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

Method Details

route

public static PayloadRouter.Routed route(TikaInputStream tis,
 int maxInlineBytes,
 PayloadRouter.SpoolTarget spoolTarget)
                                  throws IOException

Routes tis, reading no more than it must to decide.

A stream that already has a file keeps it: reading an on-disk document into heap to push it through a socket is strictly worse than letting the worker open the file. Otherwise the decision is made from bytes actually read -- a declared length is absent under chunked transfer encoding and client-supplied besides.

Parameters:

tis - the content; not closed here

maxInlineBytes - largest payload carried inline; 0 disables inlining

spoolTarget - invoked only if the content exceeds maxInlineBytes

Throws:

IOException

route

public static PayloadRouter.Routed route(InputStream is,
 int maxInlineBytes,
 PayloadRouter.SpoolTarget spoolTarget)
                                  throws IOException

Reads a stream the same way route(org.apache.tika.io.TikaInputStream, int, org.apache.tika.pipes.core.fetcher.PayloadRouter.SpoolTarget) does; for callers holding a plain stream.

Throws:

IOException