com.atlassian.bamboo.plan.branch

Interface LightweightBranchCreationService

All Known Implementing Classes:

LightweightBranchCreationServiceImpl

@Internal
public interface LightweightBranchCreationService

Service for creating lightweight branches. You probably want to use BranchCreationFacade

Method Summary

Modifier and Type	Method and Description
ChainBranchCreationResult	createChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, String branchName, String branchDescription, PlanRepositoryDefinition defaultRepositoryDefinition, VcsRepositoryModuleDescriptor moduleDescriptor, VcsBranch newBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry, Consumer<PlanKey> branchPlanKeyConsumer, boolean expectingDivergentBranch) Creates a new lightweight plan branch for give chain.
Collection<ChainBranchCreationResult>	createChainBranches(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, Collection<VcsBranch> branches, PlanRepositoryDefinition defaultRepositoryDefinition, ErrorCollection errorCollection, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry, Consumer<PlanKey> branchPlanKeyConsumer, boolean expectingDivergentBranch) Creates a new lightweight plan branch or enables existing one for each vcs branch in given collection under given chain.
ChainBranchCreationResult	createOrEnableChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, String branchName, Function<VcsBranchConfigurator,VcsBranch> vcsBranchProvider, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry, Consumer<PlanKey> branchPlanKeyConsumer, boolean expectingDivergentBranch) Given a branch name and (optionally) vcs branch name, check if branch already exists.
ChainBranchCreationResult	enableExistingChainBranch(ImmutableChain chain, ImmutableChainBranch existingChainBranch, VcsBranch vcsBranch, PlanCreationService.EnablePlan enablePlan, boolean expectingDivergentBranch) Enables existing chain branch.
void	validateCreateChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, String branchName, String branchDescription, PlanRepositoryDefinition defaultRepositoryDefinition, VcsRepositoryModuleDescriptor moduleDescriptor, VcsBranch newBranch, boolean enableExpiry, com.atlassian.struts.ValidationAware validationAware) Validates configuration for creating chain branch

Method Detail

createOrEnableChainBranch

@NotNull
ChainBranchCreationResult createOrEnableChainBranch(@NotNull
                                                             ImmutableChain chain,
                                                             @NotNull
                                                             PlanBranchWorkflow planBranchWorkflow,
                                                             @Nullable
                                                             String branchName,
                                                             @NotNull
                                                             Function<VcsBranchConfigurator,VcsBranch> vcsBranchProvider,
                                                             @Nullable
                                                             BuildConfiguration buildConfiguration,
                                                             @NotNull
                                                             PlanCreationService.EnablePlan enablePlan,
                                                             boolean enableExpiry,
                                                             @NotNull
                                                             Consumer<PlanKey> branchPlanKeyConsumer,
                                                             boolean expectingDivergentBranch)
                                                      throws PlanCreationDeniedException

Given a branch name and (optionally) vcs branch name, check if branch already exists. If it does, enable it if it's disabled. Otherwise create a new lightweight plan branch.

Parameters:

chain - to create branch under

planBranchWorkflow - which workflow led to creation of branch

branchName - optional name for the plan branch. If null name of vcs branch will be used.

vcsBranchProvider - provides VcsBranch to use when overriding repository definition

buildConfiguration - optional default fragment of configuration to create the chain branch with

enablePlan - defines whether newly created branches should be enabled or disabled after creation

enableExpiry - defines whether created branch can be removed due to branch expiration detection

branchPlanKeyConsumer - code should be executed before triggering events that new plan created

expectingDivergentBranch - RSS will attempt updating this branch; post creation events should be deferred

Returns:

key of the created plan branch

Throws:

PlanCreationDeniedException

enableExistingChainBranch

@NotNull
ChainBranchCreationResult enableExistingChainBranch(@NotNull
                                                             ImmutableChain chain,
                                                             @NotNull
                                                             ImmutableChainBranch existingChainBranch,
                                                             @NotNull
                                                             VcsBranch vcsBranch,
                                                             @NotNull
                                                             PlanCreationService.EnablePlan enablePlan,
                                                             boolean expectingDivergentBranch)

Enables existing chain branch.

createChainBranches

@NotNull
Collection<ChainBranchCreationResult> createChainBranches(@NotNull
                                                                   ImmutableChain chain,
                                                                   @NotNull
                                                                   PlanBranchWorkflow planBranchWorkflow,
                                                                   @NotNull
                                                                   Collection<VcsBranch> branches,
                                                                   @NotNull
                                                                   PlanRepositoryDefinition defaultRepositoryDefinition,
                                                                   @Nullable
                                                                   ErrorCollection errorCollection,
                                                                   @NotNull
                                                                   PlanCreationService.EnablePlan enablePlan,
                                                                   boolean enableExpiry,
                                                                   @NotNull
                                                                   Consumer<PlanKey> branchPlanKeyConsumer,
                                                                   boolean expectingDivergentBranch)

Creates a new lightweight plan branch or enables existing one for each vcs branch in given collection under given chain.

Parameters:

chain - to create branches under

planBranchWorkflow - which workflow led to creation of these branches

branches - collection ov vcs branches for which plan branches should be created

defaultRepositoryDefinition - default repository of the given chain

errorCollection - to add errors to, if you don't supply an error collection, they will just get logged

enablePlan - defines whether newly created branches should be enabled or disabled after creation

enableExpiry - defines whether created branch can be removed due to branch expiration detection

branchPlanKeyConsumer - code should be executed before triggering events that new plan created

expectingDivergentBranch - RSS will attempt updating this branch; post creation events should be deferred

Returns:

keys of created plan branches

createChainBranch

@NotNull
ChainBranchCreationResult createChainBranch(@NotNull
                                                     ImmutableChain chain,
                                                     @NotNull
                                                     PlanBranchWorkflow planBranchWorkflow,
                                                     @NotNull
                                                     String branchName,
                                                     @Nullable
                                                     String branchDescription,
                                                     @Nullable
                                                     PlanRepositoryDefinition defaultRepositoryDefinition,
                                                     @Nullable
                                                     VcsRepositoryModuleDescriptor moduleDescriptor,
                                                     @Nullable
                                                     VcsBranch newBranch,
                                                     @NotNull
                                                     BuildConfiguration buildConfiguration,
                                                     PlanCreationService.EnablePlan enablePlan,
                                                     boolean enableExpiry,
                                                     @NotNull
                                                     Consumer<PlanKey> branchPlanKeyConsumer,
                                                     boolean expectingDivergentBranch)
                                              throws PlanCreationDeniedException

Creates a new lightweight plan branch for give chain. Does not check if plan branch for given VCS branch already exists.

Parameters:

chain - to create branches under

planBranchWorkflow - which workflow led to creation of branch

branchName - optional plan branch name

branchDescription - optional plan branch description

defaultRepositoryDefinition - optional default repository of the given chain

moduleDescriptor - module descriptor of the given defaultRepositoryDefinition

newBranch - VCS branch to use

buildConfiguration - optional default fragment of configuration to create the chain branch with

enablePlan - defines whether newly created branches should be enabled or disabled after creation

enableExpiry - defines whether created branch can be removed due to branch expiration detection

branchPlanKeyConsumer - code should be executed before triggering events that new plan created

expectingDivergentBranch - RSS will attempt updating this branch; post creation events should be deferred

Returns:

key of the created plan branch

Throws:

PlanCreationDeniedException

validateCreateChainBranch

void validateCreateChainBranch(@NotNull
                               ImmutableChain chain,
                               @NotNull
                               PlanBranchWorkflow planBranchWorkflow,
                               @NotNull
                               String branchName,
                               @Nullable
                               String branchDescription,
                               @Nullable
                               PlanRepositoryDefinition defaultRepositoryDefinition,
                               @Nullable
                               VcsRepositoryModuleDescriptor moduleDescriptor,
                               @Nullable
                               VcsBranch newBranch,
                               boolean enableExpiry,
                               @NotNull
                               com.atlassian.struts.ValidationAware validationAware)

Validates configuration for creating chain branch

Parameters:

chain - to create branches under

planBranchWorkflow - which workflow led to creation of branch

branchName - optional plan branch name

branchDescription - optional plan branch description

defaultRepositoryDefinition - optional default repository of the given chain

moduleDescriptor - module descriptor of the given defaultRepositoryDefinition

newBranch - VCS branch to use

enableExpiry - defines whether created branch can be removed due to branch expiration * detection

validationAware - to add errors to