com.norconex.commons.lang.exec

Class ExecUtil

java.lang.Object

com.norconex.commons.lang.exec.ExecUtil

public final class ExecUtil
extends Object

Utility methods related to process execution. Checked exceptions are wrapped in a runtime ExecException.

Since:

1.13.0 (previously part of JEF API 4.0).

Author:

Pascal Essiembre

Field Summary

Fields

Modifier and Type	Field and Description
static String	STDERR Identifier for standard error.
static String	STDOUT Identifier for standard output.

Method Summary

Modifier and Type	Method and Description
static int	watchProcess(Process process) Watches a running process.
static int	watchProcess(Process process, IInputStreamListener listener) Watches a running process.
static int	watchProcess(Process process, IInputStreamListener[] listeners) Watches a running process.
static int	watchProcess(Process process, IInputStreamListener[] outputListeners, IInputStreamListener[] errorListeners) Watches a running process.
static int	watchProcess(Process process, IInputStreamListener outputListener, IInputStreamListener errorListener) Watches a running process.
static int	watchProcess(Process process, InputStream input, IInputStreamListener[] outputListeners, IInputStreamListener[] errorListeners) Watches a running process while sending data to its STDIN.
static void	watchProcessAsync(Process process, IInputStreamListener[] outputListeners, IInputStreamListener[] errorListeners) Watches process output.
static void	watchProcessAsync(Process process, IInputStreamListener outputListener, IInputStreamListener errorListener) Watches process output.
static void	watchProcessAsync(Process process, InputStream input, IInputStreamListener[] outputListeners, IInputStreamListener[] errorListeners) Watches process output while sending data to its STDIN.

Methods inherited from class java.lang.Object

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

Field Detail

STDOUT

public static final String STDOUT

Identifier for standard output.

See Also:

Constant Field Values

STDERR

public static final String STDERR

Identifier for standard error.

See Also:

Constant Field Values

Method Detail

watchProcess

public static int watchProcess(Process process)

Watches a running process. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream.

Parameters:

process - the process to watch

Returns:

process exit value

watchProcess

public static int watchProcess(Process process,
                               IInputStreamListener listener)

Watches a running process. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream. The listener will be notified every time an error or output line gets written by the process. The listener line type will either be "STDERR" or "STDOUT".

Parameters:

process - the process to watch

listener - the listener to use for both "STDERR" or "STDOUT".

Returns:

process exit value

watchProcess

public static int watchProcess(Process process,
                               IInputStreamListener[] listeners)

Watches a running process. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream. The listener will be notified every time an error or output line gets written by the process. The listener line type will either be "STDERR" or "STDOUT".

Parameters:

process - the process to watch

listeners - the listeners to use for both "STDERR" or "STDOUT".

Returns:

process exit value

watchProcess

public static int watchProcess(Process process,
                               IInputStreamListener outputListener,
                               IInputStreamListener errorListener)
                        throws InterruptedException

Watches a running process. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream. The listener will be notified every time an error or output line gets written by the process. The listener line type will either be "STDERR" or "STDOUT".

Parameters:

process - the process to watch

outputListener - the process output listener

errorListener - the process error listener

Returns:

process exit value

Throws:

InterruptedException - problem while waiting for process to finish

watchProcess

public static int watchProcess(Process process,
                               IInputStreamListener[] outputListeners,
                               IInputStreamListener[] errorListeners)

Watches a running process. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream. The listeners will be notified every time an error or output line gets written by the process. The listener line type will either be "STDERR" or "STDOUT".

Parameters:

process - the process to watch

outputListeners - the process output listeners

errorListeners - the process error listeners

Returns:

process exit value

watchProcess

public static int watchProcess(Process process,
                               InputStream input,
                               IInputStreamListener[] outputListeners,
                               IInputStreamListener[] errorListeners)

Watches a running process while sending data to its STDIN. This method will wait until the process as finished executing before returning with its exit value. It ensures the process does not hang on some platform by making use of the InputStreamConsumer to read its error and output stream. The listeners will be notified every time an error or output line gets written by the process. The listener line type will either be "STDERR" or "STDOUT".

Parameters:

process - the process to watch

input - input sent to process STDIN

outputListeners - the process output listeners

errorListeners - the process error listeners

Returns:

process exit value

watchProcessAsync

public static void watchProcessAsync(Process process,
                                     IInputStreamListener outputListener,
                                     IInputStreamListener errorListener)

Watches process output. This method is the same as watchProcess( Process, IInputStreamListener, IInputStreamListener) with the exception of not waiting for the process to complete before returning.

Parameters:

process - the process on which to watch outputs

outputListener - the process output listeners

errorListener - the process error listeners

watchProcessAsync

public static void watchProcessAsync(Process process,
                                     IInputStreamListener[] outputListeners,
                                     IInputStreamListener[] errorListeners)

Watches process output. This method is the same as watchProcess( Process, IInputStreamListener[], IInputStreamListener[]) with the exception of not waiting for the process to complete before returning.

Parameters:

process - the process on which to watch outputs

outputListeners - the process output listeners

errorListeners - the process error listeners

watchProcessAsync

public static void watchProcessAsync(Process process,
                                     InputStream input,
                                     IInputStreamListener[] outputListeners,
                                     IInputStreamListener[] errorListeners)

Watches process output while sending data to its STDIN. This method is the same as watchProcess(Process, InputStream, IInputStreamListener[], IInputStreamListener[]) with the exception of not waiting for the process to complete before returning.

Parameters:

process - the process on which to watch outputs

input - input sent to process STDIN

outputListeners - the process output listeners

errorListeners - the process error listeners