com.atlassian.bamboo.variable
Interface VariableDefinitionManager

All Known Implementing Classes:

VariableDefinitionManagerImpl

@PublicApi
public interface VariableDefinitionManager

Method Summary

VariableContextBuilder	createVariableContextBuilder()
void	deleteVariableDefinition(VariableDefinition variableDefinition) Delete variable definition
void	deleteVariablesForPlan(Plan plan) Removes variable definitions form specified plan
VariableDefinition	findVariableDefinition(long id) Find variable definition of specified id
List<VariableDefinition>	getDeploymentEnvironmentVariables(long environmentId) Get list of environment variables associated with a given deployment environment
List<VariableDefinition>	getDeploymentVersionVariables(long deploymentVersionId) Get list of environment variables associated with a given deployment version
List<VariableDefinition>	getGlobalNotOverriddenEnvironmentVariables(long environmentId)
List<VariableDefinition>	getGlobalNotOverriddenVariables(PlanIdentifier plan) Get list of all global variables that are not overridden by plan variables for a given plan
VariableDefinition	getGlobalVariableByKey(String key) Retrieves a specific global variable by key.
List<VariableDefinition>	getGlobalVariables() Get list of all global variables
VariableDefinition	getPlanVariableByKey(PlanIdentifier plan, String key) Retrieves a specific variable for the plan with the given key
List<VariableDefinition>	getPlanVariables(PlanIdentifier plan) Get list of plan variables associated with a given plan
Map<String,String>	getSimpleVariableMapByType(VariableContext variableContext, VariableType variableType) Filter variable context by variable type and return as simple key/value map
void	saveVariableDefinition(VariableDefinition variableDefinition) Save variable definition
void	saveVariableDefinition(VariableDefinition variableDefinition, String previousValue) Save variable definition
void	saveVariableDefinitions(List<VariableDefinition> variableDefinitions) Save all variable definitions on the list

Method Detail

findVariableDefinition

@Nullable
VariableDefinition findVariableDefinition(long id)

Find variable definition of specified id

Parameters:

id - id of variable definition

Returns:

variable definition of specified id or null if not found

saveVariableDefinition

void saveVariableDefinition(@NotNull
                            VariableDefinition variableDefinition)

Save variable definition

Parameters:

variableDefinition - variable definition to be saved

saveVariableDefinition

void saveVariableDefinition(@NotNull
                            VariableDefinition variableDefinition,
                            @Nullable
                            String previousValue)

Save variable definition

Parameters:

variableDefinition - variable definition to be saved

previousValue - previous variable value

deleteVariableDefinition

void deleteVariableDefinition(@NotNull
                              VariableDefinition variableDefinition)

Delete variable definition

Parameters:

variableDefinition - variable definition to be deleted

getGlobalVariables

@NotNull
List<VariableDefinition> getGlobalVariables()

Get list of all global variables

Returns:

sorted list of all global variables

getGlobalVariableByKey

@Nullable
VariableDefinition getGlobalVariableByKey(String key)

Retrieves a specific global variable by key.

Parameters:

key - of the variable

Returns:

global variable with specified key or null if none found.

getPlanVariableByKey

@Nullable
VariableDefinition getPlanVariableByKey(@NotNull
                                                 PlanIdentifier plan,
                                                 @NotNull
                                                 String key)

Retrieves a specific variable for the plan with the given key

Parameters:

plan - variable belongs to

key - of variable

Returns:

plan variable with specified key or null if none found.

getPlanVariables

@NotNull
List<VariableDefinition> getPlanVariables(@NotNull
                                                  PlanIdentifier plan)

Get list of plan variables associated with a given plan

Parameters:

plan - Plan whose associated variables should be returned

Returns:

sorted list of plan variables

getDeploymentEnvironmentVariables

@NotNull
List<VariableDefinition> getDeploymentEnvironmentVariables(long environmentId)

Get list of environment variables associated with a given deployment environment

Parameters:

environmentId - id of Deployment environment

Returns:

sorted list of variables

Since:

5.0

getDeploymentVersionVariables

@NotNull
List<VariableDefinition> getDeploymentVersionVariables(long deploymentVersionId)

Get list of environment variables associated with a given deployment version

Parameters:

deploymentVersionId - id of Deployment environment

Returns:

sorted list of variables

Since:

5.0

getSimpleVariableMapByType

@NotNull
Map<String,String> getSimpleVariableMapByType(@NotNull
                                                      VariableContext variableContext,
                                                      @NotNull
                                                      VariableType variableType)

Filter variable context by variable type and return as simple key/value map

Parameters:

variableContext -

variableType -

Returns:

deleteVariablesForPlan

void deleteVariablesForPlan(@NotNull
                            Plan plan)

Removes variable definitions form specified plan

Parameters:

plan -

getGlobalNotOverriddenVariables

@NotNull
List<VariableDefinition> getGlobalNotOverriddenVariables(@NotNull
                                                                 PlanIdentifier plan)

Get list of all global variables that are not overridden by plan variables for a given plan

Parameters:

plan - Plan whose associated variables should be used

Returns:

sorted list of global only variables

getGlobalNotOverriddenEnvironmentVariables

@NotNull
List<VariableDefinition> getGlobalNotOverriddenEnvironmentVariables(@NotNull
                                                                            long environmentId)

saveVariableDefinitions

void saveVariableDefinitions(List<VariableDefinition> variableDefinitions)

Save all variable definitions on the list

createVariableContextBuilder

@NotNull
VariableContextBuilder createVariableContextBuilder()