Package com.atlassian.bamboo.process

Class ExternalProcessBuilder

java.lang.Object

com.atlassian.bamboo.process.ExternalProcessBuilder

@PublicApi
public final class ExternalProcessBuilder
extends Object

Builder to create ExternalProcesss using the ProcessService

Since:

3.1

Constructor Summary

Constructors

Constructor	Description
ExternalProcessBuilder()

Method Summary

Modifier and Type	Method	Description
ExternalProcessBuilder	command(@NotNull List<String> command)
ExternalProcessBuilder	commandFromString(@NotNull String commandString)	Splits the given command string into arguments and adds them to the builder
ExternalProcessBuilder	dockerContainerId(String dockerContainer)
ExternalProcessBuilder	env(@NotNull String key, @NotNull String value)	Adds env variable.
ExternalProcessBuilder	env(@NotNull Map<String,String> env)	Adds env variables.
List<String>	getCommand()
@Nullable String	getCommandExecutable()
@NotNull Optional<Runnable>	getCompletionCallback()
String	getDockerContainerId()
Map<String,String>	getEnv()
@Nullable String	getInput()
List<String>	getPaths()
File	getWorkingDirectory()
ExternalProcessBuilder	input(@Nullable String input)	Set the standard input to be passed to the spawned process.
boolean	isBackgroundProcess()
boolean	isRunWithPowershell()
boolean	isUseWindowsBatFilesForWhitespaceHandling()
ExternalProcessBuilder	path(@NotNull String path)
ExternalProcessBuilder	path(@NotNull List<String> path)
ExternalProcessBuilder	runWithPowershell(boolean runWithPowershell)
ExternalProcessBuilder	setBackgroundProcess(boolean value)
ExternalProcessBuilder	setCompletionCallback(@Nullable Runnable completionCallback)
ExternalProcessBuilder	setUseWindowsBatFilesForWhitespaceHandling(boolean useWindowsBatFilesForWhitespaceHandling)
ExternalProcessBuilder	workingDirectory(@NotNull File workingDirectory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalProcessBuilder

public ExternalProcessBuilder()

Method Detail

path

public ExternalProcessBuilder path(@NotNull
                                   @NotNull String path)

path

public ExternalProcessBuilder path(@NotNull
                                   @NotNull List<String> path)

command

public ExternalProcessBuilder command(@NotNull
                                      @NotNull List<String> command)

commandFromString

public ExternalProcessBuilder commandFromString(@NotNull
                                                @NotNull String commandString)

Splits the given command string into arguments and adds them to the builder

Parameters:

commandString - to split into multiple parts and add to the list of commands

Returns:

builder

Since:

3.1.4

env

public ExternalProcessBuilder env(@NotNull
                                  @NotNull Map<String,String> env)

Adds env variables. If variable name equals SystemProperty.PATH.getKey() the value is appended to the front of existing paths

Parameters:

env - key -> value map of environment variables to add

Returns:

builder

env

public ExternalProcessBuilder env(@NotNull
                                  @NotNull String key,
                                  @NotNull
                                  @NotNull String value)

Adds env variable. If variable name equals SystemProperty.PATH.getKey() the value is appended to the front of existing paths.

Parameters:

key - name of environment variable

value - value of environment variable

Returns:

builder

input

public ExternalProcessBuilder input(@Nullable
                                    @Nullable String input)

Set the standard input to be passed to the spawned process.

workingDirectory

public ExternalProcessBuilder workingDirectory(@NotNull
                                               @NotNull File workingDirectory)

runWithPowershell

public ExternalProcessBuilder runWithPowershell(boolean runWithPowershell)

setBackgroundProcess

public ExternalProcessBuilder setBackgroundProcess(boolean value)

getCompletionCallback

@NotNull
public @NotNull Optional<Runnable> getCompletionCallback()

setCompletionCallback

public ExternalProcessBuilder setCompletionCallback(@Nullable
                                                    @Nullable Runnable completionCallback)

isBackgroundProcess

public boolean isBackgroundProcess()

getCommandExecutable

@Nullable
public @Nullable String getCommandExecutable()

getPaths

public List<String> getPaths()

getCommand

public List<String> getCommand()

getWorkingDirectory

public File getWorkingDirectory()

getEnv

public Map<String,String> getEnv()

isRunWithPowershell

public boolean isRunWithPowershell()

dockerContainerId

public ExternalProcessBuilder dockerContainerId(String dockerContainer)

getDockerContainerId

public String getDockerContainerId()

isUseWindowsBatFilesForWhitespaceHandling

public boolean isUseWindowsBatFilesForWhitespaceHandling()

setUseWindowsBatFilesForWhitespaceHandling

public ExternalProcessBuilder setUseWindowsBatFilesForWhitespaceHandling(boolean useWindowsBatFilesForWhitespaceHandling)

getInput

@Nullable
public @Nullable String getInput()