Package com.platformlib.process.builder.impl

Class DefaultProcessBuilder

java.lang.Object

com.platformlib.process.builder.impl.DefaultProcessBuilder

All Implemented Interfaces:

ProcessBuilder, ProcessConfiguration

public abstract class DefaultProcessBuilder
extends java.lang.Object
implements ProcessBuilder, ProcessConfiguration

Default process builder. Implements most of methods required for process building.

Field Summary

Fields inherited from interface com.platformlib.process.builder.ProcessBuilder

BASH_EXTENSION, BAT_EXTENSION, CMD_EXTENSION, EXE_EXTENSION, SH_EXTENSION

Constructor Summary

Constructors

Constructor	Description
DefaultProcessBuilder()

Method Summary

Modifier and Type	Method	Description
DefaultProcessBuilder	addMaskApplier(java.util.function.Function<java.lang.String,java.lang.String> maskApplier)	Add mask applier for masking sensitive data before putting it in logs and passing to output consumers.
DefaultProcessBuilder	command(java.lang.String command)	Set command to execute.
DefaultProcessBuilder	commandAndArguments(java.lang.Object... commandAndArguments)	Set command and arguments
DefaultProcessBuilder	defaultExtensionMapping()	Add default mapping command extensions.
DefaultProcessBuilder	dryRun(java.util.function.Consumer<ProcessDryRunConfigurator> processDryRunConfigurator)	Configure dry run mode.
DefaultProcessBuilder	envVariables(java.util.Map<java.lang.String,java.lang.String> envVariables)	Add env variables.
DefaultProcessBuilder	executionTimeout(java.time.Duration timeout)	Set execution timeout.
protected java.util.Optional<java.lang.String>	getCommand()
java.util.Collection<java.lang.Object>	getCommandAndArguments()	Get command and arguments to execute.
java.util.Optional<ProcessDryRunConfiguration>	getDryRunConfiguration()	Get dry run configuration.
java.util.Map<java.lang.String,java.lang.String>	getEnvVariables()	Get process environment variables.
ExecutionMode	getExecution()	Get process execution mode.
java.util.Optional<java.time.Duration>	getExecutionTimeout()	Get process execution timeout.
java.util.Optional<java.util.concurrent.Executor>	getExecutor()	Get process executor.
java.util.Collection<java.util.function.Function<java.lang.String,java.lang.String>>	getMaskAppliers()	Get mask appliers.
java.util.Optional<java.lang.String>	getName()	Get process name.
java.util.Optional<ProcessDestroyerHandler>	getProcessDestroyerHandler()	Get process destroy handler.
java.util.Optional<ProcessInstanceConfiguration>	getProcessInstanceConfiguration()	Get process output configuration which will be available via ProcessInstance.
java.util.Optional<ProcessLoggerConfiguration>	getProcessLoggerConfiguration()	Get process logger configuration.
java.util.Collection<java.io.OutputStream>	getStandardErrorRedirects()	Get output streams to redirect process standard error stream.
java.util.Collection<java.io.OutputStream>	getStandardOutputRedirects()	Get output streams to redirect process standard output stream.
java.util.Optional<java.util.function.Consumer<java.lang.String>>	getStdErrConsumer()	Get process standard error consumer.
java.util.Optional<java.io.InputStream>	getStdIn()	Get process standard input stream.
java.util.Optional<java.util.function.Consumer<java.lang.String>>	getStdOutConsumer()	Get process standard out consumer.
java.util.Optional<java.lang.String>	getWorkDirectory()	Get process work directory where the process should be started.
DefaultProcessBuilder	logger(java.util.function.Consumer<ProcessLoggerConfigurator> processLoggerConfigurator)	Configure process logger configuration.
DefaultProcessBuilder	mapBashExtension()	Add ProcessBuilder.BASH_EXTENSION extension mapping if process is executed on NIX platform.
DefaultProcessBuilder	mapBatExtension()	Add ProcessBuilder.BAT_EXTENSION extension mapping if process is executed on WINDOWS platform.
DefaultProcessBuilder	mapCmdExtension()	Add ProcessBuilder.CMD_EXTENSION extension mapping if process is executed on WINDOWS platform.
DefaultProcessBuilder	mapExeExtension()	Add ProcessBuilder.EXE_EXTENSION extension mapping if process is executed on WINDOWS platform..
DefaultProcessBuilder	mapShExtension()	Add ProcessBuilder.SH_EXTENSION extension mapping if process is executed on NIX platform.
DefaultProcessBuilder	name(java.lang.String name)	Set process executor formal name.
DefaultProcessBuilder	processDestroyerHandler(ProcessDestroyerHandler processDestroyerHandler)	Specify destroy/kill process handler.
DefaultProcessBuilder	processInstance(java.util.function.Consumer<ProcessInstanceConfigurator> processInstanceConfigurator)	Configure process instance.
DefaultProcessBuilder	rawExecution()	Run command as is.
DefaultProcessBuilder	redirectStandardError(java.io.OutputStream outputStream)	Redirect process standard error to given stream.
DefaultProcessBuilder	redirectStandardOutput(java.io.OutputStream outputStream)	Redirect process standard output to given stream.
DefaultProcessBuilder	standardInput(java.io.InputStream processStandardInputStream)	Set process standard input stream.
DefaultProcessBuilder	stdErrConsumer(java.util.function.Consumer<java.lang.String> stdErrConsumer)	Set process error output consumer.
DefaultProcessBuilder	stdOutConsumer(java.util.function.Consumer<java.lang.String> stdOutConsumer)	Set process standard output consumer.
DefaultProcessBuilder	withExecutor(java.util.concurrent.Executor executor)	Set java process executor.
DefaultProcessBuilder	workDirectory(java.lang.String workDirectory)	Set work directory for process executing.
DefaultProcessBuilder	workDirectory(java.nio.file.Path workDirectory)	Set work directory for process executing.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.platformlib.process.builder.ProcessBuilder

build

Constructor Detail

DefaultProcessBuilder

public DefaultProcessBuilder()

Method Detail

name

public DefaultProcessBuilder name(java.lang.String name)

Description copied from interface: ProcessBuilder

Set process executor formal name. Default value is current thread name. The name will be added as suffix to any started threads.

Specified by:

name in interface ProcessBuilder

Parameters:

name - executor name

Returns:

Returns this process configurator

workDirectory

public DefaultProcessBuilder workDirectory(java.lang.String workDirectory)

Description copied from interface: ProcessBuilder

Set work directory for process executing.

Specified by:

workDirectory in interface ProcessBuilder

Parameters:

workDirectory - work directory where the process should be started

Returns:

Returns this process builder

workDirectory

public DefaultProcessBuilder workDirectory(java.nio.file.Path workDirectory)

Description copied from interface: ProcessBuilder

Set work directory for process executing.

Specified by:

workDirectory in interface ProcessBuilder

Parameters:

workDirectory - work directory where the process should be started

Returns:

Returns this process builder

envVariables

public DefaultProcessBuilder envVariables(java.util.Map<java.lang.String,java.lang.String> envVariables)

Description copied from interface: ProcessBuilder

Add env variables.

Specified by:

envVariables in interface ProcessBuilder

Parameters:

envVariables - env variables

Returns:

Returns this process builder

defaultExtensionMapping

public DefaultProcessBuilder defaultExtensionMapping()

Description copied from interface: ProcessBuilder

Add default mapping command extensions. The full path command extension will be automatically detected in next order: For Windows platform: cmd -> bat -> exe For Unix platform: no extension -> sh -> bash

Specified by:

defaultExtensionMapping in interface ProcessBuilder

Returns:

process builder

mapBashExtension

public DefaultProcessBuilder mapBashExtension()

Description copied from interface: ProcessBuilder

Add ProcessBuilder.BASH_EXTENSION extension mapping if process is executed on NIX platform.

Specified by:

mapBashExtension in interface ProcessBuilder

Returns:

Returns this process configurator

mapShExtension

public DefaultProcessBuilder mapShExtension()

Description copied from interface: ProcessBuilder

Add ProcessBuilder.SH_EXTENSION extension mapping if process is executed on NIX platform.

Specified by:

mapShExtension in interface ProcessBuilder

Returns:

Returns this process configurator

mapBatExtension

public DefaultProcessBuilder mapBatExtension()

Description copied from interface: ProcessBuilder

Add ProcessBuilder.BAT_EXTENSION extension mapping if process is executed on WINDOWS platform.

Specified by:

mapBatExtension in interface ProcessBuilder

Returns:

Returns this process configurator

mapCmdExtension

public DefaultProcessBuilder mapCmdExtension()

Description copied from interface: ProcessBuilder

Add ProcessBuilder.CMD_EXTENSION extension mapping if process is executed on WINDOWS platform.

Specified by:

mapCmdExtension in interface ProcessBuilder

Returns:

Returns this process configurator

mapExeExtension

public DefaultProcessBuilder mapExeExtension()

Description copied from interface: ProcessBuilder

Add ProcessBuilder.EXE_EXTENSION extension mapping if process is executed on WINDOWS platform..

Specified by:

mapExeExtension in interface ProcessBuilder

Returns:

Returns this process configurator

stdOutConsumer

public DefaultProcessBuilder stdOutConsumer(java.util.function.Consumer<java.lang.String> stdOutConsumer)

Description copied from interface: ProcessBuilder

Set process standard output consumer.

Specified by:

stdOutConsumer in interface ProcessBuilder

Parameters:

stdOutConsumer - process stdout consumer

Returns:

Returns this process configurator

stdErrConsumer

public DefaultProcessBuilder stdErrConsumer(java.util.function.Consumer<java.lang.String> stdErrConsumer)

Description copied from interface: ProcessBuilder

Set process error output consumer.

Specified by:

stdErrConsumer in interface ProcessBuilder

Parameters:

stdErrConsumer - process error consumer

Returns:

Returns this process configurator

standardInput

public DefaultProcessBuilder standardInput(java.io.InputStream processStandardInputStream)

Description copied from interface: ProcessBuilder

Set process standard input stream.

Specified by:

standardInput in interface ProcessBuilder

Parameters:

processStandardInputStream - stream to process standard input

Returns:

Returns this process builder

command

public DefaultProcessBuilder command(java.lang.String command)

Description copied from interface: ProcessBuilder

Set command to execute.

Specified by:

command in interface ProcessBuilder

Parameters:

command - command to execute

Returns:

Returns this process builder

commandAndArguments

public DefaultProcessBuilder commandAndArguments(java.lang.Object... commandAndArguments)

Description copied from interface: ProcessBuilder

Set command and arguments

Specified by:

commandAndArguments in interface ProcessBuilder

Parameters:

commandAndArguments - command and arguments to execute

Returns:

Returns this process builder

withExecutor

public DefaultProcessBuilder withExecutor(java.util.concurrent.Executor executor)

Description copied from interface: ProcessBuilder

Set java process executor.

Specified by:

withExecutor in interface ProcessBuilder

Parameters:

executor - executor

Returns:

Returns this process builder

executionTimeout

public DefaultProcessBuilder executionTimeout(java.time.Duration timeout)

Description copied from interface: ProcessBuilder

Set execution timeout. By default unlimited.

Specified by:

executionTimeout in interface ProcessBuilder

Parameters:

timeout - command execution timeout

Returns:

Returns this process builder

addMaskApplier

public DefaultProcessBuilder addMaskApplier(java.util.function.Function<java.lang.String,java.lang.String> maskApplier)

Description copied from interface: ProcessBuilder

Add mask applier for masking sensitive data before putting it in logs and passing to output consumers.

Specified by:

addMaskApplier in interface ProcessBuilder

Parameters:

maskApplier - mask applier

Returns:

Returns this process builder

redirectStandardOutput

public DefaultProcessBuilder redirectStandardOutput(java.io.OutputStream outputStream)

Description copied from interface: ProcessBuilder

Redirect process standard output to given stream.

Specified by:

redirectStandardOutput in interface ProcessBuilder

Parameters:

outputStream - output stream to redirect

Returns:

Returns this process builder

redirectStandardError

public DefaultProcessBuilder redirectStandardError(java.io.OutputStream outputStream)

Description copied from interface: ProcessBuilder

Redirect process standard error to given stream.

Specified by:

redirectStandardError in interface ProcessBuilder

Parameters:

outputStream - output stream to redirect

Returns:

Returns this process builder

rawExecution

public DefaultProcessBuilder rawExecution()

Description copied from interface: ProcessBuilder

Run command as is. Some features such as setting environment variables could be disabled. Depends on platform and implementation.

Specified by:

rawExecution in interface ProcessBuilder

Returns:

Returns this process builder

processDestroyerHandler

public DefaultProcessBuilder processDestroyerHandler(ProcessDestroyerHandler processDestroyerHandler)

Description copied from interface: ProcessBuilder

Specify destroy/kill process handler.

Specified by:

processDestroyerHandler in interface ProcessBuilder

Parameters:

processDestroyerHandler - process destroy/kill handler.

Returns:

Returns this process builder

dryRun

public DefaultProcessBuilder dryRun(java.util.function.Consumer<ProcessDryRunConfigurator> processDryRunConfigurator)

Description copied from interface: ProcessBuilder

Configure dry run mode.

Specified by:

dryRun in interface ProcessBuilder

Parameters:

processDryRunConfigurator - dry run configurator

Returns:

Returns this process builder

getMaskAppliers

public java.util.Collection<java.util.function.Function<java.lang.String,java.lang.String>> getMaskAppliers()

Description copied from interface: ProcessConfiguration

Get mask appliers. Used for masking data in logs.

Specified by:

getMaskAppliers in interface ProcessConfiguration

Returns:

Returns collections of mask appliers.

getName

public java.util.Optional<java.lang.String> getName()

Description copied from interface: ProcessConfiguration

Get process name.

Specified by:

getName in interface ProcessConfiguration

Returns:

Returns process name if set, Optional.empty() otherwise

getWorkDirectory

public java.util.Optional<java.lang.String> getWorkDirectory()

Description copied from interface: ProcessConfiguration

Get process work directory where the process should be started.

Specified by:

getWorkDirectory in interface ProcessConfiguration

Returns:

Returns process working directory if set, Optional.empty() otherwise

getExecutor

public java.util.Optional<java.util.concurrent.Executor> getExecutor()

Description copied from interface: ProcessConfiguration

Get process executor.

Specified by:

getExecutor in interface ProcessConfiguration

Returns:

Returns process executor, Optional.empty() otherwise

getExecutionTimeout

public java.util.Optional<java.time.Duration> getExecutionTimeout()

Description copied from interface: ProcessConfiguration

Get process execution timeout.

Specified by:

getExecutionTimeout in interface ProcessConfiguration

Returns:

Returns process execution timeout

getEnvVariables

public java.util.Map<java.lang.String,java.lang.String> getEnvVariables()

Description copied from interface: ProcessConfiguration

Get process environment variables.

Specified by:

getEnvVariables in interface ProcessConfiguration

Returns:

Returns process environment variables

getStdOutConsumer

public java.util.Optional<java.util.function.Consumer<java.lang.String>> getStdOutConsumer()

Description copied from interface: ProcessConfiguration

Get process standard out consumer.

Specified by:

getStdOutConsumer in interface ProcessConfiguration

Returns:

Returns process standard out consumer if set, null otherwise

getStdErrConsumer

public java.util.Optional<java.util.function.Consumer<java.lang.String>> getStdErrConsumer()

Description copied from interface: ProcessConfiguration

Get process standard error consumer.

Specified by:

getStdErrConsumer in interface ProcessConfiguration

Returns:

Returns process standard error consumer if set, null otherwise

getCommandAndArguments

public java.util.Collection<java.lang.Object> getCommandAndArguments()

Description copied from interface: ProcessConfiguration

Get command and arguments to execute.

Specified by:

getCommandAndArguments in interface ProcessConfiguration

Returns:

Returns command and arguments to execute.

getStandardOutputRedirects

public java.util.Collection<java.io.OutputStream> getStandardOutputRedirects()

Description copied from interface: ProcessConfiguration

Get output streams to redirect process standard output stream.

Specified by:

getStandardOutputRedirects in interface ProcessConfiguration

Returns:

Returns collections of stream to redirect process standard output

getStandardErrorRedirects

public java.util.Collection<java.io.OutputStream> getStandardErrorRedirects()

Description copied from interface: ProcessConfiguration

Get output streams to redirect process standard error stream.

Specified by:

getStandardErrorRedirects in interface ProcessConfiguration

Returns:

Returns collections of stream to redirect process standard error

getExecution

public ExecutionMode getExecution()

Description copied from interface: ProcessConfiguration

Get process execution mode.

Specified by:

getExecution in interface ProcessConfiguration

Returns:

Returns execution mode

getStdIn

public java.util.Optional<java.io.InputStream> getStdIn()

Description copied from interface: ProcessConfiguration

Get process standard input stream.

Specified by:

getStdIn in interface ProcessConfiguration

Returns:

Returns process standard input stream if set, Optional.empty() otherwise

getProcessDestroyerHandler

public java.util.Optional<ProcessDestroyerHandler> getProcessDestroyerHandler()

Description copied from interface: ProcessConfiguration

Get process destroy handler.

Specified by:

getProcessDestroyerHandler in interface ProcessConfiguration

Returns:

Process destroy handler if set, Optional.empty() otherwise

getDryRunConfiguration

public java.util.Optional<ProcessDryRunConfiguration> getDryRunConfiguration()

Description copied from interface: ProcessConfiguration

Get dry run configuration.

Specified by:

getDryRunConfiguration in interface ProcessConfiguration

Returns:

Returns dry run configuration if set, Optional.empty() otherwise

logger

public DefaultProcessBuilder logger(java.util.function.Consumer<ProcessLoggerConfigurator> processLoggerConfigurator)

Description copied from interface: ProcessBuilder

Configure process logger configuration. This configuration responds for what should be put in log (command line, process output and etc).

Specified by:

logger in interface ProcessBuilder

Parameters:

processLoggerConfigurator - process logger configurator

Returns:

Returns this process builder

processInstance

public DefaultProcessBuilder processInstance(java.util.function.Consumer<ProcessInstanceConfigurator> processInstanceConfigurator)

Description copied from interface: ProcessBuilder

Configure process instance. Responds what should be included in ProcessInstance which is result of process execution.

Specified by:

processInstance in interface ProcessBuilder

Parameters:

processInstanceConfigurator - process execution result configuration

Returns:

Returns this process builder

getCommand

protected java.util.Optional<java.lang.String> getCommand()

getProcessInstanceConfiguration

public java.util.Optional<ProcessInstanceConfiguration> getProcessInstanceConfiguration()

Description copied from interface: ProcessConfiguration

Get process output configuration which will be available via ProcessInstance.

Specified by:

getProcessInstanceConfiguration in interface ProcessConfiguration

Returns:

Returns process instance configuration

getProcessLoggerConfiguration

public java.util.Optional<ProcessLoggerConfiguration> getProcessLoggerConfiguration()

Description copied from interface: ProcessConfiguration

Get process logger configuration.

Specified by:

getProcessLoggerConfiguration in interface ProcessConfiguration

Returns:

Returns process logger configuration