Package com.atlassian.bamboo.plan

Interface NonBlockingPlanExecutionService

All Known Implementing Classes:

NonBlockingPlanExecutionServiceImpl

@PublicApi
public interface NonBlockingPlanExecutionService

An alternative to PlanExecutionManager that will run the change detection in the background.

Since:

v4.0

Method Summary

Modifier and Type	Method	Description
void	enqueueTrigger(@NotNull Triggerable triggerable, @NotNull Long triggerId, @NotNull BuildDetectionAction buildDetectionAction)	Submits a background task to run PlanExecutionManager.start(com.atlassian.bamboo.plan.cache.ImmutableChain, com.atlassian.bamboo.build.BuildDetectionAction, com.atlassian.bamboo.util.AcquisitionPolicy).
@NotNull ExecutorStats	getExecutorStats()	Stats for the underlying ThreadPoolExecutor
@NotNull QueueActivityStatsDto	getQueueActivityStatsAndRestoreToInitialState()	Gets analytical data from queue activity tracker and bring its initial state - start data collecting from scratch.
Future<Boolean>	shutdown()	Stop accepting any more trigger requests.
@Nullable Future<ExecutionRequestResult>	tryToStart(@NotNull Triggerable triggerable, @NotNull BuildDetectionAction buildDetectionAction)	Submits a background task to run PlanExecutionManager.start(com.atlassian.bamboo.plan.cache.ImmutableChain, com.atlassian.bamboo.build.BuildDetectionAction, com.atlassian.bamboo.util.AcquisitionPolicy).

Method Details

tryToStart

@Nullable
@Nullable Future<ExecutionRequestResult> tryToStart(@NotNull
 @NotNull Triggerable triggerable,
 @NotNull
 @NotNull BuildDetectionAction buildDetectionAction)

Submits a background task to run PlanExecutionManager.start(com.atlassian.bamboo.plan.cache.ImmutableChain, com.atlassian.bamboo.build.BuildDetectionAction, com.atlassian.bamboo.util.AcquisitionPolicy). The task uses AcquisitionPolicy.WAIT. To be used for triggers that are 'unconditional'. In other words, the method should be used for cases where build absolutely, positively needs to trigger (unless encountering internal error or hitting concurrent build limit)

Parameters:

triggerable -

buildDetectionAction -

Returns:

enqueueTrigger

void enqueueTrigger(@NotNull
 @NotNull Triggerable triggerable,
 @NotNull
 @NotNull Long triggerId,
 @NotNull
 @NotNull BuildDetectionAction buildDetectionAction)

Submits a background task to run PlanExecutionManager.start(com.atlassian.bamboo.plan.cache.ImmutableChain, com.atlassian.bamboo.build.BuildDetectionAction, com.atlassian.bamboo.util.AcquisitionPolicy). Only one AcquisitionPolicy.IMMEDIATE per planKey + triggerId combination will be queued at any point in time. The task are not guaranteed to be run, they might get dropped if tryToStart(Triggerable, BuildDetectionAction) is called. Rationale is: conditional triggers won't start anyway if there's a 'guaranteed' build run.

To be used with automatic triggers: any auto Trigger can have Trigger Conditions defined

Parameters:

triggerable -

buildDetectionAction -

getExecutorStats

@NotNull
@NotNull ExecutorStats getExecutorStats()

Stats for the underlying ThreadPoolExecutor

Returns:

shutdown

Future<Boolean> shutdown()

Stop accepting any more trigger requests.

Since:

5.8

getQueueActivityStatsAndRestoreToInitialState

@Internal
@NotNull
@NotNull QueueActivityStatsDto getQueueActivityStatsAndRestoreToInitialState()

Gets analytical data from queue activity tracker and bring its initial state - start data collecting from scratch.

Returns:

QueueActivityStatsDto with stat amounts

Since:

8.2