Package org.apache.tika.pipes.core

Class PipesParser

java.lang.Object

org.apache.tika.pipes.core.PipesParser

All Implemented Interfaces:

Closeable, AutoCloseable

public class PipesParser
extends Object
implements Closeable

Method Summary

Modifier and Type	Method	Description
void	close()
int	getCurrentServerPort()	Returns the current server port.
long	getGeneration()	Total forks performed across this parser's server managers.
int	getIdleClientCount()	Clients not currently borrowed by a parse(org.apache.tika.pipes.api.FetchEmitTuple) call.
int	getNumClients()
long	getRestartCount(RestartReason reason)	Forked-server restarts performed so far for reason, summed over all servers.
boolean	isSharedMode()
static PipesParser	load(Path tikaConfigPath)	Loads a PipesParser from a configuration file path.
static PipesParser	load(TikaJsonConfig tikaJsonConfig, PipesConfig pipesConfig)	Loads a PipesParser from pre-loaded configuration objects.
static PipesParser	load(TikaJsonConfig tikaJsonConfig, PipesConfig pipesConfig, Path tikaConfigPath)	Deprecated. forked servers no longer read the config file; use load(TikaJsonConfig, PipesConfig).
PipesResult	parse(FetchEmitTuple t)
void	start()	Starts every idle client's server now and waits until each is ready, instead of on the first parse(org.apache.tika.pipes.api.FetchEmitTuple).

Methods inherited from class java.lang.Object

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

Method Details

load

public static PipesParser load(Path tikaConfigPath)
                        throws IOException,
TikaConfigException

Loads a PipesParser from a configuration file path.

This method:

1. Loads the JSON configuration
2. Pre-extracts plugins before spawning child processes
3. Creates the PipesParser with the loaded configuration

Parameters:

tikaConfigPath - path to the tika-config.json file

Returns:

a new PipesParser instance

Throws:

IOException - if reading config or extraction fails

TikaConfigException - if configuration is invalid

load

public static PipesParser load(TikaJsonConfig tikaJsonConfig,
 PipesConfig pipesConfig)
                        throws IOException

Loads a PipesParser from pre-loaded configuration objects.

Use this method when you need to modify the PipesConfig before creating the parser (e.g., to override emit strategy).

Parameters:

tikaJsonConfig - the pre-loaded JSON configuration; forked servers receive this config, env references already resolved, over their stdin

pipesConfig - the pipes configuration (may be modified by caller)

Returns:

a new PipesParser instance

Throws:

IOException - if plugin extraction or config serialization fails

load

@Deprecated
public static PipesParser load(TikaJsonConfig tikaJsonConfig,
 PipesConfig pipesConfig,
 Path tikaConfigPath)
                        throws IOException

Deprecated.

forked servers no longer read the config file; use load(TikaJsonConfig, PipesConfig). tikaConfigPath is ignored.

Throws:

IOException

parse

public PipesResult parse(FetchEmitTuple t)
                  throws InterruptedException,
PipesException,
IOException

Throws:

InterruptedException

PipesException

IOException

start

public void start()
           throws InterruptedException,
ServerInitializationException

Starts every idle client's server now and waits until each is ready, instead of on the first parse(org.apache.tika.pipes.api.FetchEmitTuple). Optional: it surfaces a server that can't start (bad config, a missing plugin) before work is queued. Clients busy in a parse(org.apache.tika.pipes.api.FetchEmitTuple) are skipped; they are already up.

Throws:

ServerInitializationException - if a server fails to start

InterruptedException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getNumClients

public int getNumClients()

getIdleClientCount

public int getIdleClientCount()

Clients not currently borrowed by a parse(org.apache.tika.pipes.api.FetchEmitTuple) call.

getRestartCount

public long getRestartCount(RestartReason reason)

Forked-server restarts performed so far for reason, summed over all servers.

getGeneration

public long getGeneration()

Total forks performed across this parser's server managers. One more than the number of restarts, since the first start of each manager is not a restart. Exposed for tests: it is the only observable that distinguishes a justified restart from a spurious one.

isSharedMode

public boolean isSharedMode()

getCurrentServerPort

public int getCurrentServerPort()

Returns the current server port. For testing purposes only. In shared mode, returns the port of the shared server. In per-client mode, returns the port of the first client's server.

Returns:

the current server port, or -1 if no server is running