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 and Description
ExternalProcessBuilder()

Method Summary

Modifier and Type	Method and Description
ExternalProcessBuilder	command(List<String> command)
ExternalProcessBuilder	commandFromString(String commandString) Splits the given command string into arguments and adds them to the builder
void	dockerContainerId(String dockerContainer)
ExternalProcessBuilder	env(Map<String,String> env) Adds env variables.
ExternalProcessBuilder	env(String key, String value) Adds env variable.
List<String>	getCommand()
String	getCommandExecutable()
Optional<Runnable>	getCompletionCallback()
String	getDockerContainerId()
Map<String,String>	getEnv()
List<String>	getPaths()
File	getWorkingDirectory()
boolean	isBackgroundProcess()
boolean	isRunWithPowershell()
boolean	isUseWindowsBatFilesForWhitespaceHandling()
ExternalProcessBuilder	path(List<String> path)
ExternalProcessBuilder	path(String path)
ExternalProcessBuilder	runWithPowershell(boolean runWithPowershell)
ExternalProcessBuilder	setBackgroundProcess(boolean value)
ExternalProcessBuilder	setCompletionCallback(Runnable completionCallback)
ExternalProcessBuilder	setUseWindowsBatFilesForWhitespaceHandling(boolean useWindowsBatFilesForWhitespaceHandling)
ExternalProcessBuilder	workingDirectory(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
                                   String path)

path

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

command

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

commandFromString

public ExternalProcessBuilder commandFromString(@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
                                  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
                                  String key,
                                  @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

workingDirectory

public ExternalProcessBuilder workingDirectory(@NotNull
                                               File workingDirectory)

runWithPowershell

public ExternalProcessBuilder runWithPowershell(boolean runWithPowershell)

setBackgroundProcess

public ExternalProcessBuilder setBackgroundProcess(boolean value)

getCompletionCallback

@NotNull
public Optional<Runnable> getCompletionCallback()

setCompletionCallback

public ExternalProcessBuilder setCompletionCallback(@Nullable
                                                    Runnable completionCallback)

isBackgroundProcess

public boolean isBackgroundProcess()

getCommandExecutable

@Nullable
public 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 void dockerContainerId(String dockerContainer)

getDockerContainerId

public String getDockerContainerId()

isUseWindowsBatFilesForWhitespaceHandling

public boolean isUseWindowsBatFilesForWhitespaceHandling()

setUseWindowsBatFilesForWhitespaceHandling

public ExternalProcessBuilder setUseWindowsBatFilesForWhitespaceHandling(boolean useWindowsBatFilesForWhitespaceHandling)