com.atlassian.bamboo.plan.branch

Interface BranchDetectionService

All Known Implementing Classes:

BranchDetectionServiceImpl

public interface BranchDetectionService

A service for detecting new branches in VCS repositories and creating new branches for a plan. This service is responsible for throttling the detection requests.

Method Summary

Modifier and Type	Method and Description
default PlanKey	createChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, String branchName, VcsBranch vcsBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry) Given a branch name and (optionally) vcs branch name, creates a plan branch, overriding repository definition.
PlanKey	createChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, String branchName, VcsBranch vcsBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry, Consumer<PlanKey> planBranchConsumer) /** Given a branch name and (optionally) vcs branch name, creates a plan branch, overriding repository definition.
PlanKey	createChainBranch(ImmutableChain chain, String branchName, VcsBranch vcsBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry) Given a branch name and (optionally) vcs branch name, create Plan Branches with overriding repository definitions.
PlanKey	createOrEnableChainBranch(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, VcsBranch vcsBranch, BuildConfiguration buildConfiguration, PlanCreationService.EnablePlan enablePlan, boolean enableExpiry, Consumer<PlanKey> planBranchConsumer) Given a branch name and (optionally) vcs branch name, check if branch already exists.
Collection<PlanKey>	createPlanBranches(ImmutableChain chain, Collection<VcsBranch> branches, ErrorCollection errorCollection) Given a list of branch names, create Plan Branches for these, with overriding repository definitions.
Collection<PlanKey>	createPlanBranches(ImmutableChain chain, Collection<VcsBranch> branches, ErrorCollection errorCollection, PlanCreationService.EnablePlan enablePlan) Given a list of branch names, create Plan Branches for these, with overriding repository definitions.
default Collection<PlanKey>	createPlanBranches(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, Collection<VcsBranch> branches, ErrorCollection errorCollection, PlanCreationService.EnablePlan enablePlan) Given a list of branch names, create plan branches for these, with overriding repository definitions.
Collection<PlanKey>	createPlanBranches(ImmutableChain chain, PlanBranchWorkflow planBranchWorkflow, Collection<VcsBranch> branches, ErrorCollection errorCollection, PlanCreationService.EnablePlan enablePlan, Consumer<PlanKey> planBranchConsumer) Given a list of branch names, create plan branches for these, with overriding repository definitions.
void	deleteBambooVcsBranch(Iterable<ImmutableChain> chains, String branchName) Deletes vcs branch from table
void	detectBranchesForChain(ImmutableChain chain) Immediately executes the detection for a given Chain and creates new plan branches if new branches found in the plan's default repository.
void	disableChainBranch(Iterable<ImmutableChain> chains) Disables bamboo branches from given chain branches (or chains if it's default branch).
List<VcsBranch>	getOpenBranches(ImmutableChain chain, ErrorCollection errorCollection) Returns a list of currently open branches for the chain's default repository List ordering determined by underlying repository (preference is for native ordering e.g.
boolean	scheduleBranchDetectionForChain(ImmutableChain chain) Registers branch detection request for a given Chain.
boolean	scheduleBranchListInitialisation(Chain chain) Schedules initialisation of existing vcs branch list.

Method Detail

scheduleBranchDetectionForChain

boolean scheduleBranchDetectionForChain(@NotNull
                                        ImmutableChain chain)

Registers branch detection request for a given Chain. The BranchDetectionService will try to flatten the real branch detection execution density over time.

Parameters:

chain -

Returns:

false if another detection for this chain is already in progress or in queue

scheduleBranchListInitialisation

boolean scheduleBranchListInitialisation(@NotNull
                                         Chain chain)

Schedules initialisation of existing vcs branch list. The next branch detection for the chain will only seek for existing branches but will not create any ChainBranches.

Parameters:

chain -

Returns:

false if another detection for this chain is already in progress or in queue

detectBranchesForChain

void detectBranchesForChain(@NotNull
                            ImmutableChain chain)

Immediately executes the detection for a given Chain and creates new plan branches if new branches found in the plan's default repository. This method blocks until the detection is finished.

Parameters:

chain -

getOpenBranches

@Nullable
List<VcsBranch> getOpenBranches(@NotNull
                                          ImmutableChain chain,
                                          ErrorCollection errorCollection)

Returns a list of currently open branches for the chain's default repository List ordering determined by underlying repository (preference is for native ordering e.g. last updated first for hg)

Parameters:

chain - to find branches for.

errorCollection - to add any errors to during detection

Returns:

a list of currently open branches for the chain's default repository

createPlanBranches

@NotNull
Collection<PlanKey> createPlanBranches(@NotNull
                                                ImmutableChain chain,
                                                @NotNull
                                                Collection<VcsBranch> branches,
                                                @Nullable
                                                ErrorCollection errorCollection)

Given a list of branch names, create Plan Branches for these, with overriding repository definitions. Branches created using this method are excluded from expiration by default.

Parameters:

chain - to create branches under

branches - to create.

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

Returns:

collection of keys of created plans

createPlanBranches

@NotNull
Collection<PlanKey> createPlanBranches(@NotNull
                                                ImmutableChain chain,
                                                @NotNull
                                                Collection<VcsBranch> branches,
                                                @Nullable
                                                ErrorCollection errorCollection,
                                                PlanCreationService.EnablePlan enablePlan)

Given a list of branch names, create Plan Branches for these, with overriding repository definitions. Branches created using this method are excluded from expiration by default.

Parameters:

chain - to create branches under

branches - to create.

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

Returns:

collection of keys of created plans

createPlanBranches

@NotNull
default Collection<PlanKey> createPlanBranches(@NotNull
                                                        ImmutableChain chain,
                                                        @NotNull
                                                        PlanBranchWorkflow planBranchWorkflow,
                                                        @NotNull
                                                        Collection<VcsBranch> branches,
                                                        @Nullable
                                                        ErrorCollection errorCollection,
                                                        @NotNull
                                                        PlanCreationService.EnablePlan enablePlan)

Given a list of branch names, create plan branches for these, with overriding repository definitions. Branches created using this method are excluded from expiration by default.

Parameters:

chain - which chain to create branches under

planBranchWorkflow - which workflow led to creation of these branches

branches - branches to create

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

Returns:

collection of keys of created plans

Since:

6.0

createPlanBranches

@NotNull
Collection<PlanKey> createPlanBranches(@NotNull
                                                ImmutableChain chain,
                                                @NotNull
                                                PlanBranchWorkflow planBranchWorkflow,
                                                @NotNull
                                                Collection<VcsBranch> branches,
                                                @Nullable
                                                ErrorCollection errorCollection,
                                                @NotNull
                                                PlanCreationService.EnablePlan enablePlan,
                                                @NotNull
                                                Consumer<PlanKey> planBranchConsumer)

Given a list of branch names, create plan branches for these, with overriding repository definitions. Branches created using this method are excluded from expiration by default.

Parameters:

chain - which chain to create branches under

planBranchWorkflow - which workflow led to creation of these branches

branches - branches to create

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

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

Returns:

collection of keys of created plans

Since:

6.9

createOrEnableChainBranch

@NotNull
PlanKey createOrEnableChainBranch(@NotNull
                                           ImmutableChain chain,
                                           @NotNull
                                           PlanBranchWorkflow planBranchWorkflow,
                                           @NotNull
                                           VcsBranch vcsBranch,
                                           @Nullable
                                           BuildConfiguration buildConfiguration,
                                           @NotNull
                                           PlanCreationService.EnablePlan enablePlan,
                                           boolean enableExpiry,
                                           Consumer<PlanKey> planBranchConsumer)
                                    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 new plan branch. If branch name conflicts with an existing plan branch, the name will be automatically generated.

Parameters:

chain - to create branches under

vcsBranch - to use when overriding repository definition.

buildConfiguration - - a 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

Returns:

key of the created plan

Throws:

PlanCreationDeniedException

createChainBranch

@NotNull
PlanKey createChainBranch(@NotNull
                                   ImmutableChain chain,
                                   @NotNull
                                   String branchName,
                                   @Nullable
                                   VcsBranch vcsBranch,
                                   @Nullable
                                   BuildConfiguration buildConfiguration,
                                   PlanCreationService.EnablePlan enablePlan,
                                   boolean enableExpiry)
                            throws PlanCreationDeniedException

Given a branch name and (optionally) vcs branch name, create Plan Branches with overriding repository definitions.

Parameters:

chain - to create branches under

branchName - to create.

vcsBranch - to use when overriding repository definition.

buildConfiguration - - a 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

Returns:

key of the created plan

Throws:

PlanCreationException - if validation fails

PlanCreationDeniedException

createChainBranch

@NotNull
default PlanKey createChainBranch(@NotNull
                                           ImmutableChain chain,
                                           @NotNull
                                           PlanBranchWorkflow planBranchWorkflow,
                                           @NotNull
                                           String branchName,
                                           @Nullable
                                           VcsBranch vcsBranch,
                                           @Nullable
                                           BuildConfiguration buildConfiguration,
                                           @NotNull
                                           PlanCreationService.EnablePlan enablePlan,
                                           boolean enableExpiry)
                                    throws PlanCreationDeniedException

Given a branch name and (optionally) vcs branch name, creates a plan branch, overriding repository definition.

Parameters:

chain - chain to create branches under

planBranchWorkflow - which workflow led to creation of this chain branch

branchName - name of plan branch to create

vcsBranch - VCS branch to use when overriding repository definition

buildConfiguration - a 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

Returns:

key of the newly created plan branch

Throws:

PlanCreationDeniedException - if chain branch creation was denied for any reason

Since:

6.0

createChainBranch

PlanKey createChainBranch(@NotNull
                          ImmutableChain chain,
                          @NotNull
                          PlanBranchWorkflow planBranchWorkflow,
                          @NotNull
                          String branchName,
                          @Nullable
                          VcsBranch vcsBranch,
                          @Nullable
                          BuildConfiguration buildConfiguration,
                          @NotNull
                          PlanCreationService.EnablePlan enablePlan,
                          boolean enableExpiry,
                          Consumer<PlanKey> planBranchConsumer)
                   throws PlanCreationDeniedException

/** Given a branch name and (optionally) vcs branch name, creates a plan branch, overriding repository definition.

Parameters:

chain - chain to create branches under

planBranchWorkflow - which workflow led to creation of this chain branch

branchName - name of plan branch to create

vcsBranch - VCS branch to use when overriding repository definition

buildConfiguration - a 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

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

Returns:

key of the newly created plan branch

Throws:

PlanCreationDeniedException - if chain branch creation was denied for any reason

Since:

6.9

deleteBambooVcsBranch

void deleteBambooVcsBranch(@NotNull
                           Iterable<ImmutableChain> chains,
                           @NotNull
                           String branchName)

Deletes vcs branch from table

Parameters:

chains - collection of chains/chain branches to search through

branchName - vcs branch name that was removed

disableChainBranch

void disableChainBranch(@NotNull
                        Iterable<ImmutableChain> chains)

Disables bamboo branches from given chain branches (or chains if it's default branch). Doesn't disable branch if branch is already disabled, marked for deletion or has cleanup disabled. Also doesn't disable branch if SystemProperty.DISABLE_CLOSED_BRANCH_DETECTION property is enabled.

Parameters:

chains - collection of chains/chain branches that should be disabled