Package com.atlassian.bamboo.build

Interface BuildDefinitionManager

All Known Implementing Classes:

DefaultBuildDefinitionManager, DefaultBuildDefinitionManagerTx

@ThreadSafe
public interface BuildDefinitionManager

A manager for stateful BuildDefinition.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BuildDefinitionManager.BuildDefinitionNotFoundException

Method Summary

Modifier and Type	Method	Description
@NotNull BuildDefinition	getBuildDefinition(@NotNull Plan plan)
@NotNull BuildDefinition	getBuildDefinition(@NotNull PlanKey planKey)	Returns a stateful version the build definition for the Plan.
@NotNull BuildDefinition	getBuildDefinition(@NotNull Pair<EnrichedPlanDto,ImmutablePlan> dtoWithImmutableEntity, @Nullable Pair<EnrichedPlanDto,ImmutablePlan> masterDtoWithImmutableEntity)
BuildDefinition	getUnmergedBuildDefinition(@NotNull Plan plan)	Returns a stateful version the build definition for the Plan.
BuildDefinition	getUnmergedBuildDefinition(@NotNull PlanKey planKey)	Returns a stateful version the build definition for the Plan.
void	savePlanAndDefinition(Plan plan)	Deprecated. since 5.0 use PlanManager.savePlanWithSchedulesStopped(com.atlassian.bamboo.plan.Plan)
void	savePlanAndDefinition(Plan plan, BuildDefinition buildDefinition)	Convert and save the build definition.
void	savePlanAndDefinition(Plan plan, BuildDefinition buildDefinition, boolean withQuartzJobsRestart)	Convert and save the build definition.
void	savePlanAndDefinition(Plan plan, BuildConfiguration buildConfiguration)	Saves the Plan and the BuildConfiguration

Method Detail

getBuildDefinition

@NotNull
@NotNull BuildDefinition getBuildDefinition(@NotNull
                                            @NotNull PlanKey planKey)

Returns a stateful version the build definition for the Plan. This means that when you set various flags on it, the flags won't be lost (unless you updated your BuildDefinition. In case of PlanBranches, it will return BuildDefinition merged with Master plan.

Parameters:

planKey -

Returns:

A populated BuildDefinition object.

getUnmergedBuildDefinition

BuildDefinition getUnmergedBuildDefinition(@NotNull
                                           @NotNull Plan plan)

Returns a stateful version the build definition for the Plan. This means that when you set various flags on it, the flags won't be lost (unless you updated your BuildDefinition. In case of PlanBranches, it will return BuildDefinition specific to a given PlanBranch.

Parameters:

plan -

Returns:

A populated BuildDefinition object.

Since:

9.3

getUnmergedBuildDefinition

BuildDefinition getUnmergedBuildDefinition(@NotNull
                                           @NotNull PlanKey planKey)

Returns a stateful version the build definition for the Plan. This means that when you set various flags on it, the flags won't be lost (unless you updated your BuildDefinition. In case of PlanBranches, it will return BuildDefinition specific to a given PlanBranch. Note: for better performance, consider using getUnmergedBuildDefinition(Plan) instead.

Parameters:

planKey -

Returns:

A populated BuildDefinition object.

savePlanAndDefinition

@Deprecated
void savePlanAndDefinition(Plan plan)

Deprecated.

since 5.0 use PlanManager.savePlanWithSchedulesStopped(com.atlassian.bamboo.plan.Plan)

Saves the Plan while polling jobs are stopped.

Parameters:

plan -

savePlanAndDefinition

void savePlanAndDefinition(Plan plan,
                           BuildConfiguration buildConfiguration)

Saves the Plan and the BuildConfiguration

Parameters:

plan -

buildConfiguration -

savePlanAndDefinition

void savePlanAndDefinition(Plan plan,
                           BuildDefinition buildDefinition)

Convert and save the build definition.

Parameters:

plan -

buildDefinition -

savePlanAndDefinition

void savePlanAndDefinition(Plan plan,
                           BuildDefinition buildDefinition,
                           boolean withQuartzJobsRestart)

Convert and save the build definition. To be used during plan creation only.

Parameters:

plan -

buildDefinition -

withQuartzJobsRestart - indicates if relevant polling jobs should be reinitialised

Since:

4.3

getBuildDefinition

@NotNull
@NotNull BuildDefinition getBuildDefinition(@NotNull
                                            @NotNull Plan plan)

getBuildDefinition

@NotNull
@NotNull BuildDefinition getBuildDefinition(@NotNull
                                            @NotNull Pair<EnrichedPlanDto,ImmutablePlan> dtoWithImmutableEntity,
                                            @Nullable
                                            @Nullable Pair<EnrichedPlanDto,ImmutablePlan> masterDtoWithImmutableEntity)