Package org.apache.tika.utils

Class ProcessUtils

java.lang.Object

org.apache.tika.utils.ProcessUtils

public class ProcessUtils
extends Object

Constructor Summary

Constructors

Constructor	Description
ProcessUtils()

Method Summary

Modifier and Type	Method	Description
static boolean	checkCommand(String[] checkCmd, int... errorValue)	Checks to see if the command can be run.
static boolean	checkCommand(String checkCmd, int... errorValue)	Checks to see if the command can be run.
static String	escapeCommandLine(String arg)	This should correctly put double-quotes around an argument if ProcessBuilder doesn't seem to work (as it doesn't on paths with spaces on Windows)
static FileProcessResult	execute(ProcessBuilder pb, long timeoutMillis, int maxStdoutBuffer, int maxStdErrBuffer)	This writes stdout and stderr to the FileProcessResult.
static FileProcessResult	execute(ProcessBuilder pb, long timeoutMillis, Path stdoutRedirect, int maxStdErrBuffer)	This redirects stdout to stdoutRedirect path.
static String	unescapeCommandLine(String arg)

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessUtils

public ProcessUtils()

Method Details

escapeCommandLine

public static String escapeCommandLine(String arg)

This should correctly put double-quotes around an argument if ProcessBuilder doesn't seem to work (as it doesn't on paths with spaces on Windows)

Parameters:

arg -

Returns:

unescapeCommandLine

public static String unescapeCommandLine(String arg)

execute

public static FileProcessResult execute(ProcessBuilder pb,
 long timeoutMillis,
 int maxStdoutBuffer,
 int maxStdErrBuffer)
                                 throws IOException

This writes stdout and stderr to the FileProcessResult.

Parameters:

pb -

timeoutMillis -

maxStdoutBuffer -

maxStdErrBuffer -

Returns:

Throws:

IOException

execute

public static FileProcessResult execute(ProcessBuilder pb,
 long timeoutMillis,
 Path stdoutRedirect,
 int maxStdErrBuffer)
                                 throws IOException

This redirects stdout to stdoutRedirect path.

Parameters:

pb -

timeoutMillis -

stdoutRedirect -

maxStdErrBuffer -

Returns:

Throws:

IOException

checkCommand

public static boolean checkCommand(String checkCmd,
 int... errorValue)

Checks to see if the command can be run. Typically used with something like "myapp --version" to check to see if "myapp" is installed and on the path.

Parameters:

checkCmd - The check command to run

errorValue - What is considered an error value? Default is 127 (command not found).

Returns:

true if the command ran successfully (exit code not in errorValue list)

checkCommand

public static boolean checkCommand(String[] checkCmd,
 int... errorValue)

Checks to see if the command can be run. Typically used with something like new String[]{"myapp", "--version"} to check to see if "myapp" is installed and on the path.

Parameters:

checkCmd - The check command to run

errorValue - What is considered an error value? Default is 127 (command not found).

Returns:

true if the command ran successfully (exit code not in errorValue list)