com.atlassian.bamboo.chains
Interface ChainExecutionManager

All Superinterfaces:

ChainExecutionUpdateManager

All Known Implementing Classes:

ChainExecutionManagerImpl

public interface ChainExecutionManager
extends ChainExecutionUpdateManager

Manages the execution of a Chain

Method Summary

ChainExecution	getChainExecution(PlanResultKey planResultKey) Get the state of the single ChainExecution
java.util.List<ChainExecution>	getExecutingChains(PlanKey planKey) Get the Collection of the state of the ChainExecution or empty collection when no chain is executing
BuildExecution	getJobExecution(PlanResultKey planResultKey) Get the state of a single Job being executed
boolean	isActive(PlanKey planKey) Checks if the Chain represented by PlanKey has any executions
boolean	isExecuting(PlanKey planKey) Checks if the Chain represented by PlanKey has any executions that are currently in progress
boolean	isExecuting(PlanResultKey planResultKey) Checks of the Chain represented by PlanResultKey is executed
int	numberOfChainsExecuting(PlanKey planKey) Determines the number of ChainExecutions are active for the given PlanKey
ChainExecutionRequestResult	start(Chain chain, BuildDetectionAction 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.ChainExecutionUpdateManager

handleJobStarted

Method Detail

start

@NotNull
ChainExecutionRequestResult start(@NotNull
                                          Chain chain,
                                          @NotNull
                                          BuildDetectionAction buildDetectionAction)

Starts the Chain

Parameters:

chain -

buildDetectionAction -

Returns:

success or null if chain execution has not been started

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 -

isActive

boolean isActive(@NotNull
                 PlanKey planKey)

Checks if the Chain represented by PlanKey has any executions

Parameters:

planKey -

Returns:

active

isExecuting

boolean isExecuting(@NotNull
                    PlanKey planKey)

Checks if the Chain represented by PlanKey has any executions that are currently in progress

Parameters:

planKey -

Returns:

running

isExecuting

boolean isExecuting(@NotNull
                    PlanResultKey planResultKey)

Checks of the Chain represented by PlanResultKey is executed

Parameters:

planResultKey -

Returns:

executing

getExecutingChains

@NotNull
java.util.List<ChainExecution> getExecutingChains(@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
ChainExecution getChainExecution(@NotNull
                                          PlanResultKey planResultKey)

Get the state of the single ChainExecution

Parameters:

planResultKey -

Returns:

getJobExecution

@Nullable
BuildExecution getJobExecution(@NotNull
                                        PlanResultKey planResultKey)

Get the state of a single Job being executed

Parameters:

planResultKey -

Returns:

numberOfChainsExecuting

int numberOfChainsExecuting(@NotNull
                            PlanKey planKey)

Determines the number of ChainExecutions are active for the given PlanKey

Parameters:

planKey -

Returns: