Package com.platformlib.process.configuration

Interface ProcessConfiguration

  • All Known Implementing Classes:
    DefaultProcessBuilder
    public interface ProcessConfiguration
    Process configuration.

    • Method Detail

      • getName

        java.util.Optional<java.lang.String> getName()
        Get process name.
        Returns:
        Returns process name if set, Optional.empty() otherwise

      • getStdOutConsumer

        java.util.Optional<java.util.function.Consumer<java.lang.String>> getStdOutConsumer()
        Get process standard out consumer.
        Returns:
        Returns process standard out consumer if set, null otherwise

      • getStdErrConsumer

        java.util.Optional<java.util.function.Consumer<java.lang.String>> getStdErrConsumer()
        Get process standard error consumer.
        Returns:
        Returns process standard error consumer if set, null otherwise

      • getCommandAndArguments

        java.util.Collection<java.lang.Object> getCommandAndArguments()
        Get command and arguments to execute.
        Returns:
        Returns command and arguments to execute.

      • getMaskAppliers

        java.util.Collection<java.util.function.Function<java.lang.String,​java.lang.String>> getMaskAppliers()
        Get mask appliers. Used for masking data in logs.
        Returns:
        Returns collections of mask appliers.

      • getWorkDirectory

        java.util.Optional<java.lang.String> getWorkDirectory()
        Get process work directory where the process should be started.
        Returns:
        Returns process working directory if set, Optional.empty() otherwise

      • getEnvVariables

        java.util.Map<java.lang.String,​java.lang.String> getEnvVariables()
        Get process environment variables.
        Returns:
        Returns process environment variables

      • getExecutor

        java.util.Optional<java.util.concurrent.Executor> getExecutor()
        Get process executor.
        Returns:
        Returns process executor, Optional.empty() otherwise

      • getExecutionTimeout

        java.util.Optional<java.time.Duration> getExecutionTimeout()
        Get process execution timeout.
        Returns:
        Returns process execution timeout

      • getStandardOutputRedirects

        java.util.Collection<java.io.OutputStream> getStandardOutputRedirects()
        Get output streams to redirect process standard output stream.
        Returns:
        Returns collections of stream to redirect process standard output

      • getStandardErrorRedirects

        java.util.Collection<java.io.OutputStream> getStandardErrorRedirects()
        Get output streams to redirect process standard error stream.
        Returns:
        Returns collections of stream to redirect process standard error

      • getExecution

        ExecutionMode getExecution()
        Get process execution mode.
        Returns:
        Returns execution mode

      • getStdIn

        java.util.Optional<java.io.InputStream> getStdIn()
        Get process standard input stream.
        Returns:
        Returns process standard input stream if set, Optional.empty() otherwise

      • getProcessDestroyerHandler

        java.util.Optional<ProcessDestroyerHandler> getProcessDestroyerHandler()
        Get process destroy handler.
        Returns:
        Process destroy handler if set, Optional.empty() otherwise

      • getDryRunConfiguration

        java.util.Optional<ProcessDryRunConfiguration> getDryRunConfiguration()
        Get dry run configuration.
        Returns:
        Returns dry run configuration if set, Optional.empty() otherwise

      • getProcessInstanceConfiguration

        java.util.Optional<ProcessInstanceConfiguration> getProcessInstanceConfiguration()
        Get process output configuration which will be available via ProcessInstance.
        Returns:
        Returns process instance configuration

      • getProcessLoggerConfiguration

        java.util.Optional<ProcessLoggerConfiguration> getProcessLoggerConfiguration()
        Get process logger configuration.
        Returns:
        Returns process logger configuration