org.apache.tika.fork

Class ForkParser

java.lang.Object

org.apache.tika.parser.AbstractParser

org.apache.tika.fork.ForkParser

All Implemented Interfaces:

java.io.Serializable, Parser

public class ForkParser
extends AbstractParser

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ForkParser()
ForkParser(java.lang.ClassLoader loader)
ForkParser(java.lang.ClassLoader loader, Parser parser)

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.String	getJavaCommand() Deprecated. since 1.8
java.util.List<java.lang.String>	getJavaCommandAsList() Returns the command used to start the forked server process.
int	getPoolSize() Returns the size of the process pool.
java.util.Set<MediaType>	getSupportedTypes(ParseContext context) Returns the set of media types supported by this parser when used with the given parse context.
void	parse(java.io.InputStream stream, org.xml.sax.ContentHandler handler, Metadata metadata, ParseContext context) Parses a document stream into a sequence of XHTML SAX events.
void	setJavaCommand(java.util.List<java.lang.String> java) Sets the command used to start the forked server process.
void	setJavaCommand(java.lang.String java) Deprecated. since 1.8
void	setPoolSize(int poolSize) Sets the size of the process pool.
void	setServerPulseMillis(long serverPulseMillis) The amount of time in milliseconds that the server should wait for any input or output.

Methods inherited from class org.apache.tika.parser.AbstractParser

parse

Methods inherited from class java.lang.Object

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

Constructor Detail

ForkParser

public ForkParser(java.lang.ClassLoader loader,
                  Parser parser)

Parameters:

loader - The ClassLoader to use

parser - the parser to delegate to. This one cannot be another ForkParser

ForkParser

public ForkParser(java.lang.ClassLoader loader)

ForkParser

public ForkParser()

Method Detail

getPoolSize

public int getPoolSize()

Returns the size of the process pool.

Returns:

process pool size

setPoolSize

public void setPoolSize(int poolSize)

Sets the size of the process pool.

Parameters:

poolSize - process pool size

getJavaCommand

@Deprecated
public java.lang.String getJavaCommand()

Deprecated. since 1.8

Returns the command used to start the forked server process.

Returns:

java command line

See Also:

getJavaCommandAsList()

getJavaCommandAsList

public java.util.List<java.lang.String> getJavaCommandAsList()

Returns the command used to start the forked server process.

Returned list is unmodifiable.

Returns:

java command line args

setJavaCommand

public void setJavaCommand(java.util.List<java.lang.String> java)

Sets the command used to start the forked server process. The arguments "-jar" and "/path/to/bootstrap.jar" are appended to the given command when starting the process. The default setting is {"java", "-Xmx32m"}.

Creates a defensive copy.

Parameters:

java - java command line

setJavaCommand

@Deprecated
public void setJavaCommand(java.lang.String java)

Deprecated. since 1.8

Sets the command used to start the forked server process. The given command line is split on whitespace and the arguments 2 * "-jar" and "/path/to/bootstrap.jar" are appended to it when starting 2 * the process. The default setting is "java -Xmx32m".

Parameters:

java - java command line

See Also:

setJavaCommand(List)

getSupportedTypes

public java.util.Set<MediaType> getSupportedTypes(ParseContext context)

Description copied from interface: Parser

Returns the set of media types supported by this parser when used with the given parse context.

Parameters:

context - parse context

Returns:

immutable set of media types

parse

public void parse(java.io.InputStream stream,
                  org.xml.sax.ContentHandler handler,
                  Metadata metadata,
                  ParseContext context)
           throws java.io.IOException,
                  org.xml.sax.SAXException,
                  TikaException

Description copied from interface: Parser

Parses a document stream into a sequence of XHTML SAX events. Fills in related document metadata in the given metadata object.

The given document stream is consumed but not closed by this method. The responsibility to close the stream remains on the caller.

Information about the parsing context can be passed in the context parameter. See the parser implementations for the kinds of context information they expect.

Parameters:

stream - the document stream (input)

handler - handler for the XHTML SAX events (output)

metadata - document metadata (input and output)

context - parse context

Throws:

java.io.IOException - if the document stream could not be read

org.xml.sax.SAXException - if the SAX events could not be processed

TikaException - if the document could not be parsed

close

public void close()

setServerPulseMillis

public void setServerPulseMillis(long serverPulseMillis)

The amount of time in milliseconds that the server should wait for any input or output. If it receives no input or output in this amount of time, it will shutdown. The default is 5 seconds.

Parameters:

serverPulseMillis - milliseconds to sleep before checking if there has been any activity