VariableConfigurationServiceImpl (Atlassian Bamboo 9.0.1 API)

java.lang.Object
- com.atlassian.bamboo.variable.VariableConfigurationServiceImpl

All Implemented Interfaces:: VariableConfigurationService

public class VariableConfigurationServiceImpl
extends Object
implements VariableConfigurationService

Constructor Summary

Constructors
Constructor and Description
`VariableConfigurationServiceImpl(@NotNull ScopedExclusionService scopedExclusionService, @NotNull VariableDefinitionManager variableDefinitionManager, @NotNull VariableDefinitionFactory variableDefinitionFactory)`

Method Summary

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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VariableConfigurationServiceImpl

public VariableConfigurationServiceImpl(@NotNull
                                        @NotNull ScopedExclusionService scopedExclusionService,
                                        @NotNull
                                        @NotNull VariableDefinitionManager variableDefinitionManager,
                                        @NotNull
                                        @NotNull VariableDefinitionFactory variableDefinitionFactory)

Method Detail

createUniquePlanVariable
```
@NotNull
public @NotNull VariableDefinition createUniquePlanVariable(@NotNull
                                                                     @NotNull Plan plan,
                                                                     @NotNull
                                                                     @NotNull String variableKey,
                                                                     @NotNull
                                                                     @NotNull String variableValue)
```
Description copied from interface: VariableConfigurationService

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.

Specified by:

createUniquePlanVariable in interface VariableConfigurationService

Parameters:

plan - plan the variable belongs to

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition

createUniqueGlobalVariable
```
@NotNull
public @NotNull VariableDefinition createUniqueGlobalVariable(@NotNull
                                                                       @NotNull String variableKey,
                                                                       @NotNull
                                                                       @NotNull String variableValue)
```
Description copied from interface: VariableConfigurationService

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.

Specified by:

createUniqueGlobalVariable in interface VariableConfigurationService

Parameters:

variableKey - variable key.

variableValue - variable value

Returns:

created VariableDefinition