com.atlassian.bamboo.process

Class EnvironmentVariableAccessorImpl

java.lang.Object

com.atlassian.bamboo.process.EnvironmentVariableAccessorImpl

All Implemented Interfaces:

EnvironmentVariableAccessor

public class EnvironmentVariableAccessorImpl
extends Object
implements EnvironmentVariableAccessor

Field Summary

Fields inherited from interface com.atlassian.bamboo.process.EnvironmentVariableAccessor

MAX_SAFE_ENVIRONMENT_LENGTH, MAX_SAFE_INDIVIDUAL_VARIABLE_LENGTH

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableAccessorImpl(CapabilityContext capabilityContext, CustomVariableContext customVariableContext)

Method Summary

Modifier and Type	Method and Description
static String	forceLegalIdentifier(String key)
Map<String,String>	getEnvironment()
Map<String,String>	getEnvironment(CommonTaskContext taskContext) Use TaskContext as a source of environment settings.
List<String>	getPaths(CommonTaskContext taskContext) Use TaskContext as a source of additional PATH settings.
String	joinEnvironmentVariables(Iterable<Map.Entry<String,String>> environmentVariables) Concatenate environment variables into string.
String	joinEnvironmentVariables(Map<String,String> environmentVariables) Concatenate environment variables into string.
Map<String,String>	splitEnvironmentAssignments(String environmentAssignments) Splits "Environment settings" string into array of separate strings.
Map<String,String>	splitEnvironmentAssignments(String environmentAssignments, boolean processBackslashes) Splits "Environment settings" string into array of separate strings.
void	validateEnvironmentVariables(Iterable<Map.Entry<String,String>> environmentVariables) Perform basic validation of environment settings before passing it to process-utils
void	validateEnvironmentVariables(Map<String,String> environmentVariables) Perform basic validation of environment settings before passing it to process-utils

Methods inherited from class java.lang.Object

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

Constructor Detail

EnvironmentVariableAccessorImpl

public EnvironmentVariableAccessorImpl(CapabilityContext capabilityContext,
                                       CustomVariableContext customVariableContext)

Method Detail

getEnvironment

@NotNull
public Map<String,String> getEnvironment()

Specified by:

getEnvironment in interface EnvironmentVariableAccessor

getEnvironment

@NotNull
public Map<String,String> getEnvironment(@NotNull
                                                  CommonTaskContext taskContext)

Description copied from interface: EnvironmentVariableAccessor

Use TaskContext as a source of environment settings. The following variables will be returned - variables for variable definitions from taskContext - JAVA_HOME (if defined in task configuration and appropriate capability exists)

Specified by:

getEnvironment in interface EnvironmentVariableAccessor

Parameters:

taskContext - TaskContext object

Returns:

Key-value map

getPaths

@NotNull
public List<String> getPaths(@NotNull
                                      CommonTaskContext taskContext)

Description copied from interface: EnvironmentVariableAccessor

Use TaskContext as a source of additional PATH settings. The following values might be returned - $JAVA_HOME/bin (if defined in task configuration and appropriate capability exists)

Specified by:

getPaths in interface EnvironmentVariableAccessor

Parameters:

taskContext - TaskContext object

Returns:

List of paths (which will be probably added to PATH by caller

joinEnvironmentVariables

@NotNull
public String joinEnvironmentVariables(@NotNull
                                                Map<String,String> environmentVariables)

Description copied from interface: EnvironmentVariableAccessor

Concatenate environment variables into string.

Specified by:

joinEnvironmentVariables in interface EnvironmentVariableAccessor

Parameters:

environmentVariables - Map of key-value pairs to be concatenated

Returns:

concatenated environment variables in form "KEY1=VALUE1 KEY2=VALUE2 ..."

joinEnvironmentVariables

@NotNull
public String joinEnvironmentVariables(@NotNull
                                                Iterable<Map.Entry<String,String>> environmentVariables)

Description copied from interface: EnvironmentVariableAccessor

Concatenate environment variables into string.

Specified by:

joinEnvironmentVariables in interface EnvironmentVariableAccessor

Parameters:

environmentVariables - Map.Entry iterable of key-value pairs to be concatenated

Returns:

concatenated environment variables in form "KEY1=VALUE1 KEY2=VALUE2 ..."

splitEnvironmentAssignments

@NotNull
public Map<String,String> splitEnvironmentAssignments(@NotNull
                                                               String environmentAssignments,
                                                               boolean processBackslashes)

Description copied from interface: EnvironmentVariableAccessor

Splits "Environment settings" string into array of separate strings. Quoting is taken into consideration. An environment setting is defined as a sequence of characters [noquote]+([quote][noquote]+[quote])? or [quote][noquote][quote]

Specified by:

splitEnvironmentAssignments in interface EnvironmentVariableAccessor

Parameters:

environmentAssignments - the string containing KEY=VALUE assignments separated with white characters

processBackslashes - whether to treat a backslash as an ordinary or quoting character

Returns:

Map of separated environment settings.

splitEnvironmentAssignments

@NotNull
public Map<String,String> splitEnvironmentAssignments(@NotNull
                                                               String environmentAssignments)

Description copied from interface: EnvironmentVariableAccessor

Splits "Environment settings" string into array of separate strings. Quoting using single and double quotes, but not backslashes is taken into consideration. An environment setting is defined as a sequence of characters. [noquote]+([quote][noquote]+[quote])? or [quote][noquote][quote]

Specified by:

splitEnvironmentAssignments in interface EnvironmentVariableAccessor

Parameters:

environmentAssignments - string containing KEY=VALUE assignments separated with white characters

Returns:

Map of separated environment settings.

validateEnvironmentVariables

public void validateEnvironmentVariables(@NotNull
                                         Map<String,String> environmentVariables)

Description copied from interface: EnvironmentVariableAccessor

Perform basic validation of environment settings before passing it to process-utils

Specified by:

validateEnvironmentVariables in interface EnvironmentVariableAccessor

Parameters:

environmentVariables - Map.Entry iterable of key-value pairs to be concatenated

validateEnvironmentVariables

public void validateEnvironmentVariables(@NotNull
                                         Iterable<Map.Entry<String,String>> environmentVariables)

Description copied from interface: EnvironmentVariableAccessor

Perform basic validation of environment settings before passing it to process-utils

Specified by:

validateEnvironmentVariables in interface EnvironmentVariableAccessor

Parameters:

environmentVariables - Map.Entry iterable of key-value pairs to be concatenated

forceLegalIdentifier

@NotNull
public static String forceLegalIdentifier(@NotNull
                                                   String key)