Package com.atlassian.bamboo.chains

Class ChainExecutionManagerImpl

java.lang.Object

com.atlassian.bamboo.chains.ChainExecutionManagerImpl

All Implemented Interfaces:

ChainExecutionAccessor, ChainExecutionManager

public class ChainExecutionManagerImpl
extends Object
implements ChainExecutionManager

This class is registered as event listener postConstruct()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MERGE_DIR

Constructor Summary

Constructors

Constructor

Description

ChainExecutionManagerImpl(PlanStatePersisterService planStatePersisterService, JobExecutionManager buildContextExecutor, ChainStateFactory chainStateFactory, BuildContextFactory buildContextFactory, com.atlassian.event.api.EventPublisher eventPublisher, ChainPluginSupport chainPluginSupport, ErrorUpdateHandler errorUpdateHandler, AuthorCreatorService authorCreatorService, ResultsSummaryManager resultsSummaryManager, BuildDirectoryManager buildDirectoryManager, VcsBranchIntegrationHelper branchIntegrationHelper, CustomVariableContext customVariableContext, PlanExecutionLockService planExecutionLockService, PlanVcsRevisionHistoryService planVcsRevisionHistoryService, CachedPlanManager cachedPlanManager, VcsRepositoryManager vcsRepositoryManager, StorageTagService storageTagService, PlanBranchPullRequestService planBranchPullRequestService, StorageLocationService storageLocationService, ServerBuildLoggerManager buildLoggerManager, DeploymentVersionService deploymentVersionService, ChainStatePersister chainStatePersister, BambooOpenSessionTemplate bambooOpenSessionTemplate)

Method Summary

Modifier and Type	Method	Description
@NotNull ChainStateCreationRequestResult	createChainStateNoDetection(@NotNull ImmutableChain chain, @NotNull UnconditionalBuildDetectionAction buildDetectionAction)	Create a chain state ready for building but dont actually build.
@NotNull ChainExecutionRequestResult	delayedStart(@NotNull ImmutableChain chain, @NotNull UnconditionalBuildDetectionAction buildDetectionAction, @NotNull ChainState chainState)	Starts the Chain if it's been created already
ChainExecutionRequestResult	delayedStart(@NotNull ImmutableChain chain, @NotNull UnconditionalBuildDetectionAction buildDetectionAction, @NotNull ChainState chainState, PlanExecutionLaunchControl.ReleaseLocksActions releaseLocksActions)	Starts the Chain if it's been created already
@Nullable ChainExecution	getChainExecution(@NotNull PlanResultKey planResultKey)	Get the state of the single ChainExecution
@NotNull List<ChainExecution>	getExecutingChains(@NotNull PlanKey planKey)	Get the Collection of the state of the ChainExecution or empty collection when no chain is executing
@NotNull List<ChainExecution>	getFlatExecutingChains(@NotNull PlanKey planKey)	Get the Collection of the state of the ChainExecution or empty collection when no chain is executing.
@Nullable BuildExecution	getJobExecution(@NotNull PlanResultKey planResultKey)	Get the state of a single Job being executed
boolean	isActive(@NotNull PlanKey planKey)	Checks if the Chain is "active" ie being queued, or building
boolean	isExecuting(@NotNull PlanKey planKey)	Checks if the Chain is building
boolean	isExecuting(@NotNull PlanResultKey planResultKey)	Checks of BuildResultsSummary represented by PlanResultKey is currently building (ie started on an agent_
void	logChainExecutionState()	Log active ChainExecutions
int	numberOfChainsExecuting()
int	numberOfChainsExecuting(@NotNull PlanKey planKey)	Determines the number of ChainExecutions are active for the given PlanKey
void	onBuildFinished(BuildFinishedEvent buildFinishedEvent)
void	onChainRemoved(@NotNull ChainDeletedEvent chainDeletedEvent)
void	onChainRemoved(@NotNull MultipleChainsDeletedEvent chainDeletedEvent)
void	onJobSentToAgent(BuildTimingPoints.SentToAgent event)
Set<PlanResultKey>	restoreState(Set<PlanResultKey> chainResultsToRestore, Map<PlanResultKey,BuildResultsSummary> jobsInProgress, ExecutorService executorService)	Restores the state of running chains after server restart on custom-provided executor service.
@NotNull ChainExecutionRequestResult	start(@NotNull ImmutableChain chain, @NotNull ConditionalBuildDetectionAction buildDetectionAction)	Starts the Chain
void	stop(@NotNull PlanKey planKey)	Stops all executing instances of the Chain represented by PlanKey
void	stop(@NotNull PlanResultKey planResultKey)	Stops the executing instance of the Chain represented by PlanResultKey
protected void	useDirectExecutor()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MERGE_DIR

public static final String MERGE_DIR

See Also:

• Constant Field Values

Constructor Details

ChainExecutionManagerImpl

public ChainExecutionManagerImpl(PlanStatePersisterService planStatePersisterService,
 JobExecutionManager buildContextExecutor,
 ChainStateFactory chainStateFactory,
 BuildContextFactory buildContextFactory,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ChainPluginSupport chainPluginSupport,
 ErrorUpdateHandler errorUpdateHandler,
 AuthorCreatorService authorCreatorService,
 ResultsSummaryManager resultsSummaryManager,
 BuildDirectoryManager buildDirectoryManager,
 VcsBranchIntegrationHelper branchIntegrationHelper,
 CustomVariableContext customVariableContext,
 PlanExecutionLockService planExecutionLockService,
 PlanVcsRevisionHistoryService planVcsRevisionHistoryService,
 CachedPlanManager cachedPlanManager,
 VcsRepositoryManager vcsRepositoryManager,
 StorageTagService storageTagService,
 PlanBranchPullRequestService planBranchPullRequestService,
 StorageLocationService storageLocationService,
 ServerBuildLoggerManager buildLoggerManager,
 DeploymentVersionService deploymentVersionService,
 ChainStatePersister chainStatePersister,
 BambooOpenSessionTemplate bambooOpenSessionTemplate)

Method Details

start

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

Description copied from interface: ChainExecutionManager

Starts the Chain

Specified by:

start in interface ChainExecutionManager

Parameters:

chain -

buildDetectionAction -

Returns:

success or null if chain execution has not been started

delayedStart

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

Description copied from interface: ChainExecutionManager

Starts the Chain if it's been created already

Specified by:

delayedStart in interface ChainExecutionManager

Parameters:

chain -

buildDetectionAction -

chainState - if already created

Returns:

success or null if chain execution has not been started

delayedStart

public ChainExecutionRequestResult delayedStart(@NotNull
 @NotNull ImmutableChain chain,
 @NotNull
 @NotNull UnconditionalBuildDetectionAction buildDetectionAction,
 @NotNull
 @NotNull ChainState chainState,
 @NotNull
 PlanExecutionLaunchControl.ReleaseLocksActions releaseLocksActions)

Description copied from interface: ChainExecutionManager

Starts the Chain if it's been created already

Specified by:

delayedStart in interface ChainExecutionManager

Parameters:

chain -

buildDetectionAction -

chainState - if already created

releaseLocksActions - actions used for releasing repositories caches locks

Returns:

success or null if chain execution has not been started since 9.3

onChainRemoved

@EventListener
public void onChainRemoved(@NotNull
 @NotNull ChainDeletedEvent chainDeletedEvent)

onChainRemoved

@EventListener
public void onChainRemoved(@NotNull
 @NotNull MultipleChainsDeletedEvent chainDeletedEvent)

onJobSentToAgent

@EventListener
public void onJobSentToAgent(@NotNull
 BuildTimingPoints.SentToAgent event)

onBuildFinished

@EventListener
public void onBuildFinished(BuildFinishedEvent buildFinishedEvent)

createChainStateNoDetection

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

Description copied from interface: ChainExecutionManager

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

Specified by:

createChainStateNoDetection in interface ChainExecutionManager

Parameters:

chain -

buildDetectionAction -

Returns:

stop

public void stop(@NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: ChainExecutionManager

Stops the executing instance of the Chain represented by PlanResultKey

Specified by:

stop in interface ChainExecutionManager

Parameters:

planResultKey -

stop

public void stop(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionManager

Stops all executing instances of the Chain represented by PlanKey

Specified by:

stop in interface ChainExecutionManager

Parameters:

planKey -

isActive

public boolean isActive(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionAccessor

Checks if the Chain is "active" ie being queued, or building

Specified by:

isActive in interface ChainExecutionAccessor

Parameters:

planKey -

Returns:

active

isExecuting

public boolean isExecuting(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionAccessor

Checks if the Chain is building

Specified by:

isExecuting in interface ChainExecutionAccessor

Parameters:

planKey -

Returns:

running

isExecuting

public boolean isExecuting(@NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: ChainExecutionAccessor

Checks of BuildResultsSummary represented by PlanResultKey is currently building (ie started on an agent_

Specified by:

isExecuting in interface ChainExecutionAccessor

Parameters:

planResultKey -

Returns:

executing

getExecutingChains

@NotNull
public @NotNull List<ChainExecution> getExecutingChains(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionAccessor

Get the Collection of the state of the ChainExecution or empty collection when no chain is executing

Specified by:

getExecutingChains in interface ChainExecutionAccessor

Parameters:

planKey -

Returns:

list of chain executions

getFlatExecutingChains

@NotNull
public @NotNull List<ChainExecution> getFlatExecutingChains(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionAccessor

Get the Collection of the state of the ChainExecution or empty collection when no chain is executing. Flat means no stages or jobs data is included.

Specified by:

getFlatExecutingChains in interface ChainExecutionAccessor

Parameters:

planKey - plan key

Returns:

list of flat chain executions

getChainExecution

@Nullable
public @Nullable ChainExecution getChainExecution(@NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: ChainExecutionAccessor

Get the state of the single ChainExecution

Specified by:

getChainExecution in interface ChainExecutionAccessor

Parameters:

planResultKey -

Returns:

getJobExecution

@Nullable
public @Nullable BuildExecution getJobExecution(@NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: ChainExecutionAccessor

Get the state of a single Job being executed

Specified by:

getJobExecution in interface ChainExecutionAccessor

Parameters:

planResultKey -

Returns:

numberOfChainsExecuting

public int numberOfChainsExecuting(@NotNull
 @NotNull PlanKey planKey)

Description copied from interface: ChainExecutionAccessor

Determines the number of ChainExecutions are active for the given PlanKey

Specified by:

numberOfChainsExecuting in interface ChainExecutionAccessor

Parameters:

planKey -

Returns:

logChainExecutionState

public void logChainExecutionState()

Description copied from interface: ChainExecutionAccessor

Log active ChainExecutions

Specified by:

logChainExecutionState in interface ChainExecutionAccessor

numberOfChainsExecuting

public int numberOfChainsExecuting()

Specified by:

numberOfChainsExecuting in interface ChainExecutionAccessor

Returns:

total number of active ChainExecutions

restoreState

public Set<PlanResultKey> restoreState(Set<PlanResultKey> chainResultsToRestore,
 Map<PlanResultKey,BuildResultsSummary> jobsInProgress,
 ExecutorService executorService)
                                throws ExecutionException,
InterruptedException

Description copied from interface: ChainExecutionManager

Restores the state of running chains after server restart on custom-provided executor service.

Specified by:

restoreState in interface ChainExecutionManager

Returns:

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

Throws:

ExecutionException

InterruptedException

useDirectExecutor

protected void useDirectExecutor()