com.atlassian.bamboo.variable

Interface VariableValidationService

All Known Implementing Classes:

VariableValidationServiceImpl

public interface VariableValidationService

Method Summary

Modifier and Type	Method and Description
void	validateIdForDeploymentEnvironmentVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, long variableId, long environmentId) Validate if id identifies an existing variable associated with Deployment Environment *
void	validateIdForGlobalVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, long variableId) Validate if id identifies global variable
void	validateIdForPlanVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, long variableId, @NotNull ImmutablePlan expectedPlan) Validate if id identifies plan variable of a given plan
void	validateIdForProjectVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, long variableId, long projectId) Validate if id identifies project variable of a given project
void	validateKey(@NotNull com.atlassian.struts.ValidationAware validationAware, @NotNull String fieldName, @Nullable String variableKey) Validate String against Bamboo general rules for variable keys
void	validateValueForEncryptedVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, @NotNull String fieldName, @Nullable String variableValue) Validate value of password variable
void	validateValueForVariable(@NotNull com.atlassian.struts.ValidationAware validationAware, @NotNull String fieldName, @Nullable String variableValue) Validate String against Bamboo general rules for variable value

Method Detail

validateIdForGlobalVariable

void validateIdForGlobalVariable(@NotNull
                                 @NotNull com.atlassian.struts.ValidationAware validationAware,
                                 long variableId)

Validate if id identifies global variable

Parameters:

validationAware - the object to add errors to if any are found

variableId - the actual id to validate

validateIdForPlanVariable

void validateIdForPlanVariable(@NotNull
                               @NotNull com.atlassian.struts.ValidationAware validationAware,
                               long variableId,
                               @NotNull
                               @NotNull ImmutablePlan expectedPlan)

Validate if id identifies plan variable of a given plan

Parameters:

validationAware - the object to add errors to if any are found

variableId - the actual id to validate

expectedPlan - the Plan we expect this variable to be associated to

validateIdForDeploymentEnvironmentVariable

void validateIdForDeploymentEnvironmentVariable(@NotNull
                                                @NotNull com.atlassian.struts.ValidationAware validationAware,
                                                long variableId,
                                                long environmentId)

Validate if id identifies an existing variable associated with Deployment Environment *

Parameters:

validationAware - the object to add errors to if any are found

variableId - the actual id to validate

environmentId - the id of an com.atlassian.bamboo.deployments.environments.Environment we expect this variable to be associated to

validateKey

void validateKey(@NotNull
                 @NotNull com.atlassian.struts.ValidationAware validationAware,
                 @NotNull
                 @NotNull String fieldName,
                 @Nullable
                 @Nullable String variableKey)

Validate String against Bamboo general rules for variable keys

Parameters:

validationAware - the object to add errors to if any are found

fieldName - the name of the field to add the errors to

variableKey - the actual key to validate

validateValueForVariable

void validateValueForVariable(@NotNull
                              @NotNull com.atlassian.struts.ValidationAware validationAware,
                              @NotNull
                              @NotNull String fieldName,
                              @Nullable
                              @Nullable String variableValue)

Validate String against Bamboo general rules for variable value

Parameters:

validationAware - the object to add errors to if any are found

fieldName - the name of the field to add the errors to

variableValue - the actual value to validate

validateValueForEncryptedVariable

void validateValueForEncryptedVariable(@NotNull
                                       @NotNull com.atlassian.struts.ValidationAware validationAware,
                                       @NotNull
                                       @NotNull String fieldName,
                                       @Nullable
                                       @Nullable String variableValue)

Validate value of password variable

Parameters:

validationAware - the object to add errors to if any are found

fieldName - the name of the field to add the errors to

variableValue - the actual value to validate

validateIdForProjectVariable

void validateIdForProjectVariable(@NotNull
                                  @NotNull com.atlassian.struts.ValidationAware validationAware,
                                  long variableId,
                                  long projectId)

Validate if id identifies project variable of a given project

Parameters:

validationAware - the object to add errors to if any are found

variableId - the actual id to validate

projectId - the if of a Project we expect this variable to be associated to