Package com.atlassian.bamboo.ww2.actions

Class PlanActionSupport

java.lang.Object

org.apache.struts2.ActionSupport

com.atlassian.bamboo.ww2.BambooActionSupport

com.atlassian.bamboo.ww2.actions.PlanActionSupport

All Implemented Interfaces:

JsonStreamingAction, ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, PlanAware, ProjectAware, ReturnUrlAware, UserAware, com.atlassian.core.i18n.I18nTextProvider, Serializable, org.apache.struts2.action.Action, org.apache.struts2.interceptor.ValidationAware, org.apache.struts2.locale.LocaleProvider, org.apache.struts2.text.TextProvider, org.apache.struts2.Validateable

Direct Known Subclasses:

AvailableVariablesAction, BuildActionSupport, BuildConfigurationSupport, ChainActionSupport, ConfigureArtifactSubscription, ConfigureBuildArtifact, CreateRemoteJiraLinkAction, DeletePlan, DeletePlanResults, EditLabelsAction, PlanResultsAction, ResponsibleAvatars, RssConfigurationInterceptorTest, ShowLatestBuildStatus, StopPlan, UpdateResponsibilitiesAction, ViewActivityLog, ViewLabels, ViewPlanSpecs, ViewQuarantinedTests, ViewRunningPlans, ViewTestsSummaryForPlan

public class PlanActionSupport
extends BambooActionSupport
implements ProjectAware, PlanAware

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 Integer	buildNumber
protected JiraApplinksService	jiraApplinksService
protected RepositoryDefinitionManager	repositoryDefinitionManager
protected ResultsSummaryManager	resultsSummaryManager
protected VcsRepositoryConfigurationService	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 org.apache.struts2.ActionSupport

container

Fields inherited from interface org.apache.struts2.action.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors

Constructor	Description
PlanActionSupport()

Method Summary

Modifier and Type	Method	Description
protected @NotNull Map<String,Object>	buildWebPanelContext(@NotNull String location)	Builds a context suitable for rendering WebPanels via FreemarkerContext.getWebPanels(String) In the future the results of this method may be cached
Optional<ImmutableChain>	findPotentialMasterPlan(@Nullable PlanKey planKey)
String	getBuildKey()
Integer	getBuildNumber()
Collection<? extends ExecutionStatus>	getCurrentlyBuildingPlans(@NotNull PlanKey planKey)
ErrorAccessor	getErrorAccessor()	Returns decoratingErrorAccessor bean
@Nullable String	getFirstNotRunnableStage(@NotNull ResultsSummary resultsSummary)
@Nullable ImmutablePlan	getImmutablePlan()
Map<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor,String>	getJobsWebItemsForSection(String sectionName, jakarta.servlet.http.HttpServletRequest req)
Plan	getMutablePlan()
Plan	getPlan()	Deprecated. since 4.4
String	getPlanKey()
String	getPlanResultKey()
Project	getProject()
protected ResultsSummaryManager	getResultsSummaryManager()
Object	getSecuredDomainObject()
@Nullable PlanKey	getTypedPlanKey()
@Nullable PlanResultKey	getTypedPlanResultKey()
boolean	isContinuable(@NotNull ResultsSummary resultsSummary)
boolean	isJiraApplicationLinkDefined()
boolean	isRestartable(@NotNull ResultsSummary resultsSummary)
protected String	planNotFound()
void	setBuildContextFactory(BuildContextFactory buildContextFactory)
void	setBuildKey(String buildKey)
void	setBuildNumber(Integer buildNumber)
void	setDecoratingErrorAccessor(DecoratingErrorAccessorImpl errorAccessor)	Property injection with autowiring via property name
void	setJiraApplinksService(JiraApplinksService jiraApplinksService)
void	setPlan(ImmutablePlan plan)
void	setPlanExecutionManager(PlanExecutionManager planExecutionManager)
void	setPlanKey(String planKey)
void	setPlanResultKey(String planResultKey)
void	setRepositoryDefinitionManager(RepositoryDefinitionManager repositoryDefinitionManager)
void	setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)
void	setVcsRepositoryConfigurationService(VcsRepositoryConfigurationService vcsRepositoryConfigurationService)

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, getActionErrors, getActionWarnings, getAdministrationConfiguration, getAvailableCategoryJson, getBambooContainer, getBambooLicenseManager, getBambooPermissionManager, getBambooSession, getBambooUrl, getBambooUserManager, getBaseUrl, getBestBaseUrl, getBootstrapManager, getBreadCrumbs, getChainEquiv, getCheckBoxFields, getConcurrentBuildExecutionStrategyOptions, getConcurrentBuildsEnabled, getConglomerateCookieValue, getCookieCutter, getCookieValue, getCurrentFormTheme, getCurrentSystemTime, getCurrentUrl, getDecorator, getDefaultPersister, getDescriptionFromLabelKey, getElasticConfig, getErrorMessages, getErrors, getFeatureManager, getFieldErrorAccessTracker, getFieldErrors, 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, 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, setCachedEnvironmentService, setCachedPlanManager, setChainEquiv, setCheckBoxFields, setCookieCutter, setCurrentFormTheme, setDecorator, setDeploymentProjectService, setDocumentationLinkProvider, setEnableJavascript, setErrorMessages, setFeatureManager, setI18nBeanFactory, setJobEquiv, setJsonator, setLocalizedTextProvider, setNavigationContext, setNodeLifecycleProvider, setPlanManager, setPluginAccessor, setProfile, setProjectManager, setReturnUrl, setWebInterfaceManager, streamJson, toJson, toJson

Methods inherited from class org.apache.struts2.ActionSupport

addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, execute, getActionMessages, getContainer, getFormatted, getLocale, getLocaleProvider, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, input, isValidLocale, isValidLocaleString, pause, setActionErrors, setActionMessages, setContainer, setFieldErrors, toLocale, 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.utils.error.ErrorCollection

getAllErrorMessages

Methods inherited from interface org.apache.struts2.interceptor.ValidationAware

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

Field Details

buildNumber

protected Integer buildNumber

resultsSummaryManager

protected ResultsSummaryManager resultsSummaryManager

vcsRepositoryConfigurationService

protected VcsRepositoryConfigurationService vcsRepositoryConfigurationService

jiraApplinksService

protected JiraApplinksService jiraApplinksService

repositoryDefinitionManager

protected RepositoryDefinitionManager repositoryDefinitionManager

Constructor Details

PlanActionSupport

public PlanActionSupport()

Method Details

getProject

public Project getProject()

Specified by:

getProject in interface ProjectAware

getImmutablePlan

@Nullable
public @Nullable ImmutablePlan getImmutablePlan()

Specified by:

getImmutablePlan in interface PlanAware

getPlan

@Deprecated
public Plan getPlan()

Deprecated.

since 4.4

Specified by:

getPlan in interface PlanAware

getMutablePlan

public Plan getMutablePlan()

Specified by:

getMutablePlan in interface PlanAware

setPlan

public void setPlan(ImmutablePlan plan)

Specified by:

setPlan in interface PlanAware

findPotentialMasterPlan

public Optional<ImmutableChain> findPotentialMasterPlan(@Nullable
 @Nullable PlanKey planKey)

getPlanKey

public String getPlanKey()

setPlanKey

public void setPlanKey(String planKey)

getBuildKey

public String getBuildKey()

setBuildKey

public void setBuildKey(String buildKey)

getPlanResultKey

public String getPlanResultKey()

getTypedPlanKey

@Nullable
public @Nullable PlanKey getTypedPlanKey()

getTypedPlanResultKey

@Nullable
public @Nullable PlanResultKey getTypedPlanResultKey()

setPlanResultKey

public void setPlanResultKey(String planResultKey)

getBuildNumber

public Integer getBuildNumber()

setBuildNumber

public void setBuildNumber(Integer buildNumber)

getCurrentlyBuildingPlans

@TemplateAccessible
public Collection<? extends ExecutionStatus> getCurrentlyBuildingPlans(@NotNull
 @NotNull PlanKey planKey)

getSecuredDomainObject

public Object getSecuredDomainObject()

Specified by:

getSecuredDomainObject in interface DomainObjectSecurityAware

Overrides:

getSecuredDomainObject in class BambooActionSupport

isJiraApplicationLinkDefined

public boolean isJiraApplicationLinkDefined()

getResultsSummaryManager

protected ResultsSummaryManager getResultsSummaryManager()

setResultsSummaryManager

public void setResultsSummaryManager(ResultsSummaryManager resultsSummaryManager)

setPlanExecutionManager

public void setPlanExecutionManager(PlanExecutionManager planExecutionManager)

Overrides:

setPlanExecutionManager in class BambooActionSupport

getErrorAccessor

public ErrorAccessor getErrorAccessor()

Returns decoratingErrorAccessor bean

setDecoratingErrorAccessor

public void setDecoratingErrorAccessor(DecoratingErrorAccessorImpl errorAccessor)

Property injection with autowiring via property name

Parameters:

errorAccessor - decoratingErrorAccessor bean

buildWebPanelContext

@NotNull
protected @NotNull Map<String,Object> buildWebPanelContext(@NotNull
 @NotNull String location)

Description copied from class: BambooActionSupport

Builds a context suitable for rendering WebPanels via FreemarkerContext.getWebPanels(String) In the future the results of this method may be cached

Overrides:

buildWebPanelContext in class BambooActionSupport

Parameters:

location -

Returns:

context

planNotFound

protected String planNotFound()

getJobsWebItemsForSection

@TemplateAccessible
public Map<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor,String> getJobsWebItemsForSection(String sectionName,
 jakarta.servlet.http.HttpServletRequest req)

isRestartable

@TemplateAccessible
public boolean isRestartable(@NotNull
 @NotNull ResultsSummary resultsSummary)

isContinuable

@TemplateAccessible
public boolean isContinuable(@NotNull
 @NotNull ResultsSummary resultsSummary)

getFirstNotRunnableStage

@TemplateAccessible
@Nullable
public @Nullable String getFirstNotRunnableStage(@NotNull
 @NotNull ResultsSummary resultsSummary)

setJiraApplinksService

public void setJiraApplinksService(JiraApplinksService jiraApplinksService)

setRepositoryDefinitionManager

public void setRepositoryDefinitionManager(RepositoryDefinitionManager repositoryDefinitionManager)

setVcsRepositoryConfigurationService

public void setVcsRepositoryConfigurationService(VcsRepositoryConfigurationService vcsRepositoryConfigurationService)

setBuildContextFactory

public void setBuildContextFactory(BuildContextFactory buildContextFactory)