com.atlassian.bamboo.chains

Interface ChainExecutionManager

All Superinterfaces:

ChainExecutionAccessor

All Known Implementing Classes:

ChainExecutionManagerImpl

@Internal
public interface ChainExecutionManager
extends ChainExecutionAccessor

Manages the execution of a Chain

Method Summary

Modifier and Type	Method and Description
ChainStateCreationRequestResult	createChainStateNoDetection(ImmutableChain chain, UnconditionalBuildDetectionAction buildDetectionAction) Create a chain state ready for building but dont actually build.
ChainExecutionRequestResult	delayedStart(ImmutableChain chain, UnconditionalBuildDetectionAction buildDetectionAction, ChainState chainState) Starts the Chain if it's been created already
Set<PlanResultKey>	restoreState(Set<PlanResultKey> chainResultsToRestore) Restores state of running chains after server restart.
ChainExecutionRequestResult	start(ImmutableChain chain, ConditionalBuildDetectionAction buildDetectionAction) Starts the Chain
void	stop(PlanKey planKey) Stops all executing instances of the Chain represented by PlanKey
void	stop(PlanResultKey planResultKey) Stops the executing instance of the Chain represented by PlanResultKey

Methods inherited from interface com.atlassian.bamboo.chains.ChainExecutionAccessor

getChainExecution, getExecutingChains, getJobExecution, isActive, isExecuting, isExecuting, logChainExecutionState, numberOfChainsExecuting, numberOfChainsExecuting

Method Detail

start

@NotNull
ChainExecutionRequestResult start(@NotNull
                                           ImmutableChain chain,
                                           @NotNull
                                           ConditionalBuildDetectionAction buildDetectionAction)

Starts the Chain

Parameters:

chain -

buildDetectionAction -

Returns:

success or null if chain execution has not been started

delayedStart

@NotNull
ChainExecutionRequestResult delayedStart(@NotNull
                                                  ImmutableChain chain,
                                                  @NotNull
                                                  UnconditionalBuildDetectionAction buildDetectionAction,
                                                  @NotNull
                                                  ChainState chainState)

Starts the Chain if it's been created already

Parameters:

chain -

buildDetectionAction -

chainState - if already created

Returns:

success or null if chain execution has not been started

createChainStateNoDetection

@NotNull
ChainStateCreationRequestResult createChainStateNoDetection(@NotNull
                                                                     ImmutableChain chain,
                                                                     @NotNull
                                                                     UnconditionalBuildDetectionAction buildDetectionAction)

Create a chain state ready for building but dont actually build.

Parameters:

chain -

buildDetectionAction -

Returns:

stop

void stop(@NotNull
          PlanResultKey planResultKey)

Stops the executing instance of the Chain represented by PlanResultKey

Parameters:

planResultKey -

stop

void stop(@NotNull
          PlanKey planKey)

Stops all executing instances of the Chain represented by PlanKey

Parameters:

planKey -

restoreState

Set<PlanResultKey> restoreState(Set<PlanResultKey> chainResultsToRestore)

Restores state of running chains after server restart.

Parameters:

chainResultsToRestore -

Returns:

keys of jobs that are running according to stored chain states.

Since:

5.8