com.atlassian.bamboo.variable

Interface VariableConfigurationService

All Known Implementing Classes:

VariableConfigurationServiceImpl

@PublicApi
public interface VariableConfigurationService

Service for modification of global and plan variable definitions.

Since:

4.4

Method Summary

Modifier and Type	Method and Description
VariableDefinition	createGlobalVariable(String variableKey, String variableValue) Creates new Global variable.
VariableDefinition	createPlanVariable(Plan plan, String variableKey, String variableValue) Creates new Plan variable.
VariableDefinition	createProjectVariable(long projectId, String variableKey, String variableValue) Create a project variable.
VariableDefinition	createUniqueGlobalVariable(String variableKey, String variableValue) Creates new global variable.
VariableDefinition	createUniquePlanVariable(Plan plan, String variableKey, String variableValue) Creates new Plan variable.
VariableDefinition	createVariableForEnvironment(long environmentId, String variableKey, String variableValue) Creates new variable for Deployment Environment
void	deleteVariableDefinition(VariableDefinition variableDefinition) Removes VariableDefinition
void	setDeploymentEnvironmentVariables(long environmentId, List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables) Creates complete deployment environment variables list.
void	setPlanVariables(Chain plan, List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables) Creates complete plan variables list.
VariableDefinition	updateVariableDefinition(VariableDefinition variableDefinition, String previousValue) Updates VariableDefinition

Method Detail

createUniquePlanVariable

@NotNull
VariableDefinition createUniquePlanVariable(@NotNull
                                                     Plan plan,
                                                     @NotNull
                                                     String variableKey,
                                                     @NotNull
                                                     String variableValue)

Creates new Plan variable. If a variable with the same key prefix and value already exists nothing will be created and existing variable is returned. If a variable with the same key but different value already exists, this method will add unique suffix to the key and create a new variable.

Parameters:

plan - plan the variable belongs to

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition

createUniqueGlobalVariable

@NotNull
VariableDefinition createUniqueGlobalVariable(@NotNull
                                                       String variableKey,
                                                       @NotNull
                                                       String variableValue)

Creates new global variable. If a variable with the same key prefix and value already exists nothing will be created and existing variable is returned. If a variable with the same key but different value already exists, this method will add unique suffix to the key and create a new variable.

Parameters:

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition

createPlanVariable

@NotNull
VariableDefinition createPlanVariable(@NotNull
                                               Plan plan,
                                               @NotNull
                                               String variableKey,
                                               @NotNull
                                               String variableValue)

Creates new Plan variable.

Parameters:

plan - plan the variable belongs to

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition

Throws:

IllegalArgumentException - iff variable key is not unique

createVariableForEnvironment

@NotNull
VariableDefinition createVariableForEnvironment(long environmentId,
                                                         @NotNull
                                                         String variableKey,
                                                         @NotNull
                                                         String variableValue)

Creates new variable for Deployment Environment

Parameters:

environmentId -

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition

Throws:

IllegalArgumentException - iff variable key is not unique or com.atlassian.bamboo.deployments.environments.Environment does not exist

createGlobalVariable

@NotNull
VariableDefinition createGlobalVariable(@NotNull
                                                 String variableKey,
                                                 @NotNull
                                                 String variableValue)

Creates new Global variable.

Parameters:

variableValue - variable value

Returns:

created VariableDefinition

Throws:

IllegalArgumentException - iff variable key is not unique

updateVariableDefinition

@NotNull
VariableDefinition updateVariableDefinition(@NotNull
                                                     VariableDefinition variableDefinition,
                                                     String previousValue)

Updates VariableDefinition

Throws:

IllegalArgumentException - iff variable key is not unique

deleteVariableDefinition

void deleteVariableDefinition(@NotNull
                              VariableDefinition variableDefinition)

Removes VariableDefinition

setPlanVariables

void setPlanVariables(@NotNull
                      Chain plan,
                      @NotNull
                      List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)

Creates complete plan variables list. All pre-existing variables are updated to values provided or removed if new value is not provided. New variables are created if necessary.

Since:

5.15

setDeploymentEnvironmentVariables

void setDeploymentEnvironmentVariables(long environmentId,
                                       @NotNull
                                       List<com.atlassian.bamboo.specs.api.model.VariableProperties> variables)

Creates complete deployment environment variables list. All pre-existing variables are updated to values provided or removed if new value is not provided. New variables are created if necessary.

Since:

6.1

createProjectVariable

VariableDefinition createProjectVariable(long projectId,
                                         @NotNull
                                         String variableKey,
                                         @NotNull
                                         String variableValue)

Create a project variable.

Returns:

Since:

7.1