com.atlassian.bamboo.chains

Interface BuildContextFactory

All Known Implementing Classes:

BuildContextFactoryImpl

@Internal
public interface BuildContextFactory

Create a BuildContext given the ChainStage and Chain

Method Summary

Modifier and Type	Method and Description
BuildRepositoryChanges	buildChangesUnion(BuildRepositoryChanges a, BuildRepositoryChanges b)
boolean	canRestartOrContinueBuild(ImmutableChain chain, ChainResultsSummary chainResultsSummary, PlanExecutionConfig planExecutionConfig) Checks if build can be continued from a manual stage or restarted, that is, if there are any stages to be run and if all the jobs in those stages still exist.
BuildRepositoryChanges	cloneBuildRepositoryChanges(BuildRepositoryChanges buildRepositoryChanges) Deprecated. since 5.0 use com.atlassian.bamboo.v2.build.BuildRepositoryChangesImpl constructor instead
Map<ImmutableChainStage,Map<ImmutableJob,BuildContext>>	createBuildContextsForJobs(ImmutableChain chain, BuildContext parentBuildContext) Creates a BuildContext for each Job in the Chain
Map<ImmutableChainStage,Map<ImmutableJob,BuildContext>>	createBuildContextsForJobs(ImmutableChain chain, ChainResultsSummary chainResultsSummary, BuildContext parentBuildContext, PlanExecutionConfig planExecutionConfig) Creates a BuildContext for each Job in the Chain
Collection<BuildContext>	createBuildContextsForRestartedOrContinuedBuild(ImmutableChain chain, ChainResultsSummary chainResultsSummary, BuildContext parentBuildContext, PlanExecutionConfig planExecutionConfig) Creates a BuildContext for each not built or failed Job in the Chain that was partially executed or is restarted for example with "continue manual stage" action, or "re-run failed jobs" action, etc
void	updateBuildContextWithChanges(BuildContext contextToUpdate, BuildChanges newBuildChanges) Updates the build context with build changes

Method Detail

createBuildContextsForJobs

@NotNull
Map<ImmutableChainStage,Map<ImmutableJob,BuildContext>> createBuildContextsForJobs(@NotNull
                                                                                            ImmutableChain chain,
                                                                                            @NotNull
                                                                                            BuildContext parentBuildContext)

Creates a BuildContext for each Job in the Chain

Parameters:

chain -

parentBuildContext - - buildContext of the parent chain execution

Returns:

map of Job PlanKeys to their BuildContext

canRestartOrContinueBuild

boolean canRestartOrContinueBuild(@NotNull
                                  ImmutableChain chain,
                                  @NotNull
                                  ChainResultsSummary chainResultsSummary,
                                  @NotNull
                                  PlanExecutionConfig planExecutionConfig)

Checks if build can be continued from a manual stage or restarted, that is, if there are any stages to be run and if all the jobs in those stages still exist.

createBuildContextsForRestartedOrContinuedBuild

@NotNull
Collection<BuildContext> createBuildContextsForRestartedOrContinuedBuild(@NotNull
                                                                                  ImmutableChain chain,
                                                                                  @NotNull
                                                                                  ChainResultsSummary chainResultsSummary,
                                                                                  @NotNull
                                                                                  BuildContext parentBuildContext,
                                                                                  @NotNull
                                                                                  PlanExecutionConfig planExecutionConfig)

Creates a BuildContext for each not built or failed Job in the Chain that was partially executed or is restarted for example with "continue manual stage" action, or "re-run failed jobs" action, etc

Parameters:

chainResultsSummary - - existing ChainResultsSummary for build to continue/restart

parentBuildContext - - Chain BuildContext

planExecutionConfig - - controls build continuation or restart

Returns:

collection of BuildContext to execute

createBuildContextsForJobs

@NotNull
Map<ImmutableChainStage,Map<ImmutableJob,BuildContext>> createBuildContextsForJobs(@NotNull
                                                                                            ImmutableChain chain,
                                                                                            @Nullable
                                                                                            ChainResultsSummary chainResultsSummary,
                                                                                            @NotNull
                                                                                            BuildContext parentBuildContext,
                                                                                            @NotNull
                                                                                            PlanExecutionConfig planExecutionConfig)

Creates a BuildContext for each Job in the Chain

Since:

6.9

cloneBuildRepositoryChanges

@NotNull
 @Deprecated
BuildRepositoryChanges cloneBuildRepositoryChanges(@NotNull
                                                                         BuildRepositoryChanges buildRepositoryChanges)

Deprecated. since 5.0 use com.atlassian.bamboo.v2.build.BuildRepositoryChangesImpl constructor instead

This is not a real clone() operation

Parameters:

buildRepositoryChanges -

Returns:

cloned BuildRepositoryChanges

buildChangesUnion

@NotNull
BuildRepositoryChanges buildChangesUnion(@NotNull
                                                  BuildRepositoryChanges a,
                                                  @NotNull
                                                  BuildRepositoryChanges b)

updateBuildContextWithChanges

void updateBuildContextWithChanges(BuildContext contextToUpdate,
                                   BuildChanges newBuildChanges)

Updates the build context with build changes

Parameters:

contextToUpdate -

newBuildChanges -