org.apache.tika.batch

Class BatchProcessDriverCLI

java.lang.Object

org.apache.tika.batch.BatchProcessDriverCLI

public class BatchProcessDriverCLI
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	BatchProcessDriverCLI.InterruptWatcher Class to watch stdin from the driver for anything that is typed.
private class	BatchProcessDriverCLI.InterruptWriter Class that writes to the child process to force an interrupt in the child process.
private class	BatchProcessDriverCLI.StreamGobbler
private class	BatchProcessDriverCLI.StreamWatcher

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String[]	commandLine
private BatchProcessDriverCLI.StreamGobbler	errorWatcher
private java.lang.Thread	errorWatcherThread
private BatchProcessDriverCLI.InterruptWatcher	interruptWatcher
private java.lang.Thread	interruptWatcherThread
private BatchProcessDriverCLI.InterruptWriter	interruptWriter
private java.lang.Thread	interruptWriterThread
private static org.slf4j.Logger	LOG
private int	loopsAfterRestartMessageReceived
private int	maxProcessRestarts
private int	numRestarts
private BatchProcessDriverCLI.StreamGobbler	outGobbler
private java.lang.Thread	outGobblerThread
private java.lang.Process	process
static int	PROCESS_COMPLETED_SUCCESSFULLY
static int	PROCESS_NO_RESTART_EXIT_CODE
static int	PROCESS_RESTART_EXIT_CODE This relies on an special exit values of 254 (do not restart), 0 ended correctly, 253 ended with exception (do restart)
private long	pulseMillis
private boolean	receivedRestartMsg
private boolean	redirectChildProcessToStdOut
private boolean	userInterrupted
private int	waitNumLoopsAfterRestartMessage

Constructor Summary

Constructors

Constructor and Description
BatchProcessDriverCLI(java.lang.String[] commandLine)

Method Summary

Modifier and Type	Method and Description
void	execute()
int	getNumRestarts()
boolean	getUserInterrupted()
static void	main(java.lang.String[] args)
private boolean	restart(java.lang.Integer exitValue, boolean receivedRestartMsg) Tries to restart (stop and then start) the child process
void	setRedirectChildProcessToStdOut(boolean redirectChildProcessToStdOut) Typically only used for testing.
private void	shutdownDriverNow()
private void	start()
private void	stop()
private java.lang.String[]	tryToReadMaxRestarts(java.lang.String[] commandLine)

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_RESTART_EXIT_CODE

public static final int PROCESS_RESTART_EXIT_CODE

This relies on an special exit values of 254 (do not restart), 0 ended correctly, 253 ended with exception (do restart)

See Also:

Constant Field Values

PROCESS_NO_RESTART_EXIT_CODE

public static final int PROCESS_NO_RESTART_EXIT_CODE

See Also:

Constant Field Values

PROCESS_COMPLETED_SUCCESSFULLY

public static final int PROCESS_COMPLETED_SUCCESSFULLY

See Also:

Constant Field Values

LOG

private static final org.slf4j.Logger LOG

maxProcessRestarts

private int maxProcessRestarts

pulseMillis

private long pulseMillis

waitNumLoopsAfterRestartMessage

private int waitNumLoopsAfterRestartMessage

loopsAfterRestartMessageReceived

private int loopsAfterRestartMessageReceived

userInterrupted

private volatile boolean userInterrupted

receivedRestartMsg

private boolean receivedRestartMsg

process

private java.lang.Process process

errorWatcher

private BatchProcessDriverCLI.StreamGobbler errorWatcher

outGobbler

private BatchProcessDriverCLI.StreamGobbler outGobbler

interruptWriter

private BatchProcessDriverCLI.InterruptWriter interruptWriter

interruptWatcher

private final BatchProcessDriverCLI.InterruptWatcher interruptWatcher

errorWatcherThread

private java.lang.Thread errorWatcherThread

outGobblerThread

private java.lang.Thread outGobblerThread

interruptWriterThread

private java.lang.Thread interruptWriterThread

interruptWatcherThread

private final java.lang.Thread interruptWatcherThread

commandLine

private final java.lang.String[] commandLine

numRestarts

private int numRestarts

redirectChildProcessToStdOut

private boolean redirectChildProcessToStdOut

Constructor Detail

BatchProcessDriverCLI

public BatchProcessDriverCLI(java.lang.String[] commandLine)

Method Detail

tryToReadMaxRestarts

private java.lang.String[] tryToReadMaxRestarts(java.lang.String[] commandLine)

execute

public void execute()
             throws java.lang.Exception

Throws:

java.lang.Exception

shutdownDriverNow

private void shutdownDriverNow()

getNumRestarts

public int getNumRestarts()

getUserInterrupted

public boolean getUserInterrupted()

restart

private boolean restart(java.lang.Integer exitValue,
                        boolean receivedRestartMsg)
                 throws java.lang.Exception

Tries to restart (stop and then start) the child process

Returns:

whether or not this was successful, will be false if numRestarts >= maxProcessRestarts

Throws:

java.lang.Exception

stop

private void stop()

start

private void start()
            throws java.lang.Exception

Throws:

java.lang.Exception

setRedirectChildProcessToStdOut

public void setRedirectChildProcessToStdOut(boolean redirectChildProcessToStdOut)

Typically only used for testing. This determines whether or not to redirect child process's stdOut to driver's stdout

Parameters:

redirectChildProcessToStdOut - should the driver redirect the child's stdout

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception