org.conqat.lib.commons.io

Class ProcessUtils

java.lang.Object

org.conqat.lib.commons.io.ProcessUtils

public class ProcessUtils
extends java.lang.Object

Executes a system process. Takes care of reading stdout and stderr of the process in separate threads to avoid blocking.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProcessUtils.ExecutionResult Parameter object that encapsulates the result of a process execution.

Field Summary

Fields

Modifier and Type	Field and Description
static java.nio.charset.Charset	CONSOLE_CHARSET Character set used for process I/O.
static java.lang.String	MONO_COMMAND Command (path or name) to mono, to execute .NET programs on non-windows machines.

Constructor Summary

Constructors

Constructor and Description
ProcessUtils()

Method Summary

Modifier and Type	Method and Description
static java.lang.ProcessBuilder	createDotNetProcessBuilder(java.lang.String... arguments) Creates a ProcessBuilder for executing a .net assembly.
static ProcessUtils.ExecutionResult	execute(java.lang.ProcessBuilder builder) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	execute(java.lang.ProcessBuilder builder, java.lang.String input) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	execute(java.lang.ProcessBuilder builder, java.lang.String input, int timeOut) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	execute(java.lang.ProcessBuilder builder, java.lang.String input, int timeOut, boolean collectOutputStreamContent) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	execute(java.lang.String[] completeArguments) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	execute(java.lang.String[] completeArguments, java.lang.String input) Executes a process in a thread-safe way.
static ProcessUtils.ExecutionResult	executeDotNet(java.lang.String[] completeArguments) Executes a .net program in a thread-safe way.
static <T extends java.lang.Exception> ProcessUtils.ExecutionResult	executeOrThrow(java.lang.ProcessBuilder builder, java.lang.String input, int timeout, java.util.function.BiFunction<java.lang.String,java.lang.Throwable,T> exceptionConstructor) Runs the given process builder with the given input.

Methods inherited from class java.lang.Object

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

Field Detail

MONO_COMMAND

public static final java.lang.String MONO_COMMAND

Command (path or name) to mono, to execute .NET programs on non-windows machines.

See Also:

Constant Field Values

CONSOLE_CHARSET

public static java.nio.charset.Charset CONSOLE_CHARSET

Character set used for process I/O. Important on Windows.

Constructor Detail

ProcessUtils

public ProcessUtils()

Method Detail

createDotNetProcessBuilder

public static java.lang.ProcessBuilder createDotNetProcessBuilder(java.lang.String... arguments)

Creates a ProcessBuilder for executing a .net assembly. If the current OS is not Windows mono will be used for executing the assembly.

executeDotNet

public static ProcessUtils.ExecutionResult executeDotNet(java.lang.String[] completeArguments)
                                                  throws java.io.IOException

Executes a .net program in a thread-safe way.

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.String[] completeArguments)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

completeArguments - Array of command line arguments to start the process

Returns:

result of the execution

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.String[] completeArguments,
                                                   java.lang.String input)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

completeArguments - Array of command line arguments to start the process

input - String that gets written to stdin

Returns:

result of the execution

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.ProcessBuilder builder)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

builder - builder that gets executed

Returns:

result of the execution

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.ProcessBuilder builder,
                                                   java.lang.String input)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

builder - builder that gets executed

input - String that gets written to stdin

Returns:

result of the execution

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.ProcessBuilder builder,
                                                   java.lang.String input,
                                                   int timeOut)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

builder - builder that gets executed

input - String that gets written to stdin (may be null).

timeOut - the number to seconds to wait for the process. If this runs longer, the process is killed. Passing a value of 0 or less makes the method wait forever (until the process finishes normally). To find out whether the process was killed, query ProcessUtils.ExecutionResult.isNormalTermination().

Returns:

result of the execution

Throws:

java.io.IOException

execute

public static ProcessUtils.ExecutionResult execute(java.lang.ProcessBuilder builder,
                                                   java.lang.String input,
                                                   int timeOut,
                                                   boolean collectOutputStreamContent)
                                            throws java.io.IOException

Executes a process in a thread-safe way.

Parameters:

builder - builder that gets executed

input - String that gets written to stdin (may be null).

timeOut - the number to seconds to wait for the process. If this runs longer, the process is killed. Passing a value of 0 or less makes the method wait forever (until the process finishes normally). To find out whether the process was killed, query ProcessUtils.ExecutionResult.isNormalTermination().

collectOutputStreamContent - boolean that indicates if the content from the stderr and stdout shall be collected. False is useful if the content is not needed and / or if the content would cause an OutOfMemoryException.

Returns:

result of the execution

Throws:

java.io.IOException

executeOrThrow

public static <T extends java.lang.Exception> ProcessUtils.ExecutionResult executeOrThrow(java.lang.ProcessBuilder builder,
                                                                                          java.lang.String input,
                                                                                          int timeout,
                                                                                          java.util.function.BiFunction<java.lang.String,java.lang.Throwable,T> exceptionConstructor)
                                                                                   throws T extends java.lang.Exception

Runs the given process builder with the given input. If creating the process fails, the process times out or the process exits with a non-zero exit code, an exception is thrown

Parameters:

builder - The process builder to execute.

input - The input to the program.

timeout - How many seconds to wait before terminating the process. If this is less than 1, no timeout is applied.

exceptionConstructor - Constructs the exception that is thrown in case something goes wrong. The first argument is a descriptive message, the second is either null (in case of a timeout or non-zero exit code) or the exception that caused the failure. This parameter is compatible with most exception constructors, e.g. ConQATException::new.

Returns:

the execution result of the successfully run process.

Throws:

T - An exception constructed with the given constructor. Thrown if the process fails to run and return a zero exit code.

T extends java.lang.Exception