com.atlassian.bamboo.deployments.environments.trigger

Interface PlanAwareEnvironmentTriggerConfigurator

All Superinterfaces:

TriggerConfigurator

All Known Implementing Classes:

AfterSuccessfulPlanTriggerConfigurator, AfterSuccessfulStageTriggerConfigurator, CronTriggerConfigurator

public interface PlanAwareEnvironmentTriggerConfigurator
extends TriggerConfigurator

Configurator for environment triggers. Provides additional operations related to source plan manipulation.

Since:

5.8

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.trigger.TriggerConfigurator

TriggerConfigurator.RepositorySelectionMode

Method Summary

Modifier and Type	Method and Description
boolean	isAffectedByPlanDeletion(@NotNull PlanKey deletedPlanKey, @NotNull TriggerDefinition triggerDefinition) Check if trigger will be affected when Plan is deleted.
void	onDeploymentProjectPlanUpdate(@Nullable ImmutableChain oldPlan, @NotNull ImmutableChain newPlan, @NotNull TriggerDefinition triggerDefinition) Update trigger definition when plan related to deployment is changed.
boolean	updatePlanKey(@NotNull PlanKey originalPlanKey, @NotNull PlanKey newPlanKey, @NotNull TriggerDefinition triggerDefinition) Change plan key referenced by a trigger.
void	validateDeploymentProjectPlanUpdate(@Nullable ImmutableChain oldPlan, @NotNull ImmutableChain newPlan, @NotNull Environment environment, @NotNull List<EnvironmentTriggerValidationError> triggerValidationErrors, @NotNull TriggerDefinition triggerDefinition) Validate change of plan deployment is related to.

Methods inherited from interface com.atlassian.bamboo.trigger.TriggerConfigurator

generateTriggerConfigMap, getRepositorySelectionMode, isRepositorySelectable, populateContextForCreate, populateContextForEdit, populateContextForView, validate

Method Detail

validateDeploymentProjectPlanUpdate

void validateDeploymentProjectPlanUpdate(@Nullable
                                         @Nullable ImmutableChain oldPlan,
                                         @NotNull
                                         @NotNull ImmutableChain newPlan,
                                         @NotNull
                                         @NotNull Environment environment,
                                         @NotNull
                                         @NotNull List<EnvironmentTriggerValidationError> triggerValidationErrors,
                                         @NotNull
                                         @NotNull TriggerDefinition triggerDefinition)

Validate change of plan deployment is related to.

Parameters:

oldPlan -

newPlan -

environment -

triggerValidationErrors -

triggerDefinition -

onDeploymentProjectPlanUpdate

void onDeploymentProjectPlanUpdate(@Nullable
                                   @Nullable ImmutableChain oldPlan,
                                   @NotNull
                                   @NotNull ImmutableChain newPlan,
                                   @NotNull
                                   @NotNull TriggerDefinition triggerDefinition)

Update trigger definition when plan related to deployment is changed.

updatePlanKey

boolean updatePlanKey(@NotNull
                      @NotNull PlanKey originalPlanKey,
                      @NotNull
                      @NotNull PlanKey newPlanKey,
                      @NotNull
                      @NotNull TriggerDefinition triggerDefinition)

Change plan key referenced by a trigger. Used in case of plan key change (e.g. plan being moved)

Parameters:

originalPlanKey - original value of plan key

newPlanKey - new value of plan key

Returns:

true iff a change in configuration was performed

isAffectedByPlanDeletion

boolean isAffectedByPlanDeletion(@NotNull
                                 @NotNull PlanKey deletedPlanKey,
                                 @NotNull
                                 @NotNull TriggerDefinition triggerDefinition)

Check if trigger will be affected when Plan is deleted.

Parameters:

deletedPlanKey - key of Plan that was deleted

Returns:

true if action needs to be taken when Plan is deleted