BambooActionSupport (Atlassian Bamboo Web JAR 5.9.8 API)

java.lang.Object
- com.opensymphony.xwork2.ActionSupport
- - com.atlassian.bamboo.ww2.BambooActionSupport

All Implemented Interfaces:

com.atlassian.bamboo.utils.error.ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, ReturnUrlAware, com.atlassian.core.i18n.I18nTextProvider, com.opensymphony.xwork2.Action, com.opensymphony.xwork2.LocaleProvider, com.opensymphony.xwork2.TextProvider, com.opensymphony.xwork2.Validateable, com.opensymphony.xwork2.ValidationAware, Serializable

Direct Known Subclasses:

AboutAction, AbstractAdminRestAction, AbstractEntityPagerSupport, AbstractJiraIssueAction, AbstractJiraRelatedAction, AbstractNotificationBulkAction, AbstractPermissionAction, AbstractPluginConfigurationAction, AbstractRepositoryBulkAction, AbstractSetupAction, AccessDeniedAction, AddPermissionAction, AdminErrorAction, AdministerAction, AdministerAuthors, AgentConsoleAction, AgentJsonProvider, AllBuildsRssFeedAction, AllowLicenseUpdateOrShowExpirationInfo, BambooAgentInstallerAction, BambooCancellableAction, BuildExpiryAction, BuildJsonProviderAction, BulkPlanAction, ChainResultProviderAction, ChangeForgottenPassword, ChangePassword, ConfigureAlias, ConfigureGlobalBuildHangingDetection, ConfigureGlobalRepository, ConfigureGroup, ConfigureProfile, ConfigureUser, CreateChain, CronExpressionGeneratorAction, DeleteBuilds, EditProjectName, ErrorAction, FilterCookieWriterAction, FiveOhOh, ForgotPassword, GetFingerprintAction, GlobalAdminAction, GotoAuthors, ImportMavenPlanAction, JiraRedirectAction, ListRunningInstances, Login, Login, Logout, Logout, LogToServer, PerformanceStatsAction, PerformanceStatsJmxAction, PlanActionSupport, PlanStatusHistoryAction, Profile, ReorderBuild, RepositorySettingsAction, RssFeedAction, SetAgentBuildFilter, SignupUser, StarterAction, SystemErrorList, SystemInfoAction, TestOgnlEscaping, ViewAdministrators, ViewAgent, ViewAgentDetailsAction, ViewAgents, ViewAggregatedAuthors, ViewAuthor, ViewAuthorChart, ViewAuthors, ViewAuthors, ViewBuildResultsForLabelAction, ViewBuildResultsTable, ViewGlobalAuditLogAction, ViewProject, ViewRejectedRequirements, ViewRemoteAgentAuthentications, ViewReport, ViewReportChart, ViewUserSummary
```
public class BambooActionSupport
extends com.opensymphony.xwork2.ActionSupport
implements com.atlassian.bamboo.utils.error.ErrorCollection, ReturnUrlAware, BambooSessionAware, GlobalReadSecurityAware, com.atlassian.core.i18n.I18nTextProvider, NavigationAware, com.opensymphony.xwork.ValidationAware, com.atlassian.struts.TextProvider
```
See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BambooActionSupport.JSONStatus

Nested Classes
Modifier and Type	Class and Description
`static class`	`BambooActionSupport.JSONStatus`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_DENIED`
`protected AdministrationConfigurationAccessor`	`administrationConfigurationAccessor`
`protected AdministrationConfigurationManager`	`administrationConfigurationManager` Deprecated. since 5.0
`protected AdministrationConfigurationPersister`	`administrationConfigurationPersister`
`static String`	`AGGREGATE_URL_PATTERN`
`protected BambooPermissionManager`	`bambooPermissionManager`
`protected BambooUserManager`	`bambooUserManager`
`static String`	`BUILD_KEY_CONTEXT`
`protected BuildDefinitionManager`	`buildDefinitionManager`
`protected CachedPlanManager`	`cachedPlanManager`
`static String`	`CONFIRM`
`protected CookieCutter`	`cookieCutter`
`protected DashboardCachingManager`	`dashboardCachingManager`
`protected com.atlassian.bamboo.deployments.environments.service.EnvironmentService`	`environmentService`
`protected FeatureManager`	`featureManager`
`static String`	`PAGE_NOT_FOUND`
`static String`	`PLAN_KEY_CONTEXT`
`protected PlanExecutionManager`	`planExecutionManager`
`protected PlanManager`	`planManager`
`protected com.atlassian.plugin.PluginAccessor`	`pluginAccessor`
`protected ProjectManager`	`projectManager`
`protected com.atlassian.plugin.web.WebInterfaceManager`	`webInterfaceManager`

Fields inherited from class com.opensymphony.xwork2.ActionSupport
LOG

Fields inherited from interface com.opensymphony.xwork2.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

Constructors
Constructor and Description

BambooActionSupport()

Constructors
Constructor and Description
`BambooActionSupport()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addActionError(String errorMessage)`
`void`	`addActionWarning(String errorMessage)`
`void`	`addError(String field, String message)` Deprecated. since 1.0 Use `ActionSupport.addFieldError(String, String)` instead
`void`	`addError(String prefix, String field, String message)`
`void`	`addErrorCollection(com.atlassian.bamboo.utils.error.ErrorCollection errors)`
`String`	`addErrorMessage(String message)` Deprecated. since 1.0 Use `addActionError(String)` instead
`String`	`addErrorMessage(String message, Exception e)`
`void`	`addErrorMessages(Collection<String> errorMessages)`
`void`	`addErrors(Map<String,?> errors)` Deprecated. since 5.1
`void`	`addFieldErrors(Map<String,List<String>> errors)`
`void`	`addHelpPanel(String helpPanel)`
`void`	`addIllegalArgumentException(String field, IllegalArgumentException e)`
`protected boolean`	`areCheckBoxesEmpty(String field)`
`protected com.opensymphony.webwork.dispatcher.json.JSONObject`	`buildJsonObject()` Builds JSONObject and sets 'status', 'errors' and 'fieldErrors' properties accordingly.
`protected Map<String,Object>`	`buildWebPanelContext(String location)` Builds a context suitable for rendering `WebPanel`s via `FreemarkerContext.getWebPanels(String)` In the future the results of this method may be cached
`protected void`	`checkFieldXssSafety(String fieldName, String fieldValue)`
`protected <T extends com.opensymphony.xwork2.validator.FieldValidator> T`	`createFieldValidator(String fieldName, Class<T> validatorClass, String messageKey, String[] messageParameters)` Create WebWork's field validator
`String`	`doDefault()` Deprecated. since 5.4 use a different method name
`boolean`	`doesHelpLinkHaveMatchingTitle(String helpKey)`
`boolean`	`doesLabelKeyHaveMatchingDescription(String labelKey)`
`String`	`doExecute()` Places the current user on the page
`String`	`doInput()` Deprecated. since 5.1 use ${#input()} instead.
`String`	`execute()`
`protected void`	`forceRelativeReturnUrl()` converts current return URL to a path rooted under context.
`List<String>`	`getActionWarnings()`
`protected AdministrationConfiguration`	`getAdministrationConfiguration()` Makes the current Admin configuration available to an action
`protected Bamboo`	`getBamboo()` Allows access to the Bamboo container.
`protected BambooLicenseManager`	`getBambooLicenseManager()`
`protected BambooPermissionManager`	`getBambooPermissionManager()`
`BambooSession`	`getBambooSession()`
`BambooUrl`	`getBambooUrl()`
`BambooUserManager`	`getBambooUserManager()`
`String`	`getBaseUrl()`
`String`	`getBestBaseUrl()`
`BootstrapManager`	`getBootstrapManager()`
`Collection<BreadCrumb>`	`getBreadCrumbs()`
`String`	`getChainEquiv()`
`boolean`	`getConcurrentBuildsEnabled()`
`String`	`getConglomerateCookieValue(String cookieKey, String conglomerateKey)`
`CookieCutter`	`getCookieCutter()`
`String`	`getCookieValue(String key)`
`String`	`getCurrentFormTheme()`
`Long`	`getCurrentSystemTime()`
`String`	`getCurrentUrl()`
`protected Persister`	`getDefaultPersister()` Deprecated. since 5.10
`com.atlassian.bamboo.deployments.projects.DeploymentProject`	`getDeploymentProject(long environmentId)` Deprecated. since 5.7
`String`	`getDescriptionFromLabelKey(String labelKey)`
`ElasticConfiguration`	`getElasticConfig()`
`FeatureManager`	`getFeatureManager()`
`Set<String>`	`getFieldErrorAccessTracker()`
`Map<String,List<String>>`	`getFieldErrors()`
`Collection<String>`	`getFlushedErrorMessages()`
`Collection<String>`	`getFormattedActionErrors()`
`List<String>`	`getFormattedActionMessages()`
`List<String>`	`getFormattedActionWarnings()`
`List<Map<String,Object>>`	`getHelpPanels()`
`String`	`getInstanceName()`
`String`	`getJobEquiv()`
`com.opensymphony.webwork.dispatcher.json.JSONObject`	`getJsonObject()` This is default property read by webwork for webwork's result type "json".
`NavigationContext`	`getNavigationContext()`
`String`	`getNavigationUrl()` The url of the current action.
`int`	`getNumberOfCurrentlyBuildingPlans(String planKey)`
`ImmutableChain`	`getPlan(String planKey)`
`PlanManager`	`getPlanManager()`
`com.atlassian.plugin.PluginAccessor`	`getPluginAccessor()`
`String`	`getReturnUrl()`
`Object`	`getSecuredDomainObject()`
`ServerLifecycleState`	`getServerLifecycleState()`
`BambooUser`	`getSessionUser(String auth)`
`String`	`getText(String key)`
`String`	`getText(String key, List args)`
`String`	`getText(String s, Object[] objects)`
`String`	`getText(String key, String defaultValue)`
`String`	`getText(String key, String[] args)`
`String`	`getText(String key, String defaultValue, List args)`
`String`	`getText(String key, String defaultValue, List args, com.opensymphony.xwork2.ognl.OgnlValueStack stack)` Deprecated. since 5.1
`String`	`getText(String key, String defaultValue, List args, com.opensymphony.xwork2.util.ValueStack stack)`
`String`	`getText(String key, String defaultValue, String obj)`
`String`	`getText(String key, String defaultValue, String[] args)`
`String`	`getText(String key, String defaultValue, String[] args, com.opensymphony.xwork2.ognl.OgnlValueStack stack)` Deprecated. since 5.1
`String`	`getText(String key, String defaultValue, String[] args, com.opensymphony.xwork2.util.ValueStack stack)`
`protected com.opensymphony.xwork2.TextProvider`	`getTextProvider()`
`ResourceBundle`	`getTexts()`
`ResourceBundle`	`getTexts(String bundleName)`
`String`	`getTextWithArgs(String key, String... args)`
`int`	`getTotalErrors()`
`com.atlassian.user.User`	`getUser()`
`protected com.opensymphony.xwork2.validator.DelegatingValidatorContext`	`getValidatorContext()` Can be used for WebWork's validation
`Map<String,Object>`	`getWebFragmentsContextMap()`
`List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor>`	`getWebItemsForSection(String sectionName)`
`Map<String,Object>`	`getWebPanelContext(String location)` Returns for the context for a `WebPanel` based on the location specified In the future the results of this method may be cached
`List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor>`	`getWebSectionsForLocation(String location)`
`boolean`	`hasActionWarnings()`
`boolean`	`hasAdminPermission()`
`boolean`	`hasAnyErrors()`
`boolean`	`hasBuilds()`
`boolean`	`hasEntityPermission(String permission, Object object)`
`boolean`	`hasGlobalAdminPermission()`
`boolean`	`hasGlobalPermission(org.acegisecurity.acls.Permission permission)`
`boolean`	`hasGlobalPermission(String permission)` Does this user have the global permission right?
`boolean`	`hasKey(String key)`
`boolean`	`hasLinkedDeployments(PlanKey planKey)`
`boolean`	`hasPlanPermission(String permission, PlanIdentifier plan)`
`boolean`	`hasPlanPermission(String permission, String planKey)` You should always prefer using `hasPlanPermission(String, PlanIdentifier)` if you have or you are about to have Plan reference.
`boolean`	`hasRestrictedAdminPermission()`
`String`	`input()`
`boolean`	`isCheckboxSetInAction(String checkboxName)`
`boolean`	`isEc2ConfigurationWarningRequired()`
`boolean`	`isEnableJavascript()`
`boolean`	`isEnableSignup()`
`boolean`	`isInlineDialog()`
`boolean`	`isRestrictedAdminEnabled()`
`boolean`	`isSelectFieldAndNull(String buildKeysField)`
`boolean`	`isViewContactDetailsEnabled()`
`String`	`renderFreemarkerTemplate(String templateString)`
`void`	`setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)`
`void`	`setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)`
`void`	`setAdministrationConfigurationPersister(AdministrationConfigurationPersister administrationConfigurationPersister)`
`void`	`setAuthenticationContext(BambooAuthenticationContext authenticationContext)`
`void`	`setBambooLicenseManager(BambooLicenseManager bambooLicenseManager)`
`void`	`setBambooPermissionManager(BambooPermissionManager bambooPermissionManager)`
`void`	`setBambooUserManager(BambooUserManager bambooUserManager)`
`void`	`setBuildDefinitionManager(BuildDefinitionManager buildDefinitionManager)`
`void`	`setCachedPlanManager(CachedPlanManager cachedPlanManager)`
`void`	`setChainEquiv(String chainEquiv)`
`void`	`setCheckBoxFields(String[] checkBoxFields)`
`void`	`setCookieCutter(CookieCutter cookieCutter)`
`void`	`setCurrentFormTheme(String currentFormTheme)`
`void`	`setDashboardCachingManager(DashboardCachingManager dashboardCachingManager)`
`void`	`setDecorator(String decorator)`
`void`	`setEnableJavascript(boolean enableJavascript)`
`void`	`setEnvironmentService(com.atlassian.bamboo.deployments.environments.service.EnvironmentService environmentService)`
`void`	`setErrorMessages(Collection<String> errorMessages)` Deprecated. since 1.0 Use `ActionSupport.setActionErrors(Collection)` instead
`void`	`setFeatureManager(FeatureManager featureManager)`
`void`	`setI18nBeanFactory(I18nBeanFactory i18nBeanFactory)`
`void`	`setJobEquiv(String jobEquiv)`
`void`	`setJsonator(com.atlassian.bamboo.jsonator.Jsonator jsonator)`
`void`	`setLinkedDeploymentProjectCacheService(com.atlassian.bamboo.deployments.cache.LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService)`
`void`	`setNavigationContext(NavigationContext navigationContext)` Set the current context for this action
`void`	`setPlanExecutionManager(PlanExecutionManager planExecutionManager)`
`void`	`setPlanManager(PlanManager planManager)`
`void`	`setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)`
`void`	`setProfile(String value)`
`void`	`setProjectManager(ProjectManager projectManager)`
`void`	`setReturnUrl(String returnUrl)`
`void`	`setServerLifecycleProvider(ServerLifecycleProvider serverLifecycleProvider)`
`void`	`setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)`
`String`	`toJson(Object object)`
`String`	`toJson(Object object, com.atlassian.bamboo.jsonator.Jsonator.EnumConversionMode enumConversionMode)`

Methods inherited from class com.opensymphony.xwork2.ActionSupport
addActionMessage, addFieldError, clearActionErrors, clearErrors, clearErrorsAndMessages, clearFieldErrors, clearMessages, clone, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFormatted, getLocale, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, 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.utils.error.ErrorCollection
getErrorMessages, getErrors

Methods inherited from interface com.opensymphony.xwork2.ValidationAware
addActionMessage, addFieldError, getActionErrors, getActionMessages, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, setActionErrors, setActionMessages, setFieldErrors

Field Detail

CONFIRM
```
public static final String CONFIRM
```
See Also:
Constant Field Values

ACCESS_DENIED

public static final String ACCESS_DENIED

See Also:: Constant Field Values

PAGE_NOT_FOUND

public static final String PAGE_NOT_FOUND

See Also:: Constant Field Values

PLAN_KEY_CONTEXT

public static final String PLAN_KEY_CONTEXT

See Also:: Constant Field Values

BUILD_KEY_CONTEXT

public static final String BUILD_KEY_CONTEXT

See Also:: Constant Field Values

AGGREGATE_URL_PATTERN

public static final String AGGREGATE_URL_PATTERN

See Also:: Constant Field Values

cookieCutter
```
protected CookieCutter cookieCutter
```

planManager
```
protected PlanManager planManager
```

cachedPlanManager

protected CachedPlanManager cachedPlanManager

buildDefinitionManager

protected BuildDefinitionManager buildDefinitionManager

projectManager

protected ProjectManager projectManager

bambooPermissionManager

protected BambooPermissionManager bambooPermissionManager

webInterfaceManager

protected com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager

administrationConfigurationAccessor

protected AdministrationConfigurationAccessor administrationConfigurationAccessor

administrationConfigurationManager

@Deprecated
protected AdministrationConfigurationManager administrationConfigurationManager

Deprecated. since 5.0

administrationConfigurationPersister

protected AdministrationConfigurationPersister administrationConfigurationPersister

dashboardCachingManager

protected DashboardCachingManager dashboardCachingManager

bambooUserManager

protected BambooUserManager bambooUserManager

planExecutionManager

protected PlanExecutionManager planExecutionManager

pluginAccessor

protected com.atlassian.plugin.PluginAccessor pluginAccessor

environmentService

protected com.atlassian.bamboo.deployments.environments.service.EnvironmentService environmentService

featureManager

protected FeatureManager featureManager

Constructor Detail
- BambooActionSupport
```
public BambooActionSupport()
```

Method Detail

setProfile
```
public void setProfile(String value)
```

doDefault
```
@Deprecated
public String doDefault()
                 throws Exception
```
Deprecated. since 5.4 use a different method name

Default action just sends to the input

Overrides:

doDefault in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

getBambooSession
```
public BambooSession getBambooSession()
```
Specified by:

getBambooSession in interface BambooSessionAware

getBamboo
```
protected Bamboo getBamboo()
```
Allows access to the Bamboo container. Currently not injected using Spring

Returns:
The singleton instance of Bamboo.

getUser

@Nullable
public com.atlassian.user.User getUser()

getServerLifecycleState

@NotNull
public ServerLifecycleState getServerLifecycleState()

setServerLifecycleProvider

public void setServerLifecycleProvider(ServerLifecycleProvider serverLifecycleProvider)

doesLabelKeyHaveMatchingDescription

public boolean doesLabelKeyHaveMatchingDescription(String labelKey)

doesHelpLinkHaveMatchingTitle

public boolean doesHelpLinkHaveMatchingTitle(String helpKey)

getDescriptionFromLabelKey

public String getDescriptionFromLabelKey(String labelKey)

hasGlobalPermission
```
public boolean hasGlobalPermission(String permission)
```
Does this user have the global permission right?

Parameters:
permission - - The global permission being checked.

Returns:
true if the current user has this permission; false otherwise.

hasGlobalPermission

public boolean hasGlobalPermission(org.acegisecurity.acls.Permission permission)

hasGlobalAdminPermission

public boolean hasGlobalAdminPermission()

hasRestrictedAdminPermission

public boolean hasRestrictedAdminPermission()

hasAdminPermission
```
public boolean hasAdminPermission()
```

hasPlanPermission
```
public boolean hasPlanPermission(String permission,
                        String planKey)
```
You should always prefer using hasPlanPermission(String, PlanIdentifier) if you have or you are about to have Plan reference.

hasPlanPermission

public boolean hasPlanPermission(String permission,
                        PlanIdentifier plan)

hasEntityPermission

public boolean hasEntityPermission(String permission,
                          Object object)

isRestrictedAdminEnabled

public boolean isRestrictedAdminEnabled()

isEnableSignup
```
public boolean isEnableSignup()
```

getConcurrentBuildsEnabled

public boolean getConcurrentBuildsEnabled()

isViewContactDetailsEnabled

public boolean isViewContactDetailsEnabled()

hasBuilds
```
public boolean hasBuilds()
```

getPlan

@Nullable
public ImmutableChain getPlan(String planKey)

getBreadCrumbs

public Collection<BreadCrumb> getBreadCrumbs()

setAuthenticationContext

public void setAuthenticationContext(BambooAuthenticationContext authenticationContext)

forceRelativeReturnUrl
```
protected void forceRelativeReturnUrl()
```
converts current return URL to a path rooted under context.

getReturnUrl
```
public String getReturnUrl()
```
Specified by:

getReturnUrl in interface ReturnUrlAware

setReturnUrl
```
public void setReturnUrl(String returnUrl)
```
Specified by:

setReturnUrl in interface ReturnUrlAware

getCurrentUrl

@Nullable
public String getCurrentUrl()

getCurrentSystemTime
```
public Long getCurrentSystemTime()
```

getCookieValue

@NotNull
public String getCookieValue(String key)

getBambooLicenseManager

protected BambooLicenseManager getBambooLicenseManager()

setBambooLicenseManager

public void setBambooLicenseManager(BambooLicenseManager bambooLicenseManager)

getBootstrapManager

public BootstrapManager getBootstrapManager()

getWebItemsForSection

public List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getWebItemsForSection(String sectionName)

getWebSectionsForLocation

public List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getWebSectionsForLocation(String location)

renderFreemarkerTemplate

public String renderFreemarkerTemplate(String templateString)

getWebFragmentsContextMap

public Map<String,Object> getWebFragmentsContextMap()

getJsonObject
```
@NotNull
public com.opensymphony.webwork.dispatcher.json.JSONObject getJsonObject()
                                                                  throws com.opensymphony.webwork.dispatcher.json.JSONException
```
This is default property read by webwork for webwork's result type "json".

Returns:

Throws:

com.opensymphony.webwork.dispatcher.json.JSONException
See Also:
JSON Result
If descending classes need to add anything to JSON response these should override {@link #buildJsonObject()} method.

buildJsonObject
```
@NotNull
protected com.opensymphony.webwork.dispatcher.json.JSONObject buildJsonObject()
                                                                       throws com.opensymphony.webwork.dispatcher.json.JSONException
```
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.

Returns:
Initialized JSONObject

Throws:

com.opensymphony.webwork.dispatcher.json.JSONException

addActionError
```
public void addActionError(@Nullable
                  String errorMessage)
```
Specified by:

addActionError in interface com.opensymphony.xwork2.ValidationAware

Overrides:

addActionError in class com.opensymphony.xwork2.ActionSupport

hasActionWarnings
```
public boolean hasActionWarnings()
```

getActionWarnings

@NotNull
public List<String> getActionWarnings()

addActionWarning

public void addActionWarning(@Nullable
                    String errorMessage)

addError

public void addError(String prefix,
            String field,
            String message)

Specified by:: addError in interface com.atlassian.bamboo.utils.error.ErrorCollection

getFlushedErrorMessages
```
public Collection<String> getFlushedErrorMessages()
```
Specified by:

getFlushedErrorMessages in interface com.atlassian.bamboo.utils.error.ErrorCollection

addErrorCollection

public void addErrorCollection(@NotNull
                      com.atlassian.bamboo.utils.error.ErrorCollection errors)

Specified by:: addErrorCollection in interface com.atlassian.bamboo.utils.error.ErrorCollection

addErrorMessages
```
public void addErrorMessages(Collection<String> errorMessages)
```
Specified by:

addErrorMessages in interface com.atlassian.bamboo.utils.error.ErrorCollection

addErrors
```
@Deprecated
public void addErrors(Map<String,?> errors)
```
Deprecated. since 5.1

Specified by:

addErrors in interface com.atlassian.bamboo.utils.error.ErrorCollection

addFieldErrors

public void addFieldErrors(@NotNull
                  Map<String,List<String>> errors)

Specified by:: addFieldErrors in interface com.atlassian.bamboo.utils.error.ErrorCollection

hasAnyErrors
```
public boolean hasAnyErrors()
```
Specified by:

hasAnyErrors in interface com.atlassian.bamboo.utils.error.ErrorCollection

getTotalErrors
```
public int getTotalErrors()
```
Specified by:

getTotalErrors in interface com.atlassian.bamboo.utils.error.ErrorCollection

getFieldErrors
```
public Map<String,List<String>> getFieldErrors()
```
Specified by:

getFieldErrors in interface com.atlassian.bamboo.utils.error.ErrorCollection

Specified by:

getFieldErrors in interface com.opensymphony.xwork2.ValidationAware

Overrides:

getFieldErrors in class com.opensymphony.xwork2.ActionSupport

addError
```
@Deprecated
public void addError(String field,
                       String message)
```
Deprecated. since 1.0 Use ActionSupport.addFieldError(String, String) instead

Specified by:

addError in interface com.atlassian.bamboo.utils.error.ErrorCollection

addErrorMessage
```
@Deprecated
public String addErrorMessage(String message)
```
Deprecated. since 1.0 Use addActionError(String) instead

Specified by:

addErrorMessage in interface com.atlassian.bamboo.utils.error.ErrorCollection

setErrorMessages
```
@Deprecated
public void setErrorMessages(Collection<String> errorMessages)
```
Deprecated. since 1.0 Use ActionSupport.setActionErrors(Collection) instead

Specified by:

setErrorMessages in interface com.atlassian.bamboo.utils.error.ErrorCollection

addErrorMessage

public String addErrorMessage(String message,
                     Exception e)

Specified by:: addErrorMessage in interface com.atlassian.bamboo.utils.error.ErrorCollection

addIllegalArgumentException

public void addIllegalArgumentException(String field,
                               IllegalArgumentException e)

setCookieCutter

public void setCookieCutter(CookieCutter cookieCutter)

getCookieCutter
```
public CookieCutter getCookieCutter()
```

setBambooPermissionManager

public void setBambooPermissionManager(BambooPermissionManager bambooPermissionManager)

getBambooPermissionManager

protected BambooPermissionManager getBambooPermissionManager()

setWebInterfaceManager

public void setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)

isSelectFieldAndNull

public boolean isSelectFieldAndNull(String buildKeysField)

getConglomerateCookieValue

public String getConglomerateCookieValue(String cookieKey,
                                String conglomerateKey)

getDefaultPersister

@Deprecated
protected Persister getDefaultPersister()

Deprecated. since 5.10

areCheckBoxesEmpty

protected boolean areCheckBoxesEmpty(String field)

getAdministrationConfiguration
```
@Nullable
protected AdministrationConfiguration getAdministrationConfiguration()
```
Makes the current Admin configuration available to an action

Returns:
The admin settings

getBaseUrl
```
@Nullable
public String getBaseUrl()
```

getBambooUrl
```
public BambooUrl getBambooUrl()
```

getBestBaseUrl
```
@Nullable
public String getBestBaseUrl()
```
Returns:
returns base URL from the current request, if for some reason it's not available, falls back to the BaseURL. The URL ends with the request context and does not end with a slash. If root context is used, the last element of the URL will be the port

getInstanceName

@Nullable
public String getInstanceName()

checkFieldXssSafety

protected void checkFieldXssSafety(String fieldName,
                       String fieldValue)

getValidatorContext

protected com.opensymphony.xwork2.validator.DelegatingValidatorContext getValidatorContext()

Can be used for WebWork's validation

Returns:

createFieldValidator

@Nullable
protected <T extends com.opensymphony.xwork2.validator.FieldValidator> T createFieldValidator(@NotNull
                                                                                           String fieldName,
                                                                                           @NotNull
                                                                                           Class<T> validatorClass,
                                                                                           @NotNull
                                                                                           String messageKey,
                                                                                           @Nullable
                                                                                           String[] messageParameters)

Create WebWork's field validator

Type Parameters:: T - class of the created FieldValidator object
Parameters:: fieldName - field to be validated by validator; validatorClass - validator class; messageKey - key of the error message to display; messageParameters - parameters to use for formatting of the error message
Returns:: FieldValidator object or null if creation failed

getText

public String getText(String s,
             Object[] objects)

Specified by:: getText in interface com.atlassian.core.i18n.I18nTextProvider

getTextProvider

protected com.opensymphony.xwork2.TextProvider getTextProvider()

hasKey
```
public boolean hasKey(String key)
```
Specified by:

hasKey in interface com.opensymphony.xwork2.TextProvider

Overrides:

hasKey in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key)
```
Specified by:

getText in interface com.atlassian.core.i18n.I18nTextProvider

Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key,
             String defaultValue)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key,
             String defaultValue,
             String obj)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key,
             List args)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key,
             String[] args)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getTextWithArgs

public String getTextWithArgs(String key,
                     String... args)

getText
```
public String getText(String key,
             String defaultValue,
             List args)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText
```
public String getText(String key,
             String defaultValue,
             String[] args)
```
Specified by:

getText in interface com.opensymphony.xwork2.TextProvider

Overrides:

getText in class com.opensymphony.xwork2.ActionSupport

getText

@Deprecated
public String getText(String key,
                        String defaultValue,
                        List args,
                        com.opensymphony.xwork2.ognl.OgnlValueStack stack)

Deprecated. since 5.1

getText

@Deprecated
public String getText(String key,
                        String defaultValue,
                        String[] args,
                        com.opensymphony.xwork2.ognl.OgnlValueStack stack)

Deprecated. since 5.1

getText

public String getText(String key,
             String defaultValue,
             String[] args,
             com.opensymphony.xwork2.util.ValueStack stack)

Specified by:: getText in interface com.opensymphony.xwork2.TextProvider
Overrides:: getText in class com.opensymphony.xwork2.ActionSupport

getText

public String getText(String key,
             String defaultValue,
             List args,
             com.opensymphony.xwork2.util.ValueStack stack)

Specified by:: getText in interface com.opensymphony.xwork2.TextProvider
Overrides:: getText in class com.opensymphony.xwork2.ActionSupport

getTexts
```
public ResourceBundle getTexts(String bundleName)
```
Specified by:

getTexts in interface com.opensymphony.xwork2.TextProvider

Overrides:

getTexts in class com.opensymphony.xwork2.ActionSupport

getTexts
```
public ResourceBundle getTexts()
```
Specified by:

getTexts in interface com.opensymphony.xwork2.TextProvider

Overrides:

getTexts in class com.opensymphony.xwork2.ActionSupport

doExecute
```
public String doExecute()
                 throws Exception
```
Places the current user on the page

Returns:
webwork success status

Throws:

Exception - something nasty went wrong

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

setCheckBoxFields

public void setCheckBoxFields(String[] checkBoxFields)

isCheckboxSetInAction

public boolean isCheckboxSetInAction(@NotNull
                            String checkboxName)

getNavigationUrl
```
public String getNavigationUrl()
```
Description copied from interface: NavigationAware

The url of the current action.

Specified by:

getNavigationUrl in interface NavigationAware

Returns:

getChainEquiv
```
public String getChainEquiv()
```
Specified by:

getChainEquiv in interface NavigationAware

Returns:
the chain equivilant url to this action (if you wish to explicitly define one)

setChainEquiv

public void setChainEquiv(String chainEquiv)

getJobEquiv
```
public String getJobEquiv()
```
Specified by:

getJobEquiv in interface NavigationAware

Returns:
the job equivilant url to this action (if you wish to explicitly define one)

setJobEquiv

public void setJobEquiv(String jobEquiv)

setNavigationContext
```
public void setNavigationContext(NavigationContext navigationContext)
```
Description copied from interface: NavigationAware

Set the current context for this action

Specified by:

setNavigationContext in interface NavigationAware

getNavigationContext
```
public NavigationContext getNavigationContext()
```
Specified by:

getNavigationContext in interface NavigationAware

Returns:
the context for this action

getNumberOfCurrentlyBuildingPlans
```
public int getNumberOfCurrentlyBuildingPlans(String planKey)
```
Returns:
number of builds that are currently in the build pipeline (both queued and executing)

hasLinkedDeployments

public boolean hasLinkedDeployments(PlanKey planKey)

getSecuredDomainObject
```
public Object getSecuredDomainObject()
```
Specified by:

getSecuredDomainObject in interface DomainObjectSecurityAware

setDashboardCachingManager

public void setDashboardCachingManager(DashboardCachingManager dashboardCachingManager)

getBambooUserManager

public BambooUserManager getBambooUserManager()

setBambooUserManager

public void setBambooUserManager(BambooUserManager bambooUserManager)

getSessionUser

public BambooUser getSessionUser(String auth)
                          throws BambooRemoteException

Throws:: BambooRemoteException

isEnableJavascript
```
public boolean isEnableJavascript()
```

setEnableJavascript

public void setEnableJavascript(boolean enableJavascript)

getCurrentFormTheme
```
public String getCurrentFormTheme()
```

setCurrentFormTheme

public void setCurrentFormTheme(String currentFormTheme)

setAdministrationConfigurationAccessor

public void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)

setAdministrationConfigurationManager

public void setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)

setAdministrationConfigurationPersister

public void setAdministrationConfigurationPersister(AdministrationConfigurationPersister administrationConfigurationPersister)

setProjectManager

public void setProjectManager(ProjectManager projectManager)

setBuildDefinitionManager

public void setBuildDefinitionManager(BuildDefinitionManager buildDefinitionManager)

getPlanManager
```
public PlanManager getPlanManager()
```

setPlanManager

public void setPlanManager(PlanManager planManager)

setCachedPlanManager

public void setCachedPlanManager(CachedPlanManager cachedPlanManager)

setPlanExecutionManager

public void setPlanExecutionManager(PlanExecutionManager planExecutionManager)

setI18nBeanFactory

public final void setI18nBeanFactory(I18nBeanFactory i18nBeanFactory)

getPluginAccessor

public com.atlassian.plugin.PluginAccessor getPluginAccessor()

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

getFeatureManager

public FeatureManager getFeatureManager()

setFeatureManager

public void setFeatureManager(FeatureManager featureManager)

setJsonator

public void setJsonator(com.atlassian.bamboo.jsonator.Jsonator jsonator)

setEnvironmentService

public void setEnvironmentService(com.atlassian.bamboo.deployments.environments.service.EnvironmentService environmentService)

getFormattedActionErrors

public Collection<String> getFormattedActionErrors()

getFormattedActionMessages

public List<String> getFormattedActionMessages()

getFormattedActionWarnings

public List<String> getFormattedActionWarnings()

getWebPanelContext

@NotNull
public final Map<String,Object> getWebPanelContext(@NotNull
                                            String location)

Returns for the context for a WebPanel based on the location specified In the future the results of this method may be cached

Parameters:: location -
Returns:: context

getElasticConfig

@Nullable
public ElasticConfiguration getElasticConfig()

isEc2ConfigurationWarningRequired

public boolean isEc2ConfigurationWarningRequired()

buildWebPanelContext
```
@NotNull
protected 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

Parameters:
location -

Returns:
context

setDecorator

public void setDecorator(String decorator)

isInlineDialog
```
public boolean isInlineDialog()
```

getFieldErrorAccessTracker

public Set<String> getFieldErrorAccessTracker()

toJson
```
public String toJson(Object object)
```

toJson

public String toJson(Object object,
            com.atlassian.bamboo.jsonator.Jsonator.EnumConversionMode enumConversionMode)

addHelpPanel

public void addHelpPanel(String helpPanel)

getHelpPanels

public final List<Map<String,Object>> getHelpPanels()

getDeploymentProject

@Deprecated
public com.atlassian.bamboo.deployments.projects.DeploymentProject getDeploymentProject(long environmentId)

Deprecated. since 5.7

setLinkedDeploymentProjectCacheService

public void setLinkedDeploymentProjectCacheService(com.atlassian.bamboo.deployments.cache.LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService)

doInput

@Deprecated
public String doInput()
               throws Exception

Deprecated. since 5.1 use ${#input()} instead.

Throws:: Exception

input
```
public String input()
             throws Exception
```
Overrides:

input in class com.opensymphony.xwork2.ActionSupport

Throws:

Exception

Class BambooActionSupport

Nested Class Summary

Field Summary

Fields inherited from class com.opensymphony.xwork2.ActionSupport

Fields inherited from interface com.opensymphony.xwork2.Action

Constructor Summary

Method Summary

Methods inherited from class com.opensymphony.xwork2.ActionSupport

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.opensymphony.xwork2.ValidationAware

Field Detail

CONFIRM

ACCESS_DENIED

PAGE_NOT_FOUND

PLAN_KEY_CONTEXT

BUILD_KEY_CONTEXT

AGGREGATE_URL_PATTERN

cookieCutter

planManager

cachedPlanManager

buildDefinitionManager

projectManager

bambooPermissionManager

webInterfaceManager

administrationConfigurationAccessor

administrationConfigurationManager

administrationConfigurationPersister

dashboardCachingManager

bambooUserManager

planExecutionManager

pluginAccessor

environmentService

featureManager

Constructor Detail

BambooActionSupport

Method Detail

setProfile

doDefault

getBambooSession

getBamboo

getUser

getServerLifecycleState

setServerLifecycleProvider

doesLabelKeyHaveMatchingDescription

doesHelpLinkHaveMatchingTitle

getDescriptionFromLabelKey

hasGlobalPermission

hasGlobalPermission

hasGlobalAdminPermission

hasRestrictedAdminPermission

hasAdminPermission

hasPlanPermission

hasPlanPermission

hasEntityPermission

isRestrictedAdminEnabled

isEnableSignup

getConcurrentBuildsEnabled

isViewContactDetailsEnabled

hasBuilds

getPlan

getBreadCrumbs

setAuthenticationContext

forceRelativeReturnUrl

getReturnUrl

setReturnUrl

getCurrentUrl

getCurrentSystemTime

getCookieValue

getBambooLicenseManager

setBambooLicenseManager

getBootstrapManager

getWebItemsForSection

getWebSectionsForLocation

renderFreemarkerTemplate

getWebFragmentsContextMap

getJsonObject

buildJsonObject

addActionError

hasActionWarnings