com.atlassian.bamboo.plan
Class PlanExecutionManagerImpl

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

All Implemented Interfaces:

ExecutionStatusProvider, PlanExecutionManager

public class PlanExecutionManagerImpl
extends java.lang.Object
implements PlanExecutionManager

Constructor Summary

PlanExecutionManagerImpl(BuildExecutionManager buildExecutionManager, ChainExecutionManager chainExecutionManager, BuildDetectionActionFactory buildDetectionActionFactory, PlanExecutionPermitter planExecutionPermitter, ExecutionStatusProvider executionStatusProvider, PlanManager planManager, StopBuildManager stopBuildManager, TriggerManager triggerManager)

Method Summary

java.util.List<CurrentlyBuilding>	getCurrentlyBuildingForPlan(PlanKey planKey) Returns all for specified PlanKey In case plan is a Chain instance, all currently running jobs will be returned
java.util.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)
java.util.Collection<? extends ExecutionStatus>	getExecutionStatus(PlanKey planKey) Returns a collection of current ExecutionStatuss 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(Plan plan) Checks if a particular build is allowed to be built.
boolean	isBusy(PlanKey planKey) Tests if the Plan represented by PlanKey is busy starting
int	numberOfExecutions(PlanKey planKey) Returns the number of current ExecutionStatuss available for PlanKey
ExecutionRequestResult	start(Plan plan, BuildDetectionAction buildDetectionAction, AcquisitionPolicy acquisitionPolicy) Execute the Plan with the provided BuildDetectionAction and AcquisitionPolicy Calls to this method will acquire a lock according to the AcquisitionPolicy on a per Plan granularity
ExecutionRequestResult	start(Plan plan, PlanExecutionConfig planExecutionConfig, java.lang.String triggerReasonPluginKey, java.lang.String planTriggerPluginKey, java.util.Map<java.lang.String,java.lang.String> params, java.util.Map<java.lang.String,java.lang.String> variables, AcquisitionPolicy acquisitionPolicy) Execute the provided Plan with a custom TriggerReason, PlanTrigger, parameters and variables
ExecutionRequestResult	startManualExecution(Plan plan, PlanExecutionConfig planExecutionConfig, com.atlassian.user.User user, java.util.Map<java.lang.String,java.lang.String> params, java.util.Map<java.lang.String,java.lang.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(Plan plan, com.atlassian.user.User user) Attempts to start a manual execution of the given Plan
ExecutionRequestResult	startManualExecution(Plan plan, com.atlassian.user.User user, java.util.Map<java.lang.String,java.lang.String> params, java.util.Map<java.lang.String,java.lang.String> variables) Attempts to start a manual execution of the given Plan
void	stopPlan(PlanKey planKey, boolean abandonResult, java.lang.String userName)
void	stopPlan(PlanResultKey planResultKey, boolean abandonResult, java.lang.String userName)

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,
                                ChainExecutionManager chainExecutionManager,
                                BuildDetectionActionFactory buildDetectionActionFactory,
                                PlanExecutionPermitter planExecutionPermitter,
                                ExecutionStatusProvider executionStatusProvider,
                                PlanManager planManager,
                                StopBuildManager stopBuildManager,
                                TriggerManager triggerManager)

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 java.util.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:

startManualExecution

@NotNull
public ExecutionRequestResult startManualExecution(@NotNull
                                                           Plan plan,
                                                           @NotNull
                                                           com.atlassian.user.User user)

Description copied from interface: PlanExecutionManager

Attempts to start a manual execution of the given Plan

Specified by:

startManualExecution in interface PlanExecutionManager

Returns:

executionRequestResult

startManualExecution

public ExecutionRequestResult startManualExecution(@NotNull
                                                   Plan plan,
                                                   @NotNull
                                                   com.atlassian.user.User user,
                                                   @NotNull
                                                   java.util.Map<java.lang.String,java.lang.String> params,
                                                   @NotNull
                                                   java.util.Map<java.lang.String,java.lang.String> variables)

Description copied from interface: PlanExecutionManager

Attempts to start a manual execution of the given Plan

Specified by:

startManualExecution in interface PlanExecutionManager

params - - additional execution parameters set in code to parametrized build - not exposed to user

variables - - user defined variables that could be parametrized in manual execution - contain only values changed by user in UI

Returns:

executionRequestResult

startManualExecution

@NotNull
public ExecutionRequestResult startManualExecution(@NotNull
                                                           Plan plan,
                                                           @Nullable
                                                           PlanExecutionConfig planExecutionConfig,
                                                           @NotNull
                                                           com.atlassian.user.User user,
                                                           @NotNull
                                                           java.util.Map<java.lang.String,java.lang.String> params,
                                                           @NotNull
                                                           java.util.Map<java.lang.String,java.lang.String> variables)

Description copied from interface: PlanExecutionManager

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

Specified by:

startManualExecution in interface PlanExecutionManager

Returns:

isBusy

public boolean isBusy(@NotNull
                      PlanKey planKey)

Description copied from interface: PlanExecutionManager

Tests if the Plan represented by PlanKey is busy starting

Specified by:

isBusy in interface PlanExecutionManager

Returns:

busy

start

@NotNull
public ExecutionRequestResult start(@NotNull
                                            Plan plan,
                                            @Nullable
                                            PlanExecutionConfig planExecutionConfig,
                                            @NotNull
                                            java.lang.String triggerReasonPluginKey,
                                            @NotNull
                                            java.lang.String planTriggerPluginKey,
                                            @NotNull
                                            java.util.Map<java.lang.String,java.lang.String> params,
                                            @NotNull
                                            java.util.Map<java.lang.String,java.lang.String> variables,
                                            @NotNull
                                            AcquisitionPolicy acquisitionPolicy)

Description copied from interface: PlanExecutionManager

Execute the provided Plan with a custom TriggerReason, PlanTrigger, parameters and variables

Specified by:

start in interface PlanExecutionManager

Parameters:

plan - to execute

planExecutionConfig - extended configuration for execution

triggerReasonPluginKey - full plugin key for a TriggerReason

planTriggerPluginKey - full plugin key for a PlanTrigger

params - custom params

variables - overriden variables

acquisitionPolicy - to aquire the lock

Returns:

planExecutionResult

start

@NotNull
public ExecutionRequestResult start(@NotNull
                                            Plan plan,
                                            @NotNull
                                            BuildDetectionAction buildDetectionAction,
                                            @NotNull
                                            AcquisitionPolicy acquisitionPolicy)

Description copied from interface: PlanExecutionManager

Execute the Plan with the provided BuildDetectionAction and AcquisitionPolicy

Calls to this method will acquire a lock according to the AcquisitionPolicy on a per Plan granularity

Specified by:

start in interface PlanExecutionManager

Returns:

planExecutionResult

isBuildingAllowed

public boolean isBuildingAllowed(@NotNull
                                 Plan plan)

Description copied from interface: PlanExecutionManager

Checks if a particular build is allowed to be built. It checks if it exists, not suspened, and that there is no global flag that has stopped building

Specified by:

isBuildingAllowed in interface PlanExecutionManager

Returns:

true if plan is allowed to be built

getCurrentlyBuildingForPlan

@NotNull
public java.util.List<CurrentlyBuilding> getCurrentlyBuildingForPlan(PlanKey planKey)

Description copied from interface: PlanExecutionManager

Returns all for specified PlanKey In case plan is a Chain instance, all currently running jobs will be returned

Specified by:

getCurrentlyBuildingForPlan in interface PlanExecutionManager

Returns:

getCurrentlyBuildingForPlanResult

@NotNull
public java.util.List<CurrentlyBuilding> getCurrentlyBuildingForPlanResult(PlanResultKey planResultKey)

Description copied from interface: PlanExecutionManager

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)

Specified by:

getCurrentlyBuildingForPlanResult in interface PlanExecutionManager

Returns:

stopPlan

public void stopPlan(@NotNull
                     PlanResultKey planResultKey,
                     boolean abandonResult,
                     java.lang.String userName)

Specified by:

stopPlan in interface PlanExecutionManager

stopPlan

public void stopPlan(@NotNull
                     PlanKey planKey,
                     boolean abandonResult,
                     java.lang.String userName)
              throws java.lang.InterruptedException

Specified by:

stopPlan in interface PlanExecutionManager

Throws:

java.lang.InterruptedException