org.dstadler.commons.exec

Class ExecutionHelper

java.lang.Object

org.dstadler.commons.exec.ExecutionHelper

public class ExecutionHelper
extends java.lang.Object

Helper class which provides convenience support for execution of commandline processes via commons-exec. Use getCommandResult() for processes where the output is small as they will store the output in memory. Use getCommandResultIntoStream() in order to properly stream out potentially large amounts of output from the executable.

Constructor Summary

Constructors

Constructor and Description
ExecutionHelper()

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	getCommandResult(org.apache.commons.exec.CommandLine cmdLine, java.io.File dir, int expectedExit, long timeout) Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout.
static java.io.InputStream	getCommandResult(org.apache.commons.exec.CommandLine cmdLine, java.io.File dir, int expectedExit, long timeout, java.io.InputStream input) Run the given commandline in the given directory and provide the given input to the command.
static void	getCommandResultIntoStream(org.apache.commons.exec.CommandLine cmdLine, java.io.File dir, int expectedExit, long timeout, java.io.OutputStream stream) Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout.
static void	getCommandResultIntoStream(org.apache.commons.exec.CommandLine cmdLine, java.io.File dir, int expectedExit, long timeout, java.io.OutputStream stream, java.util.Map<java.lang.String,java.lang.String> environment) Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionHelper

public ExecutionHelper()

Method Detail

getCommandResult

public static java.io.InputStream getCommandResult(org.apache.commons.exec.CommandLine cmdLine,
                                                   java.io.File dir,
                                                   int expectedExit,
                                                   long timeout)
                                            throws java.io.IOException

Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout. Note: The resulting output is stored in memory, running a command which prints out a huge amount of data to stdout or stderr will cause memory problems.

Parameters:

cmdLine - The commandline object filled with the executable and command line arguments

dir - The working directory for the command

expectedExit - The expected exit value or -1 to not fail on any exit value

timeout - The timeout in milliseconds or ExecuteWatchdog.INFINITE_TIMEOUT

Returns:

An InputStream which provides the output of the command.

Throws:

java.io.IOException - Execution of sub-process failed or the sub-process returned a exit value indicating a failure

getCommandResult

public static java.io.InputStream getCommandResult(org.apache.commons.exec.CommandLine cmdLine,
                                                   java.io.File dir,
                                                   int expectedExit,
                                                   long timeout,
                                                   java.io.InputStream input)
                                            throws java.io.IOException

Run the given commandline in the given directory and provide the given input to the command. Also verify that the tool has the expected exit code and does finish in the timeout. Note: The resulting output is stored in memory, running a command which prints out a huge amount of data to stdout or stderr will cause memory problems.

Parameters:

cmdLine - The commandline object filled with the executable and command line arguments

dir - The working directory for the command

expectedExit - The expected exit value or -1 to not fail on any exit value

timeout - The timeout in milliseconds or ExecuteWatchdog.INFINITE_TIMEOUT

input - Input for the command-execution

Returns:

An InputStream which provides the output of the command.

Throws:

java.io.IOException - Execution of sub-process failed or the sub-process returned a exit value indicating a failure

getCommandResultIntoStream

public static void getCommandResultIntoStream(org.apache.commons.exec.CommandLine cmdLine,
                                              java.io.File dir,
                                              int expectedExit,
                                              long timeout,
                                              java.io.OutputStream stream)
                                       throws java.io.IOException

Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout.

Parameters:

cmdLine - The commandline object filled with the executable and command line arguments

dir - The working directory for the command

expectedExit - The expected exit value or -1 to not fail on any exit value

timeout - The timeout in milliseconds or ExecuteWatchdog.INFINITE_TIMEOUT

stream - An OutputStream which receives the output of the executed command

Throws:

java.io.IOException - Execution of sub-process failed or the sub-process returned a exit value indicating a failure

getCommandResultIntoStream

public static void getCommandResultIntoStream(org.apache.commons.exec.CommandLine cmdLine,
                                              java.io.File dir,
                                              int expectedExit,
                                              long timeout,
                                              java.io.OutputStream stream,
                                              java.util.Map<java.lang.String,java.lang.String> environment)
                                       throws java.io.IOException

Run the given commandline in the given directory and verify that the tool has the expected exit code and does finish in the timeout.

Parameters:

cmdLine - The commandline object filled with the executable and command line arguments

dir - The working directory for the command

expectedExit - The expected exit value or -1 to not fail on any exit value

timeout - The timeout in milliseconds or ExecuteWatchdog.INFINITE_TIMEOUT

stream - An OutputStream which receives the output of the executed command

environment - Environment variables that should be set for the execution of the command

Throws:

java.io.IOException - Execution of subprocess failed or the subprocess returned a exit value indicating a failure