Package com.atlassian.bamboo.chains

Interface ChainExecutionAccessor

All Known Subinterfaces:

ChainExecutionManager

All Known Implementing Classes:

ChainExecutionManagerImpl

public interface ChainExecutionAccessor

Provides read only access to ChainExecution

Since:

5.14

Method Summary

Modifier and Type	Method	Description
@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
@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

Method Detail

isActive

boolean isActive(@NotNull
                 @NotNull PlanKey planKey)

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

Parameters:

planKey -

Returns:

active

isExecuting

boolean isExecuting(@NotNull
                    @NotNull PlanKey planKey)

Checks if the Chain is building

Parameters:

planKey -

Returns:

running

isExecuting

boolean isExecuting(@NotNull
                    @NotNull PlanResultKey planResultKey)

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

Parameters:

planResultKey -

Returns:

executing

getExecutingChains

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

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

Parameters:

planKey -

Returns:

chainExecution

getChainExecution

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

Get the state of the single ChainExecution

Parameters:

planResultKey -

Returns:

getJobExecution

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

Get the state of a single Job being executed

Parameters:

planResultKey -

Returns:

numberOfChainsExecuting

int numberOfChainsExecuting(@NotNull
                            @NotNull PlanKey planKey)

Determines the number of ChainExecutions are active for the given PlanKey

Parameters:

planKey -

Returns:

numberOfChainsExecuting

int numberOfChainsExecuting()

Returns:

total number of active ChainExecutions

logChainExecutionState

void logChainExecutionState()

Log active ChainExecutions