PlanExecutionManagerImpl (Atlassian Bamboo 6.5.0 API)

java.lang.Object
- com.atlassian.bamboo.plan.PlanExecutionManagerImpl

All Implemented Interfaces:

ExecutionStatusProvider, PlanExecutionManager
```
public class PlanExecutionManagerImpl
extends Object
implements PlanExecutionManager
```
We have 3 (yes, three) ways to handle BuildDetectionAction, it all depends which interface is implemented:
1. UnconditionalBuildDetectionAction - meaning: if this action is created we know we want to start a build. (example: scheduled build, dependant build...)
2. DelayedChangeDetectionAction - special case of 1) with added feature of calling thread not being blocked by change detection (manual builds, restarted builds...)
3. ConditionalBuildDetectionAction - we don't know a priori if we wan't to start a build (trigger by vcs change)
How do we handle each case (pseudocode):
1. ```
 inChangeDetectionLock
 {
 inBuildCountLock
 {
 checkIfCountNotExceeded
 createResultWithoutChanges
 }
 doChangeDetection
 }
 
```
2. ```
 inBuildCountLock
 {
 checkIfCountNotExceeded
 createResultWithoutChanges;
 inNewThread
 {
 inChangeDetectionLock
 {
 doChangeDetection
 }
 }
 }
 
```
3. ```
 inChangeDetectionLock
 {
 inBuildCountLock
 {
 checkIfCountNotExceeded
 }
 doChangeDetection
 inBuildCountLock
 {
 checkIfCountNotExceeded
 createResultWithChanges
 }
 }
 
```

Constructor Summary

Constructors
Constructor and Description
PlanExecutionManagerImpl(BuildExecutionManager buildExecutionManager, PlanExecutionPermitter planExecutionPermitter, ExecutionStatusProvider executionStatusProvider, PlanManager planManager, StopBuildManager stopBuildManager, TriggerManager triggerManager, PlanExecutionLockService planExecutionLockService, com.atlassian.event.api.EventPublisher eventPublisher, ErrorHandler errorHandler, DeploymentPermitter deploymentPermitter, com.atlassian.bamboo.plan.PlanExecutionManagerCallWatcher planExecutionManagerCallWatcher)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<CurrentlyBuilding>`	`getCurrentlyBuildingForPlan(PlanKey planKey)` Returns all for specified `PlanKey` In case plan is a `Chain` instance, all currently running jobs will be returned
`List<CurrentlyBuilding>`	`getCurrentlyBuildingForPlanResult(PlanResultKey planResultKey)` Returns all `CurrentlyBuilding` for specified `PlanResultKey` In case plan is a `Chain` instance, all currently running jobs will be returned, however, chain itself will be not included in the list (effectively `CurrentlyBuilding` for all chain's children jobs will be returned)
`Collection<? extends ExecutionStatus>`	`getExecutionStatus(PlanKey planKey)` Returns a collection of current `ExecutionStatus`s for `PlanKey`
`ExecutionStatus`	`getExecutionStatus(PlanResultKey planResultKey)` Returns a `ExecutionStatus` for the given `PlanResultKey`
`BuildExecution`	`getJobExecution(PlanResultKey planResultKey)` Get the state of a single Job being executed
`boolean`	`isBuildingAllowed(ImmutableChain chain)` Checks if a particular build is allowed to be built.
`boolean`	`isBusy()`
`boolean`	`isBusy(PlanKey planKey)` Tests if the `Plan` represented by `PlanKey` is busy starting
`int`	`numberOfExecutions(PlanKey planKey)` Returns the number of current `ExecutionStatus`s available for `PlanKey`
`Future<Boolean>`	`shutdown()`
`ExecutionRequestResult`	`start(ImmutableChain chain, BuildDetectionAction buildDetectionAction, AcquisitionPolicy acquisitionPolicy)` Execute the `ImmutableChain` with the provided `BuildDetectionAction` and `AcquisitionPolicy`
`ExecutionRequestResult`	`start(ImmutableChain chain, PlanExecutionConfig planExecutionConfig, String triggerReasonPluginKey, String planTriggerPluginKey, Map<String,String> params, Map<String,String> variables, AcquisitionPolicy acquisitionPolicy)` Execute the provided `Plan` with a custom `TriggerReason`, `PlanTrigger`, parameters and variables
`ExecutionRequestResult`	`start(Triggerable triggerable, BuildDetectionAction buildDetectionAction, AcquisitionPolicy acquisitionPolicy)` Execute the `Triggerable` with the provided `BuildDetectionAction` and `AcquisitionPolicy`
`ExecutionRequestResult`	`startManualExecution(ImmutableChain chain, PlanExecutionConfig planExecutionConfig, com.atlassian.user.User user, Map<String,String> params, Map<String,String> variables)` Attempts to start a manual execution of a given `Plan` controlled by `PlanExecutionConfig` `PlanExecutionConfig` allows to control manual stages execution as well as enforcing execution of manual stages
`ExecutionRequestResult`	`startManualExecution(ImmutableChain chain, PlanExecutionConfig planExecutionConfig, com.atlassian.user.User user, String triggerReasonPluginKey, String planTriggerPluginKey, Map<String,String> params, Map<String,String> variables)` Attempts to start a manual execution of a given `Plan` controlled by `PlanExecutionConfig` `PlanExecutionConfig` allows to control manual stages execution as well as enforcing execution of manual stages
`ExecutionRequestResult`	`startManualExecution(ImmutableChain chain, com.atlassian.user.User user, Map<String,String> params, Map<String,String> variables)` Attempts to start a manual execution of the given `Plan`
`void`	`stopPlan(PlanKey planKey, boolean abandonResult, String userName)`
`void`	`stopPlan(PlanResultKey planResultKey, boolean abandonResult, String userName)`
`void`	`stopRequest(PlanKey planKey)` Stops a build requests for the given `PlanKey`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlanExecutionManagerImpl

public PlanExecutionManagerImpl(BuildExecutionManager buildExecutionManager,
                                PlanExecutionPermitter planExecutionPermitter,
                                ExecutionStatusProvider executionStatusProvider,
                                PlanManager planManager,
                                StopBuildManager stopBuildManager,
                                TriggerManager triggerManager,
                                PlanExecutionLockService planExecutionLockService,
                                com.atlassian.event.api.EventPublisher eventPublisher,
                                ErrorHandler errorHandler,
                                DeploymentPermitter deploymentPermitter,
                                com.atlassian.bamboo.plan.PlanExecutionManagerCallWatcher planExecutionManagerCallWatcher)

Method Detail

numberOfExecutions
```
public int numberOfExecutions(@NotNull
                              PlanKey planKey)
```
Description copied from interface: ExecutionStatusProvider

Returns the number of current ExecutionStatuss available for PlanKey

Specified by:

numberOfExecutions in interface ExecutionStatusProvider

Returns:

noOfExecutions

getExecutionStatus

@NotNull
public Collection<? extends ExecutionStatus> getExecutionStatus(@NotNull
                                                                         PlanKey planKey)

Description copied from interface: ExecutionStatusProvider

Returns a collection of current ExecutionStatuss for PlanKey

Specified by:: getExecutionStatus in interface ExecutionStatusProvider
Returns:: executionStatuses

getExecutionStatus
```
@Nullable
public ExecutionStatus getExecutionStatus(@NotNull
                                                    PlanResultKey planResultKey)
```
Description copied from interface: ExecutionStatusProvider

Returns a ExecutionStatus for the given PlanResultKey

Specified by:

getExecutionStatus in interface ExecutionStatusProvider

Returns:

executionStatus

getJobExecution
```
public BuildExecution getJobExecution(@NotNull
                                      PlanResultKey planResultKey)
```
Description copied from interface: ExecutionStatusProvider

Get the state of a single Job being executed

Specified by:

getJobExecution in interface ExecutionStatusProvider

Returns: