com.atlassian.bamboo.variable

Class VariableDefinitionManagerImpl

java.lang.Object

com.atlassian.bamboo.variable.VariableDefinitionManagerImpl

All Implemented Interfaces:

VariableDefinitionAccessor, VariableDefinitionManager

public class VariableDefinitionManagerImpl
extends Object
implements VariableDefinitionManager

On the fly encoding/decoding. All the decoding methods will return objects not attached to Hibernate session.

Constructor Summary

Constructors

Constructor and Description
VariableDefinitionManagerImpl(VariableDefinitionDao variableDefinitionDao, AuditLogService auditLogService, EncryptedVariableDefinitionAccessor encryptedVariableDefinitionAccessor)

Method Summary

Modifier and Type	Method and Description
int	countDeploymentEnvironmentVariables(long environmentId) Count list of environment variables associated with a given deployment environment
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	remove(VariableDefinition variableDefinition)
void	save(VariableDefinition variableDefinition)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

VariableDefinitionManagerImpl

public VariableDefinitionManagerImpl(VariableDefinitionDao variableDefinitionDao,
                                     AuditLogService auditLogService,
                                     EncryptedVariableDefinitionAccessor encryptedVariableDefinitionAccessor)

Method Detail

findVariableDefinition

@Nullable
public VariableDefinition findVariableDefinition(long id)

Description copied from interface: VariableDefinitionAccessor

Find variable definition of specified id

Specified by:

findVariableDefinition in interface VariableDefinitionAccessor

Parameters:

id - id of variable definition

Returns:

variable definition of specified id or null if not found

saveVariableDefinition

public void saveVariableDefinition(@NotNull
                                   VariableDefinition variableDefinition)

Description copied from interface: VariableDefinitionManager

Save variable definition

Specified by:

saveVariableDefinition in interface VariableDefinitionManager

Parameters:

variableDefinition - variable definition to be saved

saveVariableDefinition

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

Description copied from interface: VariableDefinitionManager

Save variable definition

Specified by:

saveVariableDefinition in interface VariableDefinitionManager

Parameters:

variableDefinition - variable definition to be saved

previousValue - previous variable value

deleteVariableDefinition

public void deleteVariableDefinition(@NotNull
                                     VariableDefinition variableDefinition)

Description copied from interface: VariableDefinitionManager

Delete variable definition

Specified by:

deleteVariableDefinition in interface VariableDefinitionManager

Parameters:

variableDefinition - variable definition to be deleted

deleteVariablesForPlan

public void deleteVariablesForPlan(@NotNull
                                   Plan plan)

Description copied from interface: VariableDefinitionManager

Removes variable definitions form specified plan

Specified by:

deleteVariablesForPlan in interface VariableDefinitionManager

getGlobalVariables

@NotNull
public List<VariableDefinition> getGlobalVariables()

Description copied from interface: VariableDefinitionAccessor

Get list of all global variables

Specified by:

getGlobalVariables in interface VariableDefinitionAccessor

Returns:

sorted list of all global variables

getGlobalVariableByKey

@Nullable
public VariableDefinition getGlobalVariableByKey(String key)

Description copied from interface: VariableDefinitionAccessor

Retrieves a specific global variable by key.

Specified by:

getGlobalVariableByKey in interface VariableDefinitionAccessor

Parameters:

key - of the variable

Returns:

global variable with specified key or null if none found.

getPlanVariableByKey

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

Description copied from interface: VariableDefinitionAccessor

Retrieves a specific variable for the plan with the given key

Specified by:

getPlanVariableByKey in interface VariableDefinitionAccessor

Parameters:

plan - variable belongs to

key - of variable

Returns:

plan variable with specified key or null if none found.

getPlanVariables

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

Description copied from interface: VariableDefinitionAccessor

Get list of plan variables associated with a given plan

Specified by:

getPlanVariables in interface VariableDefinitionAccessor

Parameters:

plan - Plan whose associated variables should be returned

Returns:

sorted list of plan variables

countDeploymentEnvironmentVariables

public int countDeploymentEnvironmentVariables(long environmentId)

Description copied from interface: VariableDefinitionAccessor

Count list of environment variables associated with a given deployment environment

Specified by:

countDeploymentEnvironmentVariables in interface VariableDefinitionAccessor

Parameters:

environmentId - id of Deployment environment

Returns:

getDeploymentEnvironmentVariables

@NotNull
public List<VariableDefinition> getDeploymentEnvironmentVariables(long environmentId)

Description copied from interface: VariableDefinitionAccessor

Get list of environment variables associated with a given deployment environment

Specified by:

getDeploymentEnvironmentVariables in interface VariableDefinitionAccessor

Parameters:

environmentId - id of Deployment environment

Returns:

sorted list of variables

getDeploymentVersionVariables

@NotNull
public List<VariableDefinition> getDeploymentVersionVariables(long deploymentVersionId)

Description copied from interface: VariableDefinitionAccessor

Get list of environment variables associated with a given deployment version

Specified by:

getDeploymentVersionVariables in interface VariableDefinitionAccessor

Parameters:

deploymentVersionId - id of Deployment environment

Returns:

sorted list of variables

getGlobalNotOverriddenVariables

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

Description copied from interface: VariableDefinitionAccessor

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

Specified by:

getGlobalNotOverriddenVariables in interface VariableDefinitionAccessor

Parameters:

plan - Plan whose associated variables should be used

Returns:

sorted list of global only variables

getGlobalNotOverriddenEnvironmentVariables

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

Specified by:

getGlobalNotOverriddenEnvironmentVariables in interface VariableDefinitionAccessor

getSimpleVariableMapByType

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

Description copied from interface: VariableDefinitionAccessor

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

Specified by:

getSimpleVariableMapByType in interface VariableDefinitionAccessor

Returns:

createVariableContextBuilder

@NotNull
public VariableContextBuilder createVariableContextBuilder()

Specified by:

createVariableContextBuilder in interface VariableDefinitionManager

remove

public void remove(VariableDefinition variableDefinition)

save

public void save(VariableDefinition variableDefinition)

saveVariableDefinitions

public void saveVariableDefinitions(List<VariableDefinition> variableDefinitions)

Description copied from interface: VariableDefinitionManager

Save all variable definitions on the list

Specified by:

saveVariableDefinitions in interface VariableDefinitionManager