exec/com.smushytaco.exec/ManagedProcessBuilder

ManagedProcessBuilder

Builder for ManagedProcess.

This is inspired by java.lang.ProcessBuilder&CommandLine, and/but:

It offers to add java.nio.Path arguments, and makes sure that their absolute path is used.

If no directory is set, it automatically sets the initial working directory using the directory of executable if it was a Path, and thus makes sure an initial working directory is always passed to the process.

It intentionally doesn't offer "parsing" space delimited command "lines", but forces you to set an executable and add arguments.

Author

Michael Vorburger

Neelesh Shastry

William Dutton

Constructors

ManagedProcessBuilder

public void ManagedProcessBuilder(String executable)

Creates a builder for the given executable path (string form).

public void ManagedProcessBuilder(Path executable)

Creates a builder for the given executable path.

Functions

addArgument

public ManagedProcessBuilder addArgument(String arg)

Adds an argument to the command.

public ManagedProcessBuilder addArgument(Path arg)

Adds a Path as an argument to the command.

public ManagedProcessBuilder addArgument(String arg, boolean handleQuoting)

Adds a raw argument to the command.

public ManagedProcessBuilder addArgument(String argPart1, String argPart2)

Adds a single argument to the command, composed of two parts.

addFileArgument

public ManagedProcessBuilder addFileArgument(String arg, Path path)

Adds a single argument to the command, composed of a prefix and a file path separated by "=".

addStdErr

public ManagedProcessBuilder addStdErr(OutputStream stdError)

Adds an extra stream to receive STDERR from the process.

addStdOut

public ManagedProcessBuilder addStdOut(OutputStream stdOutput)

Adds an extra stream to receive STDOUT from the process.

build

public ManagedProcess build()

Builds a ManagedProcess from the current configuration.

getArguments

public List<String> getArguments()

Returns the current list of arguments (after quoting/escaping).

getConsoleBufferMaxLines

public int getConsoleBufferMaxLines()

Returns the number of console lines retained for diagnostics.

getEnvironment

public Map<String, String> getEnvironment()

Returns the environment variables that will be passed to the launched process.

getExecutable

public String getExecutable()

Returns the executable path string that will be launched.

getOutputStreamLogDispatcher

public OutputStreamLogDispatcher getOutputStreamLogDispatcher()

Returns the dispatcher that determines the SLF4J log level (or suppression) for each STDOUT/STDERR line.

getProcessListener

@Nullable()

public @Nullable() ManagedProcessListener getProcessListener()

Returns the currently configured process listener.

getWorkingDirectory

@Nullable()

public @Nullable() Path getWorkingDirectory()

Returns the working directory that will be used for the launched process.

isDestroyOnShutdown

public boolean isDestroyOnShutdown()

Returns whether the process will be destroyed automatically on JVM shutdown.

setConsoleBufferMaxLines

public ManagedProcessBuilder setConsoleBufferMaxLines(int consoleBufferMaxLines)

Sets the number of console lines to retain for diagnostics.

setDestroyOnShutdown

public ManagedProcessBuilder setDestroyOnShutdown(boolean flag)

Enables or disables destroying the process when the JVM shuts down.

setInputStream

public ManagedProcessBuilder setInputStream(@Nullable() @Nullable() InputStream inputStream)

Provides an input stream which will be fed to the process' STDIN.

setIsSuccessExitValueChecker

public ManagedProcessBuilder setIsSuccessExitValueChecker(IntPredicate function)

Sets the predicate that determines whether an exit value is considered success.

setOutputStreamLogDispatcher

public ManagedProcessBuilder setOutputStreamLogDispatcher(OutputStreamLogDispatcher outputStreamLogDispatcher)

Sets the dispatcher that determines the SLF4J log level (or suppression) for each line emitted on STDOUT/STDERR by the managed process.

setProcessListener

public ManagedProcessBuilder setProcessListener(@Nullable() @Nullable() ManagedProcessListener listener)

Sets the process listener to be notified of lifecycle events.

setWorkingDirectory

public ManagedProcessBuilder setWorkingDirectory(@Nullable() @Nullable() Path directory)

Sets working directory.

toString

public String toString()

Intended for debugging / logging, only.