ProcessInstanceBuilder (Sponge

java.lang.Object
- org.openksavi.sponge.util.process.ProcessInstanceBuilder

public class ProcessInstanceBuilder
extends Object

A process instance builder.

Constructor Summary

Constructors
Constructor and Description
`ProcessInstanceBuilder(SpongeEngine engine, ProcessConfiguration configuration)`
`ProcessInstanceBuilder(SpongeEngine engine, String executable)` Creates a new process instance builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ProcessInstanceBuilder`	`arguments(List<String> arguments)` Adds the process arguments, ignoring `null` elements.
`ProcessInstanceBuilder`	`arguments(String... arguments)` Adds the process arguments.
`ProcessInstance`	`build()` Builds the process instance but doesn't run it.
`ProcessInstanceBuilder`	`charset(Charset charset)` Sets the charset of the subprocess streams used if the redirect type is STRING.
`ProcessInstanceBuilder`	`env(Map<String,String> env)` Adds the environment variables.
`ProcessInstanceBuilder`	`env(String name, String value)` Adds the environment variable.
`ProcessInstanceBuilder`	`errorAsConsumer()` A convenience method to set the process error redirect type `CONSUMER`.
`ProcessInstanceBuilder`	`errorAsConsumer(Consumer<String> errorLineConsumer)` A convenience method to set the process error redirect type `CONSUMER`.
`ProcessInstanceBuilder`	`errorAsException()` A convenience method to set the process error redirect type `EXCEPTION`.
`ProcessInstanceBuilder`	`errorAsFile(String errorFile)` A convenience method to set the process error redirect type `FILE`.
`ProcessInstanceBuilder`	`errorAsInherit()` A convenience method to set the process error redirect type `INHERIT`.
`ProcessInstanceBuilder`	`errorAsString()` A convenience method to set the process error redirect type `STRING`.
`ProcessInstanceBuilder`	`errorLoggingConsumer(BiConsumer<org.slf4j.Logger,String> errorLoggingConsumer)` The logging consumer for the process error output.
`ProcessInstanceBuilder`	`errorRedirect(ErrorRedirect errorRedirect)` Sets the error output redirect type.
`ProcessInstanceBuilder`	`exceptionOnExitCode(boolean exceptionOnExitCode)` If `true`, throws exception if the process exit code is not `0`.
`ProcessConfiguration`	`getConfiguration()` Returns the process configuration.
`ProcessInstanceBuilder`	`inheritIo()` Sets inherit I/O.
`ProcessInstanceBuilder`	`inputAsBinary(byte[] inputBinary)` A convenience method to set the input redirect type `BINARY`.
`ProcessInstanceBuilder`	`inputAsFile(String inputFile)` A convenience method to set the input redirect type `FILE`.
`ProcessInstanceBuilder`	`inputAsInherit()` A convenience method to set the input redirect type `INHERIT`.
`ProcessInstanceBuilder`	`inputAsStream()` A convenience method to set the input redirect type `STREAM`.
`ProcessInstanceBuilder`	`inputAsString(String inputString)` A convenience method to set the input redirect type `STRING`.
`ProcessInstanceBuilder`	`inputRedirect(InputRedirect inputRedirect)` Sets the input redirect type.
`ProcessInstanceBuilder`	`name(String name)` Sets the process name.
`ProcessInstanceBuilder`	`outputAsBinary()` A convenience method to set the output redirect type `BINARY`.
`ProcessInstanceBuilder`	`outputAsConsumer()` A convenience method to set the output redirect type `CONSUMER`.
`ProcessInstanceBuilder`	`outputAsConsumer(Consumer<String> outputLineConsumer)` A convenience method to set the output redirect type `CONSUMER`.
`ProcessInstanceBuilder`	`outputAsFile(String outputFile)` A convenience method to set the output redirect type `FILE`.
`ProcessInstanceBuilder`	`outputAsInherit()` A convenience method to set the output redirect type `INHERIT`.
`ProcessInstanceBuilder`	`outputAsString()` A convenience method to set the output redirect type `STRING`.
`ProcessInstanceBuilder`	`outputLoggingConsumer(BiConsumer<org.slf4j.Logger,String> outputLoggingConsumer)` The logging consumer for the process standard output.
`ProcessInstanceBuilder`	`outputLoggingConsumerNone()` Sets the logging consumer for the process standard output to none.
`ProcessInstanceBuilder`	`outputRedirect(OutputRedirect outputRedirect)` Sets the standard output redirect type.
`ProcessInstanceBuilder`	`processBuilderConsumer(Consumer<ProcessBuilder> processBuilderConsumer)` Provides low level access to the Java ProcessBuilder consumer.
`ProcessInstanceBuilder`	`redirectErrorStream(boolean redirectErrorStream)` Merges the error output with the standard output if `true`.
`ProcessInstance`	`run()` Runs a new process synchronously.
`ProcessInstance`	`runAsync()` Runs a new process asynchronously.
`ProcessInstanceBuilder`	`waitForLineTimeout(Long waitForLineTimeout)` Sets the timeout for waiting for a specific line from the process output stream (in seconds).
`ProcessInstanceBuilder`	`waitForNegativeLineRegexp(String waitForNegativeLineRegexp)` Sets the Java regular expression of a line from the process output stream that signals an error and should cause throwing an exception.
`ProcessInstanceBuilder`	`waitForPositiveLineRegexp(String waitForPositiveLineRegexp)` Sets the Java regular expression of a line from the process output stream.
`ProcessInstanceBuilder`	`waitSeconds(Long waitSeconds)` Sets the maximum number of seconds to wait after the start of the process.
`ProcessInstanceBuilder`	`workingDir(String workingDir)` Sets the process working directory.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProcessInstanceBuilder
```
public ProcessInstanceBuilder(SpongeEngine engine,
                              String executable)
```
    Creates a new process instance builder.
    
    Parameters:
    
    engine - the engine.
    
    executable - the executable.
  - ProcessInstanceBuilder
```
public ProcessInstanceBuilder(SpongeEngine engine,
                              ProcessConfiguration configuration)
```
- Method Detail
  - getConfiguration
```
public ProcessConfiguration getConfiguration()
```
    Returns the process configuration.
    
    Returns:
    
    the process configuration.
  - build
```
public ProcessInstance build()
```
    Builds the process instance but doesn't run it.
    
    Returns:
    
    the process instance.
  - run
```
public ProcessInstance run()
                    throws InterruptedException
```
    Runs a new process synchronously. Should be invoked only once.
    If the input redirect type is STREAM you should invoke ProcessInstance.runAsync().
    
    Returns:
    
    the process instance.
    
    Throws:
    
    InterruptedException - on interrupted.
  - runAsync
```
public ProcessInstance runAsync()
                         throws InterruptedException
```
    Runs a new process asynchronously. Should be invoked only once. Waits if necessary (in compliance with the configuration).
    If the input redirect type is STREAM you should invoke manually ProcessInstance.waitForReady() after writing to and closing the subprocess standard input ProcessInstance.getInput().
    
    Returns:
    
    the process instance.
    
    Throws:
    
    InterruptedException - on interrupted.
  - name
```
public ProcessInstanceBuilder name(String name)
```
    Sets the process name.
    
    Parameters:
    
    name - the process name.
    
    Returns:
    
    this builder.
  - arguments
```
public ProcessInstanceBuilder arguments(String... arguments)
```
    Adds the process arguments.
    
    Parameters:
    
    arguments - the process arguments.
    
    Returns:
    
    this builder.
  - arguments
```
public ProcessInstanceBuilder arguments(List<String> arguments)
```
    Adds the process arguments, ignoring null elements.
    
    Parameters:
    
    arguments - the process arguments.
    
    Returns:
    
    this builder.
  - workingDir
```
public ProcessInstanceBuilder workingDir(String workingDir)
```
    Sets the process working directory.
    
    Parameters:
    
    workingDir - the process working directory. If null (the default value) then the current directory will be used.
    
    Returns:
    
    this builder.
  - env
```
public ProcessInstanceBuilder env(String name,
                                  String value)
```
    Adds the environment variable.
    
    Parameters:
    
    name - the environment variable name.
    
    value - the environment variable value.
    
    Returns:
    
    this builder.
  - env
```
public ProcessInstanceBuilder env(Map<String,String> env)
```
    Adds the environment variables.
    
    Parameters:
    
    env - the environment variables.
    
    Returns:
    
    this builder.
  - waitSeconds
```
public ProcessInstanceBuilder waitSeconds(Long waitSeconds)
```
    Sets the maximum number of seconds to wait after the start of the process. The thread that started the process will be blocked until the time elapses or the subprocess exits.
    
    Parameters:
    
    waitSeconds - the maximum number of seconds to wait or null (the default value) if the thread shouldn't wait.
    
    Returns:
    
    this builder.
  - inputRedirect
```
public ProcessInstanceBuilder inputRedirect(InputRedirect inputRedirect)
```
    Sets the input redirect type. The default value is InputRedirect.PIPE.
    
    Parameters:
    
    inputRedirect - the input redirect type.
    
    Returns:
    
    this builder.
  - outputRedirect
```
public ProcessInstanceBuilder outputRedirect(OutputRedirect outputRedirect)
```
    Sets the standard output redirect type. The default value is OutputRedirect.PIPE.
    
    Parameters:
    
    outputRedirect - the standard output redirect type.
    
    Returns:
    
    this builder.
  - errorRedirect
```
public ProcessInstanceBuilder errorRedirect(ErrorRedirect errorRedirect)
```
    Sets the error output redirect type. The default value is ErrorRedirect.PIPE.
    
    Parameters:
    
    errorRedirect - the error output redirect type.
    
    Returns:
    
    this builder.
  - charset
```
public ProcessInstanceBuilder charset(Charset charset)
```
    Sets the charset of the subprocess streams used if the redirect type is STRING.
    
    Parameters:
    
    charset - the charset.
    
    Returns:
    
    this builder.
  - waitForPositiveLineRegexp
```
public ProcessInstanceBuilder waitForPositiveLineRegexp(String waitForPositiveLineRegexp)
```
    Sets the Java regular expression of a line from the process output stream. The thread that started the process will wait (blocking) for such line (or waitForNegativeLineRegexp if set).
    
    Parameters:
    
    waitForPositiveLineRegexp - the Java regular expression or null if the thread shouldn't wait for a specific line.
    
    Returns:
    
    this builder.
  - waitForNegativeLineRegexp
```
public ProcessInstanceBuilder waitForNegativeLineRegexp(String waitForNegativeLineRegexp)
```
    Sets the Java regular expression of a line from the process output stream that signals an error and should cause throwing an exception.
    
    Parameters:
    
    waitForNegativeLineRegexp - the Java regular expression or null if the thread shouldn't look for a specific error line.
    
    Returns:
    
    this builder.
  - waitForLineTimeout
```
public ProcessInstanceBuilder waitForLineTimeout(Long waitForLineTimeout)
```
    Sets the timeout for waiting for a specific line from the process output stream (in seconds). If the timeout is exceeded, the exception will be thrown.
    
    Parameters:
    
    waitForLineTimeout - the timeout for waiting for a specific line or null if the thread could wait indefinitely.
    
    Returns:
    
    this builder.
  - outputLoggingConsumer
```
public ProcessInstanceBuilder outputLoggingConsumer(BiConsumer<org.slf4j.Logger,String> outputLoggingConsumer)
```
    The logging consumer for the process standard output. Applicable only if the output redirect type is CONSUMER. The default logging level is INFO.
    
    Parameters:
    
    outputLoggingConsumer - the logging consumer.
    
    Returns:
    
    this builder.
  - outputLoggingConsumerNone
```
public ProcessInstanceBuilder outputLoggingConsumerNone()
```
    Sets the logging consumer for the process standard output to none. Applicable only if the output redirect type is CONSUMER.
    
    Returns:
    
    this builder.
  - errorLoggingConsumer
```
public ProcessInstanceBuilder errorLoggingConsumer(BiConsumer<org.slf4j.Logger,String> errorLoggingConsumer)
```
    The logging consumer for the process error output. Applicable only if the error redirect type is CONSUMER. The default logging level is WARN.
    
    Parameters:
    
    errorLoggingConsumer - the logging consumer.
    
    Returns:
    
    this builder.
  - inheritIo
```
public ProcessInstanceBuilder inheritIo()
```
    Sets inherit I/O.
    
    Returns:
    
    this builder.
  - processBuilderConsumer
```
public ProcessInstanceBuilder processBuilderConsumer(Consumer<ProcessBuilder> processBuilderConsumer)
```
    Provides low level access to the Java ProcessBuilder consumer.
    
    Parameters:
    
    processBuilderConsumer - the Java ProcessBuilder consumer.
    
    Returns:
    
    this builder.
  - redirectErrorStream
```
public ProcessInstanceBuilder redirectErrorStream(boolean redirectErrorStream)
```
    Merges the error output with the standard output if true. Defaults to false.
    
    Parameters:
    
    redirectErrorStream - redirect error stream flag.
    
    Returns:
    
    this builder.
  - exceptionOnExitCode
```
public ProcessInstanceBuilder exceptionOnExitCode(boolean exceptionOnExitCode)
```
    If true, throws exception if the process exit code is not 0. Defaults to true.
    
    Parameters:
    
    exceptionOnExitCode - exception on exit code flag.
    
    Returns:
    
    this builder.
  - inputAsInherit
```
public ProcessInstanceBuilder inputAsInherit()
```
    A convenience method to set the input redirect type INHERIT.
    
    Returns:
    
    this builder.
  - inputAsString
```
public ProcessInstanceBuilder inputAsString(String inputString)
```
    A convenience method to set the input redirect type STRING.
    
    Parameters:
    
    inputString - the input string.
    
    Returns:
    
    this builder.
  - inputAsBinary
```
public ProcessInstanceBuilder inputAsBinary(byte[] inputBinary)
```
    A convenience method to set the input redirect type BINARY.
    
    Parameters:
    
    inputBinary - the input binary.
    
    Returns:
    
    this builder.
  - inputAsFile
```
public ProcessInstanceBuilder inputAsFile(String inputFile)
```
    A convenience method to set the input redirect type FILE.
    
    Parameters:
    
    inputFile - the input filename.
    
    Returns:
    
    this builder.
  - inputAsStream
```
public ProcessInstanceBuilder inputAsStream()
```
    A convenience method to set the input redirect type STREAM.
    
    Returns:
    
    this builder.
  - outputAsInherit
```
public ProcessInstanceBuilder outputAsInherit()
```
    A convenience method to set the output redirect type INHERIT.
    
    Returns:
    
    this builder.
  - outputAsString
```
public ProcessInstanceBuilder outputAsString()
```
    A convenience method to set the output redirect type STRING.
    
    Returns:
    
    this builder.
  - outputAsBinary
```
public ProcessInstanceBuilder outputAsBinary()
```
    A convenience method to set the output redirect type BINARY.
    
    Returns:
    
    this builder.
  - outputAsFile
```
public ProcessInstanceBuilder outputAsFile(String outputFile)
```
    A convenience method to set the output redirect type FILE.
    
    Parameters:
    
    outputFile - the output filename.
    
    Returns:
    
    this builder.
  - outputAsConsumer
```
public ProcessInstanceBuilder outputAsConsumer(Consumer<String> outputLineConsumer)
```
    A convenience method to set the output redirect type CONSUMER.
    
    Parameters:
    
    outputLineConsumer - the line consumer.
    
    Returns:
    
    this builder.
  - outputAsConsumer
```
public ProcessInstanceBuilder outputAsConsumer()
```
    A convenience method to set the output redirect type CONSUMER.
    
    Returns:
    
    this builder.
  - errorAsInherit
```
public ProcessInstanceBuilder errorAsInherit()
```
    A convenience method to set the process error redirect type INHERIT.
    
    Returns:
    
    this builder.
  - errorAsString
```
public ProcessInstanceBuilder errorAsString()
```
    A convenience method to set the process error redirect type STRING.
    
    Returns:
    
    this builder.
  - errorAsFile
```
public ProcessInstanceBuilder errorAsFile(String errorFile)
```
    A convenience method to set the process error redirect type FILE.
    
    Parameters:
    
    errorFile - the error file.
    
    Returns:
    
    this builder.
  - errorAsException
```
public ProcessInstanceBuilder errorAsException()
```
    A convenience method to set the process error redirect type EXCEPTION.
    
    Returns:
    
    this builder.
  - errorAsConsumer
```
public ProcessInstanceBuilder errorAsConsumer()
```
    A convenience method to set the process error redirect type CONSUMER.
    
    Returns:
    
    this builder.
  - errorAsConsumer
```
public ProcessInstanceBuilder errorAsConsumer(Consumer<String> errorLineConsumer)
```
    A convenience method to set the process error redirect type CONSUMER.
    
    Parameters:
    
    errorLineConsumer - the line consumer.
    
    Returns:
    
    this builder.

Class ProcessInstanceBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProcessInstanceBuilder

ProcessInstanceBuilder

Method Detail

getConfiguration

build

run

runAsync

name

arguments

arguments

workingDir

env

env

waitSeconds

inputRedirect

outputRedirect

errorRedirect

charset

waitForPositiveLineRegexp

waitForNegativeLineRegexp

waitForLineTimeout

outputLoggingConsumer

outputLoggingConsumerNone

errorLoggingConsumer

inheritIo

processBuilderConsumer

redirectErrorStream

exceptionOnExitCode

inputAsInherit

inputAsString

inputAsBinary

inputAsFile

inputAsStream

outputAsInherit

outputAsString

outputAsBinary

outputAsFile

outputAsConsumer

outputAsConsumer

errorAsInherit

errorAsString

errorAsFile

errorAsException

errorAsConsumer

errorAsConsumer