Package com.github.toolarium.system.command.builder

Interface ISystemCommandExecuterBuilder

All Known Implementing Classes:

AbstractCommandExecuterBuilder, AbstractJavaSystemCommandExecuteBuilder, DockerSystemCommandExecuterBuilder, JarSystemCommandExecuterBuilder, JavaSystemCommandExecuterBuilder, SystemCommandExecuterBuilder

public interface ISystemCommandExecuterBuilder

Defines the system command executer builder

Method Summary

Modifier and Type	Method	Description
ISystemCommandExecuter	build()	Build the system executer
ISystemCommandExecuterBuilder	environmentVariable(java.lang.String key, java.lang.String value)	Add an environment variable
ISystemCommandExecuterBuilder	lock()	Lock the current system command group list (default timeout).
ISystemCommandExecuterBuilder	lock(java.lang.Integer lockTimeoutInSeconds)	Lock the current system command group list.
ISystemCommandExecuterTypeBuilder	onError()	On error of the current command start a next command
ISystemCommandExecuterTypeBuilder	onSuccess()	On success of the current command start a next command
ISystemCommandExecuterTypeBuilder	onSuccessOrError()	On success or error of the current command start a next command
ISystemCommandExecuterTypeBuilder	pipe()	Pipe the output of the the current command into a next command
ISystemCommandExecuterBuilder	shell(java.lang.String... shell)	Set the shell of the current command
ISystemCommandExecuterBuilder	user(java.lang.String user)	Set the user of the current command
ISystemCommandExecuterBuilder	workingPath(java.lang.String workingPath)	Set the working path of the current command

Method Detail

onSuccess

ISystemCommandExecuterTypeBuilder onSuccess()

On success of the current command start a next command

Returns:

the builder

onError

ISystemCommandExecuterTypeBuilder onError()

On error of the current command start a next command

Returns:

the builder

onSuccessOrError

ISystemCommandExecuterTypeBuilder onSuccessOrError()

On success or error of the current command start a next command

Returns:

the builder

pipe

ISystemCommandExecuterTypeBuilder pipe()

Pipe the output of the the current command into a next command

Returns:

the builder

shell

ISystemCommandExecuterBuilder shell(java.lang.String... shell)

Set the shell of the current command

Parameters:

shell - the shell

Returns:

the system command executer builder

user

ISystemCommandExecuterBuilder user(java.lang.String user)

Set the user of the current command

Parameters:

user - the user

Returns:

the system command executer builder

workingPath

ISystemCommandExecuterBuilder workingPath(java.lang.String workingPath)

Set the working path of the current command

Parameters:

workingPath - the workingPath

Returns:

the system command executer builder

environmentVariable

ISystemCommandExecuterBuilder environmentVariable(java.lang.String key,
                                                  java.lang.String value)

Add an environment variable

Parameters:

key - the key

value - the value

Returns:

the system command executer builder

lock

ISystemCommandExecuterBuilder lock()

Lock the current system command group list (default timeout).

Returns:

the system command executer builder

lock

ISystemCommandExecuterBuilder lock(java.lang.Integer lockTimeoutInSeconds)

Lock the current system command group list.

Parameters:

lockTimeoutInSeconds - the period in seconds

Returns:

the system command executer builder

build

ISystemCommandExecuter build()

Build the system executer

Returns:

the system executer