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
Modifier and TypeInterfaceDescriptionstatic class
-
Method Summary
Modifier and TypeMethodDescription@NotNull BuildDefinition
getBuildDefinition
(@NotNull Plan plan) @NotNull BuildDefinition
getBuildDefinition
(@NotNull PlanKey planKey) Returns a stateful version the build definition for thePlan
.@NotNull BuildDefinition
getBuildDefinition
(@NotNull Pair<EnrichedPlanDto, ImmutablePlan> dtoWithImmutableEntity, @Nullable Pair<EnrichedPlanDto, ImmutablePlan> masterDtoWithImmutableEntity) getUnmergedBuildDefinition
(@NotNull Plan plan) Returns a stateful version the build definition for thePlan
.getUnmergedBuildDefinition
(@NotNull PlanKey planKey) Returns a stateful version the build definition for thePlan
.void
savePlanAndDefinition
(Plan plan) Deprecated.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 thePlan
and theBuildConfiguration
-
Method Details
-
getBuildDefinition
Returns a stateful version the build definition for thePlan
. This means that when you set various flags on it, the flags won't be lost (unless you updated yourBuildDefinition
. In case of PlanBranches, it will return BuildDefinition merged with Master plan.- Parameters:
planKey
-- Returns:
- A populated
BuildDefinition
object.
-
getUnmergedBuildDefinition
Returns a stateful version the build definition for thePlan
. This means that when you set various flags on it, the flags won't be lost (unless you updated yourBuildDefinition
. In case of PlanBranches, it will return BuildDefinition specific to a given PlanBranch.- Parameters:
plan
-- Returns:
- A populated
BuildDefinition
object. - Since:
- 9.3
-
getUnmergedBuildDefinition
Returns a stateful version the build definition for thePlan
. This means that when you set various flags on it, the flags won't be lost (unless you updated yourBuildDefinition
. In case of PlanBranches, it will return BuildDefinition specific to a given PlanBranch. Note: for better performance, consider usinggetUnmergedBuildDefinition(Plan)
instead.- Parameters:
planKey
-- Returns:
- A populated
BuildDefinition
object.
-
savePlanAndDefinition
Deprecated.Saves thePlan
while polling jobs are stopped.- Parameters:
plan
-
-
savePlanAndDefinition
Saves thePlan
and theBuildConfiguration
- Parameters:
plan
-buildConfiguration
-
-
savePlanAndDefinition
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
-
getBuildDefinition
@NotNull @NotNull BuildDefinition getBuildDefinition(@NotNull @NotNull Pair<EnrichedPlanDto, ImmutablePlan> dtoWithImmutableEntity, @Nullable @Nullable Pair<EnrichedPlanDto, ImmutablePlan> masterDtoWithImmutableEntity)
-
PlanManager.savePlanWithSchedulesStopped(com.atlassian.bamboo.plan.Plan)