Package com.atlassian.bamboo.ww2.actions.chains

Class StageAction

java.lang.Object

com.opensymphony.xwork2.ActionSupport

com.atlassian.bamboo.ww2.BambooActionSupport

com.atlassian.bamboo.ww2.actions.PlanActionSupport

com.atlassian.bamboo.ww2.actions.ChainActionSupport

com.atlassian.bamboo.ww2.actions.chains.StageAction

All Implemented Interfaces:

JsonStreamingAction, ErrorCollection, BambooSessionAware, ChainAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, PlanViewConfigurationSecurityAware, 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

Direct Known Subclasses:

AddStageAction, DeleteStageAction

public class StageAction
extends ChainActionSupport
implements PlanViewConfigurationSecurityAware

See Also:

Serialized Form

Nested Class Summary

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

BambooActionSupport.JSONStatus

Field Summary

Fields

Modifier and Type	Field	Description
protected AuditLogService	auditLogService
protected boolean	finalStage
protected String	stageDescription
protected String	stageId
protected boolean	stageManual
protected String	stageName

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

chainBranchManager, chainExecutionManager, executableAgentsHelper, stageStatusHelper

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, 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
StageAction()

Method Summary

Modifier and Type	Method	Description
protected @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject	buildJsonObject()	Builds JSONObject and sets 'status', 'errors' and 'fieldErrors' properties accordingly.
protected @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject	buildStageJsonObject()
String	doDefault()	Default action just sends to the input
String	execute()
@Nullable String	getAgentUnavailabilityHint(@NotNull ImmutableJob job)
List<DeploymentProject>	getRelatedDeploymentProjects()
@Nullable String	getStageDescription()
String	getStageId()
@Nullable String	getStageName()
boolean	isFinalStage()
boolean	isStageManual()
void	setAuditLogService(AuditLogService auditLogService)
void	setElasticFunctionalityFacade(ElasticFunctionalityFacade elasticFunctionalityFacade)
void	setFinalStage(boolean finalStage)
void	setPlanValidationService(PlanValidationService planValidationService)
void	setStageDescription(String stageDescription)
void	setStageId(String stageId)
void	setStageManual(boolean stageManual)
void	setStageName(String stageName)
protected void	triggerAnalyticsEvent()
void	validate()

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

getBranchIdentifiers, getChain, getChainBranches, getChainBranchesByDate, getChainResult, getChainResultNumber, getErrorAccessor, getImmutableChain, getImmutableChainBranches, getImmutableChainStage, getMutableChain, getMutableChainStage, getSiblingBranchIdentifiers, getStageStatusHelper, setChain, setChainBranchManager, setChainExecutionManager, setChainResult, setChainResultNumber, setChainStage, setDecoratingAggregatedChainErrorAccessor, setExecutableAgentsHelper, setStageStatusHelper

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

buildWebPanelContext, getBuildKey, getBuildNumber, getCurrentlyBuildingPlans, 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, addErrors, addFieldErrors, addHelpPanel, addIllegalArgumentException, areCheckBoxesEmpty, checkFieldXssSafety, createFieldValidator, doesHelpLinkHaveMatchingTitle, doesLabelKeyHaveMatchingDescription, doExecute, doInput, forceRelativeReturnUrl, getActionWarnings, getAdministrationConfiguration, getAvailableCategoryJson, getBamboo, getBambooLicenseManager, getBambooPermissionManager, getBambooSession, getBambooUrl, getBambooUserManager, getBaseUrl, getBestBaseUrl, getBootstrapManager, getBreadCrumbs, getChainEquiv, 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

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

Field Detail

stageId

protected String stageId

stageName

protected String stageName

stageDescription

protected String stageDescription

stageManual

protected boolean stageManual

finalStage

protected boolean finalStage

auditLogService

protected AuditLogService auditLogService

Constructor Detail

StageAction

public StageAction()

Method Detail

execute

public String execute()
               throws Exception

Specified by:

execute in interface com.opensymphony.xwork2.Action

Overrides:

execute in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

triggerAnalyticsEvent

protected void triggerAnalyticsEvent()

buildStageJsonObject

@NotNull
protected @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject buildStageJsonObject()
                                                                                     throws com.opensymphony.webwork.dispatcher.json.JSONException

Throws:

com.opensymphony.webwork.dispatcher.json.JSONException

buildJsonObject

@NotNull
protected @NotNull com.opensymphony.webwork.dispatcher.json.JSONObject buildJsonObject()
                                                                                throws com.opensymphony.webwork.dispatcher.json.JSONException

Description copied from class: BambooActionSupport

Builds JSONObject and sets 'status', 'errors' and 'fieldErrors' properties accordingly. If descending classes need to add anything to JSON response these should override this method.

Overrides:

buildJsonObject in class BambooActionSupport

Returns:

Initialized JSONObject

Throws:

com.opensymphony.webwork.dispatcher.json.JSONException

doDefault

public String doDefault()
                 throws Exception

Description copied from class: BambooActionSupport

Default action just sends to the input

Overrides:

doDefault in class BambooActionSupport

Throws:

Exception

validate

public void validate()

Specified by:

validate in interface com.opensymphony.xwork2.Validateable

Overrides:

validate in class com.opensymphony.xwork2.ActionSupport

getAgentUnavailabilityHint

@Nullable
public @Nullable String getAgentUnavailabilityHint(@NotNull
                                                   @NotNull ImmutableJob job)

getRelatedDeploymentProjects

public List<DeploymentProject> getRelatedDeploymentProjects()

getStageName

@Nullable
public @Nullable String getStageName()

setStageName

public void setStageName(String stageName)

getStageDescription

@Nullable
public @Nullable String getStageDescription()

setStageDescription

public void setStageDescription(String stageDescription)

isStageManual

public boolean isStageManual()

setStageManual

public void setStageManual(boolean stageManual)

isFinalStage

public boolean isFinalStage()

setFinalStage

public void setFinalStage(boolean finalStage)

getStageId

public String getStageId()

setStageId

public void setStageId(String stageId)

setPlanValidationService

public void setPlanValidationService(PlanValidationService planValidationService)

setElasticFunctionalityFacade

public void setElasticFunctionalityFacade(ElasticFunctionalityFacade elasticFunctionalityFacade)

setAuditLogService

public void setAuditLogService(AuditLogService auditLogService)