com.atlassian.bamboo.build
Interface StopBuildManager

All Known Implementing Classes:

DefaultStopBuildManager

public interface StopBuildManager

Method Summary

void	cancelAllBuilds(PlanKey planKey, boolean abandonResult) Will stop all builds running for plan identified by PlanKey
void	cancelAllBuilds(java.lang.String planKey, boolean abandonResult) Deprecated. since 2.7 use cancelAllBuilds(PlanKey, boolean)
void	cancelBuild(PlanResultKey planResultKey, boolean abandonResult) Cancel a running build optionally abandoning the result
void	cancelBuild(java.lang.String buildResultKey, boolean abandonResult) Deprecated. since 2.7 use cancelBuild(PlanResultKey, boolean)
void	stopAgentNicely(BuildAgent buildAgent) Will tell an agent to stop after it's finished the current build

Method Detail

cancelBuild

@Deprecated
void cancelBuild(@NotNull
                            java.lang.String buildResultKey,
                            boolean abandonResult)
                 throws java.lang.InterruptedException

Deprecated. since 2.7 use cancelBuild(PlanResultKey, boolean)

Cancel a running build optionally abandoning the result

Parameters:

buildResultKey -

abandonResult -

Throws:

java.lang.InterruptedException

cancelBuild

void cancelBuild(@NotNull
                 PlanResultKey planResultKey,
                 boolean abandonResult)

Cancel a running build optionally abandoning the result

Parameters:

planResultKey -

abandonResult -

Throws:

java.lang.InterruptedException

stopAgentNicely

void stopAgentNicely(@NotNull
                     BuildAgent buildAgent)

Will tell an agent to stop after it's finished the current build

Parameters:

buildAgent -

cancelAllBuilds

@Deprecated
void cancelAllBuilds(@NotNull
                                java.lang.String planKey,
                                boolean abandonResult)
                     throws java.lang.InterruptedException

Deprecated. since 2.7 use cancelAllBuilds(PlanKey, boolean)

Will stop all builds running for plan identified by planKey

Parameters:

planKey -

abandonResult -

Throws:

java.lang.InterruptedException

cancelAllBuilds

void cancelAllBuilds(@NotNull
                     PlanKey planKey,
                     boolean abandonResult)
                     throws java.lang.InterruptedException

Will stop all builds running for plan identified by PlanKey

Parameters:

planKey -

abandonResult -

Throws:

java.lang.InterruptedException