Package com.atlassian.bamboo.buildqueue

Class StopPlan

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.bamboo.ww2.BambooActionSupport

com.atlassian.bamboo.ww2.actions.PlanActionSupport

com.atlassian.bamboo.buildqueue.StopPlan

All Implemented Interfaces:

JsonStreamingAction, ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, PlanExecuteSecurityAware, PlanAware, ProjectAware, ReturnUrlAware, com.atlassian.core.i18n.I18nTextProvider, com.atlassian.struts.TextProvider, com.atlassian.struts.ValidationAware, com.opensymphony.xwork.ValidationAware, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.interceptor.ValidationAware, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, Serializable

public class StopPlan
extends PlanActionSupport
implements PlanExecuteSecurityAware

This class provides a user action to stop the current build job

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

BambooActionSupport.JSONStatus

Field Summary

Fields inherited from class com.atlassian.bamboo.ww2.actions.PlanActionSupport

buildNumber, jiraApplinksService, repositoryDefinitionManager, resultsSummaryManager, vcsRepositoryConfigurationService

Fields inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

ACCESS_DENIED, administrationConfigurationAccessor, administrationConfigurationManager, administrationConfigurationPersister, AGGREGATE_URL_PATTERN, authenticationContext, bambooPermissionManager, bambooUserManager, BUILD_KEY_CONTEXT, buildDefinitionManager, cachedPlanManager, CONFIRM, cookieCutter, deploymentProjectService, featureManager, PAGE_NOT_FOUND, PLAN_KEY_CONTEXT, planExecutionManager, planManager, pluginAccessor, projectManager, webInterfaceManager

Fields inherited from class com.opensymphony.xwork2.ActionSupport

container

Fields inherited from interface com.opensymphony.xwork2.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
StopPlan()

Method Summary

Modifier and Type	Method	Description
String	execute()	Stop the current build
boolean	isAbandonResult()
void	setAbandonResult(boolean abandonResult)

Methods inherited from class com.atlassian.bamboo.ww2.actions.PlanActionSupport

buildWebPanelContext, getBuildKey, getBuildNumber, getCurrentlyBuildingPlans, getErrorAccessor, getFirstNotRunnableStage, getImmutablePlan, getJobsWebItemsForSection, getMutablePlan, getPlan, getPlanKey, getPlanResultKey, getProject, getResultsSummaryManager, getSecuredDomainObject, getTypedPlanKey, getTypedPlanResultKey, isContinuable, isJiraApplicationLinkDefined, isRestartable, planNotFound, setBuildContextFactory, setBuildKey, setBuildNumber, setDecoratingErrorAccessor, setJiraApplinksService, setPlan, setPlanExecutionManager, setPlanKey, setPlanResultKey, setRepositoryDefinitionManager, setResultsSummaryManager, setVcsRepositoryConfigurationService

Methods inherited from class com.atlassian.bamboo.ww2.BambooActionSupport

addActionError, addActionError, addActionWarning, addError, addError, addErrorCollection, addErrorMessage, addErrorMessage, addErrorMessages, addFieldErrors, addHelpPanel, addIllegalArgumentException, areCheckBoxesEmpty, buildJsonObject, canRunBuild, checkFieldXssSafety, createFieldValidator, doDefault, doesHelpLinkHaveMatchingTitle, doesLabelKeyHaveMatchingDescription, doExecute, doInput, forceRelativeReturnUrl, getActionWarnings, getAdministrationConfiguration, getAvailableCategoryJson, getBamboo, getBambooLicenseManager, getBambooPermissionManager, getBambooSession, getBambooUrl, getBambooUserManager, getBaseUrl, getBestBaseUrl, getBootstrapManager, getBreadCrumbs, getChainEquiv, getConcurrentBuildExecutionStrategyOptions, getConcurrentBuildsEnabled, getConglomerateCookieValue, getCookieCutter, getCookieValue, getCurrentFormTheme, getCurrentSystemTime, getCurrentUrl, getDefaultPersister, getDescriptionFromLabelKey, getElasticConfig, getErrorMessages, getErrors, getFeatureManager, getFieldErrorAccessTracker, getFieldErrors, getFlushedErrorMessages, getFormattedActionErrors, getFormattedActionMessages, getFormattedActionWarnings, getHelpPanels, getInstanceName, getJobEquiv, getJsonObject, getNavigationContext, getNavigationUrl, getNodeLifecycleState, getNumberOfCurrentlyBuildingPlans, getPlan, getPlanManager, getPluginAccessor, getRandomString, getReturnUrl, getSessionUser, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextProvider, getTexts, getTexts, getTextWithArgs, getTotalErrors, getUser, getValidatorContext, getWebFragmentsContextMap, getWebItemsForSection, getWebPanelContext, getWebSectionsForLocation, hasActionWarnings, hasAdminPermission, hasAnyErrors, hasBuilds, hasEntityPermission, hasGlobalAdminPermission, hasGlobalPermission, hasGlobalPermission, hasKey, hasPlanPermission, hasPlanPermission, hasProjectPermission, hasProjectPermission, hasRestrictedAdminPermission, hasResultKeyReadPermission, isCheckboxSetInAction, isEnableJavascript, isEnableSignup, isInlineDialog, isRestrictedAdminEnabled, isSelectFieldAndNull, isViewContactDetailsEnabled, renderFreemarkerTemplate, setAdministrationConfigurationAccessor, setAdministrationConfigurationManager, setAdministrationConfigurationPersister, setAuthenticationContext, setBambooLicenseManager, setBambooPermissionManager, setBambooUserManager, setBuildDefinitionManager, setCachedPlanManager, setChainEquiv, setCheckBoxFields, setCookieCutter, setCurrentFormTheme, setDecorator, setDeploymentProjectService, setDocumentationLinkProvider, setEnableJavascript, setEnvironmentService, setErrorMessages, setFeatureManager, setI18nBeanFactory, setJobEquiv, setJsonator, setLocalizedTextProvider, setNavigationContext, setNodeLifecycleProvider, setPlanManager, setPluginAccessor, setProfile, setProjectManager, setReturnUrl, setWebInterfaceManager, streamJson, toJson, toJson

Methods inherited from class com.opensymphony.xwork2.ActionSupport

addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getContainer, getFormatted, getLocale, getLocaleProvider, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.ww2.aware.permissions.DomainObjectSecurityAware

getSecuredDomainObject

Methods inherited from interface com.atlassian.bamboo.utils.error.ErrorCollection

getAllErrorMessages

Methods inherited from interface com.opensymphony.xwork2.interceptor.ValidationAware

addActionMessage, addFieldError, getActionErrors, getActionMessages, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Constructor Details

StopPlan

public StopPlan()

Method Details

execute

public String execute()
               throws Exception

Stop the current build

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Returns:

WebWork success status - the name of the view to display

Throws:

Exception - A generic failure

isAbandonResult

public boolean isAbandonResult()

setAbandonResult

public void setAbandonResult(boolean abandonResult)