com.atlassian.bamboo.ww2
Class BambooActionSupport

java.lang.Object
  extended by com.opensymphony.xwork.ActionSupport
      extended by com.atlassian.bamboo.ww2.BambooActionSupport
All Implemented Interfaces:
ErrorCollection, BambooSessionAware, NavigationAware, DomainObjectSecurityAware, GlobalReadSecurityAware, ReturnUrlAware, com.atlassian.core.i18n.I18nTextProvider, com.opensymphony.xwork.Action, com.opensymphony.xwork.LocaleProvider, com.opensymphony.xwork.TextProvider, com.opensymphony.xwork.Validateable, com.opensymphony.xwork.ValidationAware, com.uwyn.rife.continuations.ContinuableObject, java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
AbstractAdminRestAction, AbstractDeploymentVersionAction, AbstractEntityPagerSupport, AbstractJiraIssueAction, AbstractJiraRelatedAction, AbstractNotificationBulkAction, AbstractPermissionAction, AbstractPluginConfigurationAction, AbstractRepositoryBulkAction, AbstractSetupAction, AccessDeniedAction, AddPermissionAction, AdminErrorAction, AdministerAction, AdministerAuthors, AgentJsonProvider, AllBuildsRssFeedAction, AllowLicenseUpdateOrShowExpirationInfo, BambooAgentInstallerAction, BuildExpiryAction, BuildJsonProviderAction, BuildList, BulkPlanAction, ChainResultProviderAction, ChangeForgottenPassword, ChangePassword, ConfigureAlias, ConfigureArtifactHandlers, ConfigureCloverPlugin, ConfigureDeploymentProject, ConfigureDeploymentProjectVersioning, ConfigureEnvironment, ConfigureEnvironmentAgents, ConfigureEnvironmentNotifications, ConfigureEnvironmentTasks, ConfigureEnvironmentTriggers, ConfigureGlobalBuildHangingDetection, ConfigureGroup, ConfigureProfile, ConfigureUser, ConfigureVariablesForEnvironment, CreateChain, CreateDeploymentProjectDetails, CreateDeploymentVersion, CreateEnvironment, CronExpressionGeneratorAction, DeleteBuilds, DeleteDeploymentProject, DeleteDeploymentResult, DeleteEnvironment, DescribeAgentAvailability, ErrorAction, ExecuteManualDeployment, FilterCookieWriterAction, FiveOhOh, ForgotPassword, GetFingerprintAction, GlobalAdminAction, GotoAuthors, ImportMavenPlanAction, JiraRedirectAction, ListRunningInstances, Login, Login, Logout, Logout, LogToServer, MoveEnvironment, PerformanceStatsAction, PerformanceStatsJmxAction, PlanActionSupport, PlanStatusHistoryAction, Profile, RepositorySettingsAction, RssFeedAction, SetAgentBuildFilter, SignupUser, StarterAction, StopDeployment, SystemErrorList, SystemInfoAction, TestOgnlEscaping, UpdateResponsibilitiesAction, ViewAdministrators, ViewAgent, ViewAgentDetailsAction, ViewAgents, ViewAggregatedAuthors, ViewAllDeploymentProjects, ViewAuthor, ViewAuthorChart, ViewAuthors, ViewAuthors, ViewBuildResultsForLabelAction, ViewBuildResultsTable, ViewDeploymentProjects, ViewDeploymentResult, ViewEnvironment, ViewGlobalAuditLogAction, ViewProject, ViewRejectedRequirements, ViewRemoteAgentAuthentications, ViewReport, ViewReportChart, ViewUserSummary

public class BambooActionSupport
extends com.opensymphony.xwork.ActionSupport
implements ErrorCollection, ReturnUrlAware, BambooSessionAware, GlobalReadSecurityAware, com.atlassian.core.i18n.I18nTextProvider, NavigationAware

See Also:
Serialized Form

Nested Class Summary
static class BambooActionSupport.JSONStatus
           
 
Field Summary
static java.lang.String ACCESS_DENIED
           
protected  AdministrationConfigurationAccessor administrationConfigurationAccessor
           
protected  AdministrationConfigurationManager administrationConfigurationManager
           
static java.lang.String AGGREGATE_URL_PATTERN
           
protected  BambooPermissionManager bambooPermissionManager
           
protected  BambooUserManager bambooUserManager
           
static java.lang.String BUILD_KEY_CONTEXT
           
protected  BuildDefinitionManager buildDefinitionManager
           
protected  CachedPlanManager cachedPlanManager
           
static java.lang.String CONFIRM
           
protected  CookieCutter cookieCutter
           
protected  DashboardCachingManager dashboardCachingManager
           
protected  DeploymentProjectService deploymentProjectService
           
protected  EnvironmentService environmentService
           
protected  FeatureManager featureManager
           
static java.lang.String PLAN_KEY_CONTEXT
           
protected  PlanExecutionManager planExecutionManager
           
protected  PlanManager planManager
           
protected  ProjectManager projectManager
           
protected  com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager
           
 
Fields inherited from class com.opensymphony.xwork.ActionSupport
LOG
 
Fields inherited from interface com.opensymphony.xwork.Action
ERROR, INPUT, LOGIN, NONE, SUCCESS
 
Constructor Summary
BambooActionSupport()
           
 
Method Summary
 void addActionError(java.lang.String errorMessage)
           
 void addActionWarning(java.lang.String errorMessage)
           
 void addError(java.lang.String field, java.lang.String message)
          Deprecated. since 1.0 Use ActionSupport.addFieldError(String, String) instead
 void addError(java.lang.String prefix, java.lang.String field, java.lang.String message)
          Adds a new form validation error with a given prefix.
 void addErrorCollection(ErrorCollection errors)
          Populate this ErrorCollection with general and field-specific errors.
 java.lang.String addErrorMessage(java.lang.String message)
          Deprecated. since 1.0 Use addActionError(String) instead
 java.lang.String addErrorMessage(java.lang.String message, java.lang.Exception e)
           
 void addErrorMessages(java.util.Collection<java.lang.String> errorMessages)
          Append new error messages to those already collected.
 void addErrors(java.util.Map<java.lang.String,?> errors)
          Append new field-specific errors to those already collected.
 void addHelpPanel(java.lang.String helpPanel)
           
 void addIllegalArgumentException(java.lang.String field, java.lang.IllegalArgumentException e)
           
protected  boolean areCheckBoxesEmpty(java.lang.String field)
           
protected  com.opensymphony.webwork.dispatcher.json.JSONObject buildJsonObject()
          Builds JSONObject and sets 'status', 'errors' and 'fieldErrors' properties accordingly.
protected  java.util.Map<java.lang.String,java.lang.Object> buildWebPanelContext(java.lang.String location)
          Builds a context suitable for rendering WebPanels via FreemarkerContext.getWebPanels(String) In the future the results of this method may be cached
protected  void checkFieldXssSafety(java.lang.String fieldName, java.lang.String fieldValue)
           
protected
<T extends com.opensymphony.xwork.validator.FieldValidator>
T
createFieldValidator(java.lang.String fieldName, java.lang.Class<T> validatorClass, java.lang.String messageKey, java.lang.String[] messageParameters)
          Create WebWork's field validator
 java.lang.String doDefault()
          Default action just sends to the input
 boolean doesHelpLinkHaveMatchingTitle(java.lang.String helpKey)
           
 boolean doesLabelKeyHaveMatchingDescription(java.lang.String labelKey)
           
 java.lang.String doExecute()
          Places the current user on the page
 java.lang.String execute()
           
protected  void forceRelativeReturnUrl()
          converts current return URL to a path rooted under context.
 java.util.List<java.lang.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()
           
 java.lang.String getBaseUrl()
           
 java.lang.String getBestBaseUrl()
           
 BootstrapManager getBootstrapManager()
           
 java.util.Collection<BreadCrumb> getBreadCrumbs()
           
 java.lang.String getChainEquiv()
           
 boolean getConcurrentBuildsEnabled()
           
 java.lang.String getConglomerateCookieValue(java.lang.String cookieKey, java.lang.String conglomerateKey)
           
 CookieCutter getCookieCutter()
           
 java.lang.String getCookieValue(java.lang.String key)
           
 java.lang.String getCurrentFormTheme()
           
 java.lang.Long getCurrentSystemTime()
           
static java.lang.String getCurrentUrl()
           
protected  Persister getDefaultPersister()
           
 DeploymentProject getDeploymentProject(long environmentId)
           
 java.lang.String getDescriptionFromLabelKey(java.lang.String labelKey)
           
 ElasticConfiguration getElasticConfig()
           
 FeatureManager getFeatureManager()
           
 java.util.Set<java.lang.String> getFieldErrorAccessTracker()
           
 java.util.Map getFieldErrors()
           
 java.util.Collection<java.lang.String> getFlushedErrorMessages()
          Get error messages, then get rid of them.
 java.util.Collection<java.lang.String> getFormattedActionErrors()
           
 java.util.List<java.lang.String> getFormattedActionMessages()
           
 java.util.Collection<java.lang.String> getFormattedErrorMessages()
          Deprecated. since 3.0 use #getFormattedActionErrors
 java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getHelpPanels()
           
 java.lang.String getInstanceName()
           
 java.lang.String getJobEquiv()
           
 com.opensymphony.webwork.dispatcher.json.JSONObject getJsonObject()
          This is default property read by webwork for webwork's result type "json".
 NavigationContext getNavigationContext()
           
 java.lang.String getNavigationUrl()
          The url of the current action.
 int getNumberOfCurrentlyBuildingPlans(java.lang.String planKey)
           
 ImmutableChain getPlan(java.lang.String planKey)
           
 PlanManager getPlanManager()
           
 com.atlassian.plugin.PluginAccessor getPluginAccessor()
           
 java.lang.String getReturnUrl()
           
 java.lang.Object getSecuredDomainObject()
           
 ServerLifecycleState getServerLifecycleState()
           
 BambooUser getSessionUser(java.lang.String auth)
           
 java.lang.String getText(java.lang.String key)
           
 java.lang.String getText(java.lang.String key, java.util.List args)
           
 java.lang.String getText(java.lang.String s, java.lang.Object[] objects)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue)
           
 java.lang.String getText(java.lang.String key, java.lang.String[] args)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.util.List args)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.util.List args, com.opensymphony.xwork.util.OgnlValueStack stack)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String obj)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String[] args)
           
 java.lang.String getText(java.lang.String key, java.lang.String defaultValue, java.lang.String[] args, com.opensymphony.xwork.util.OgnlValueStack stack)
           
protected  com.opensymphony.xwork.TextProvider getTextProvider()
           
 java.util.ResourceBundle getTexts()
           
 java.util.ResourceBundle getTexts(java.lang.String bundleName)
           
 java.lang.String getTextWithArgs(java.lang.String key, java.lang.String... args)
           
 int getTotalErrors()
           
 com.atlassian.user.User getUser()
           
protected  com.opensymphony.xwork.validator.DelegatingValidatorContext getValidatorContext()
          Can be used for WebWork's validation
 java.util.Map<java.lang.String,java.lang.Object> getWebFragmentsContextMap()
           
 java.util.List<com.atlassian.plugin.web.descriptors.WebItemModuleDescriptor> getWebItemsForSection(java.lang.String sectionName)
           
 java.util.Map<java.lang.String,java.lang.Object> getWebPanelContext(java.lang.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
 java.util.List<com.atlassian.plugin.web.descriptors.WebSectionModuleDescriptor> getWebSectionsForLocation(java.lang.String location)
           
 boolean hasActionWarnings()
           
 boolean hasAdminPermission()
           
 boolean hasAnyErrors()
          Whether any errors (of any type - field-specific or otherwise) have been collected.
 boolean hasBuilds()
           
 boolean hasEntityPermission(java.lang.String permission, java.lang.Object object)
           
 boolean hasGlobalAdminPermission()
           
 boolean hasGlobalPermission(org.acegisecurity.acls.Permission permission)
           
 boolean hasGlobalPermission(java.lang.String permission)
          Does this user have the global permission right?
 boolean hasKey(java.lang.String key)
           
 boolean hasLinkedDeployments(PlanKey planKey)
           
 boolean hasPlanPermission(java.lang.String permission, PlanIdentifier plan)
           
 boolean hasPlanPermission(java.lang.String permission, java.lang.String buildKey)
          You should always prefer using $hasPlanPermission(String, PlanIdentifier) if you have or you are about to have Plan reference.
 boolean hasRestrictedAdminPermission()
           
 boolean isCheckboxSetInAction(java.lang.String checkboxName)
           
 boolean isEc2ConfigurationWarningRequired()
           
 boolean isEnableJavascript()
           
 boolean isEnableSignup()
           
 boolean isInlineDialog()
           
 boolean isRestrictedAdminEnabled()
           
 boolean isSelectFieldAndNull(java.lang.String buildKeysField)
           
 boolean isViewContactDetailsEnabled()
           
 java.lang.String renderFreemarkerTemplate(java.lang.String templateString)
           
 void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)
           
 void setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)
           
 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(java.lang.String chainEquiv)
           
 void setCheckBoxFields(java.lang.String[] checkBoxFields)
           
 void setCookieCutter(CookieCutter cookieCutter)
           
 void setCurrentFormTheme(java.lang.String currentFormTheme)
           
 void setDashboardCachingManager(DashboardCachingManager dashboardCachingManager)
           
 void setDecorator(java.lang.String decorator)
           
 void setDeploymentProjectService(DeploymentProjectService deploymentProjectService)
           
 void setEnableJavascript(boolean enableJavascript)
           
 void setEnvironmentService(EnvironmentService environmentService)
           
 void setErrorMessages(java.util.Collection<java.lang.String> errorMessages)
          Deprecated. since 1.0 Use ActionSupport.setActionErrors(Collection) instead
 void setFeatureManager(FeatureManager featureManager)
           
 void setI18nBeanFactory(I18nBeanFactory i18nBeanFactory)
           
 void setJobEquiv(java.lang.String jobEquiv)
           
 void setJsonator(Jsonator jsonator)
           
 void setLinkedDeploymentProjectCacheService(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(java.lang.String value)
           
 void setProjectManager(ProjectManager projectManager)
           
 void setReturnUrl(java.lang.String returnUrl)
           
 void setServerLifecycleProvider(ServerLifecycleProvider serverLifecycleProvider)
           
 void setWebInterfaceManager(com.atlassian.plugin.web.WebInterfaceManager webInterfaceManager)
           
 java.lang.String toJson(java.lang.Object object)
           
 java.lang.String toJson(java.lang.Object object, Jsonator.EnumConversionMode enumConversionMode)
           
 
Methods inherited from class com.opensymphony.xwork.ActionSupport
addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getLocale, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, pause, setActionErrors, setActionMessages, 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
 

Field Detail

CONFIRM

public static final java.lang.String CONFIRM
See Also:
Constant Field Values

ACCESS_DENIED

public static final java.lang.String ACCESS_DENIED
See Also:
Constant Field Values

PLAN_KEY_CONTEXT

public static final java.lang.String PLAN_KEY_CONTEXT
See Also:
Constant Field Values

BUILD_KEY_CONTEXT

public static final java.lang.String BUILD_KEY_CONTEXT
See Also:
Constant Field Values

AGGREGATE_URL_PATTERN

public static final java.lang.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

protected AdministrationConfigurationManager administrationConfigurationManager

dashboardCachingManager

protected DashboardCachingManager dashboardCachingManager

bambooUserManager

protected BambooUserManager bambooUserManager

planExecutionManager

protected PlanExecutionManager planExecutionManager

environmentService

protected EnvironmentService environmentService

deploymentProjectService

protected DeploymentProjectService deploymentProjectService

featureManager

protected FeatureManager featureManager
Constructor Detail

BambooActionSupport

public BambooActionSupport()
Method Detail

setProfile

public void setProfile(java.lang.String value)

doDefault

public java.lang.String doDefault()
                           throws java.lang.Exception
Default action just sends to the input

Overrides:
doDefault in class com.opensymphony.xwork.ActionSupport
Returns:
Throws:
java.lang.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(java.lang.String labelKey)

doesHelpLinkHaveMatchingTitle

public boolean doesHelpLinkHaveMatchingTitle(java.lang.String helpKey)

getDescriptionFromLabelKey

public java.lang.String getDescriptionFromLabelKey(java.lang.String labelKey)

hasGlobalPermission

public boolean hasGlobalPermission(java.lang.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(java.lang.String permission,
                                 java.lang.String buildKey)
You should always prefer using $hasPlanPermission(String, PlanIdentifier) if you have or you are about to have Plan reference.


hasPlanPermission

public boolean hasPlanPermission(java.lang.String permission,
                                 PlanIdentifier plan)

hasEntityPermission

public boolean hasEntityPermission(java.lang.String permission,
                                   java.lang.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(java.lang.String planKey)

getBreadCrumbs

public java.util.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 java.lang.String getReturnUrl()
Specified by:
getReturnUrl in interface ReturnUrlAware

setReturnUrl

public void setReturnUrl(java.lang.String returnUrl)
Specified by:
setReturnUrl in interface ReturnUrlAware

getCurrentUrl

@Nullable
public static java.lang.String getCurrentUrl()

getCurrentSystemTime

public java.lang.Long getCurrentSystemTime()

getCookieValue

@NotNull
public java.lang.String getCookieValue(java.lang.String key)

getBambooLicenseManager

protected BambooLicenseManager getBambooLicenseManager()

setBambooLicenseManager

public void setBambooLicenseManager(BambooLicenseManager bambooLicenseManager)

getBootstrapManager

public BootstrapManager getBootstrapManager()

getWebItemsForSection

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

getWebSectionsForLocation

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

renderFreemarkerTemplate

public java.lang.String renderFreemarkerTemplate(java.lang.String templateString)

getWebFragmentsContextMap

public java.util.Map<java.lang.String,java.lang.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
                           java.lang.String errorMessage)
Specified by:
addActionError in interface com.opensymphony.xwork.ValidationAware
Overrides:
addActionError in class com.opensymphony.xwork.ActionSupport

hasActionWarnings

public boolean hasActionWarnings()

getActionWarnings

@NotNull
public java.util.List<java.lang.String> getActionWarnings()

addActionWarning

public void addActionWarning(@Nullable
                             java.lang.String errorMessage)

addError

public void addError(java.lang.String prefix,
                     java.lang.String field,
                     java.lang.String message)
Description copied from interface: ErrorCollection
Adds a new form validation error with a given prefix. ie. prefix of "builder.ant" and field "target" will result in a key of "builder.ant.target"

Specified by:
addError in interface ErrorCollection
Parameters:
prefix - The prefix of the field in . form
field - The id of the form element in error
message - The error message to display to the user

getFlushedErrorMessages

public java.util.Collection<java.lang.String> getFlushedErrorMessages()
Description copied from interface: ErrorCollection
Get error messages, then get rid of them.

Specified by:
getFlushedErrorMessages in interface ErrorCollection
Returns:
The (now cleared) error messages.

addErrorCollection

public void addErrorCollection(@NotNull
                               ErrorCollection errors)
Description copied from interface: ErrorCollection
Populate this ErrorCollection with general and field-specific errors.

Specified by:
addErrorCollection in interface ErrorCollection
Parameters:
errors - ErrorCollection whose errors/messages we obtain.

addErrorMessages

public void addErrorMessages(java.util.Collection<java.lang.String> errorMessages)
Description copied from interface: ErrorCollection
Append new error messages to those already collected.

Specified by:
addErrorMessages in interface ErrorCollection
Parameters:
errorMessages - Collection of error strings.

addErrors

public void addErrors(java.util.Map<java.lang.String,?> errors)
Description copied from interface: ErrorCollection
Append new field-specific errors to those already collected.

Specified by:
addErrors in interface ErrorCollection
Parameters:
errors - A Map from String field names, to String error messages, or Collections of String error messages.

hasAnyErrors

public boolean hasAnyErrors()
Description copied from interface: ErrorCollection
Whether any errors (of any type - field-specific or otherwise) have been collected.

Specified by:
hasAnyErrors in interface ErrorCollection
Returns:
true if there are errors; false otherwise.

getTotalErrors

public int getTotalErrors()
Specified by:
getTotalErrors in interface ErrorCollection

getFieldErrors

public java.util.Map getFieldErrors()
Specified by:
getFieldErrors in interface ErrorCollection
Specified by:
getFieldErrors in interface com.opensymphony.xwork.ValidationAware
Overrides:
getFieldErrors in class com.opensymphony.xwork.ActionSupport

addError

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

Description copied from interface: ErrorCollection
Add a field-specific error message.

Specified by:
addError in interface ErrorCollection
Parameters:
field - Field name, eg. "assignee"
message - Error message.

addErrorMessage

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

Description copied from interface: ErrorCollection
Add error message relating to system state (not field-specific).

Specified by:
addErrorMessage in interface ErrorCollection
Parameters:
message - Error message.

setErrorMessages

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

Description copied from interface: ErrorCollection
Populate this ErrorCollection with a new set of messages (existing errors are lost).

Specified by:
setErrorMessages in interface ErrorCollection
Parameters:
errorMessages - List of error message Strings.

addErrorMessage

public java.lang.String addErrorMessage(java.lang.String message,
                                        java.lang.Exception e)
Specified by:
addErrorMessage in interface ErrorCollection

addIllegalArgumentException

public void addIllegalArgumentException(java.lang.String field,
                                        java.lang.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(java.lang.String buildKeysField)

getConglomerateCookieValue

public java.lang.String getConglomerateCookieValue(java.lang.String cookieKey,
                                                   java.lang.String conglomerateKey)

getDefaultPersister

protected Persister getDefaultPersister()

areCheckBoxesEmpty

protected boolean areCheckBoxesEmpty(java.lang.String field)

getAdministrationConfiguration

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

Returns:
The admin settings

getBaseUrl

@Nullable
public java.lang.String getBaseUrl()

getBambooUrl

public BambooUrl getBambooUrl()

getBestBaseUrl

@Nullable
public java.lang.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 java.lang.String getInstanceName()

checkFieldXssSafety

protected void checkFieldXssSafety(java.lang.String fieldName,
                                   java.lang.String fieldValue)

getValidatorContext

protected com.opensymphony.xwork.validator.DelegatingValidatorContext getValidatorContext()
Can be used for WebWork's validation

Returns:

createFieldValidator

@Nullable
protected <T extends com.opensymphony.xwork.validator.FieldValidator> T createFieldValidator(@NotNull
                                                                                                      java.lang.String fieldName,
                                                                                                      @NotNull
                                                                                                      java.lang.Class<T> validatorClass,
                                                                                                      @NotNull
                                                                                                      java.lang.String messageKey,
                                                                                                      @Nullable
                                                                                                      java.lang.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 java.lang.String getText(java.lang.String s,
                                java.lang.Object[] objects)
Specified by:
getText in interface com.atlassian.core.i18n.I18nTextProvider

getTextProvider

protected com.opensymphony.xwork.TextProvider getTextProvider()

hasKey

public boolean hasKey(java.lang.String key)
Specified by:
hasKey in interface com.opensymphony.xwork.TextProvider
Overrides:
hasKey in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key)
Specified by:
getText in interface com.atlassian.core.i18n.I18nTextProvider
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String obj)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.util.List args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String[] args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getTextWithArgs

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

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.util.List args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.util.List args,
                                com.opensymphony.xwork.util.OgnlValueStack stack)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getText

public java.lang.String getText(java.lang.String key,
                                java.lang.String defaultValue,
                                java.lang.String[] args,
                                com.opensymphony.xwork.util.OgnlValueStack stack)
Specified by:
getText in interface com.opensymphony.xwork.TextProvider
Overrides:
getText in class com.opensymphony.xwork.ActionSupport

getTexts

public java.util.ResourceBundle getTexts(java.lang.String bundleName)
Specified by:
getTexts in interface com.opensymphony.xwork.TextProvider
Overrides:
getTexts in class com.opensymphony.xwork.ActionSupport

getTexts

public java.util.ResourceBundle getTexts()
Specified by:
getTexts in interface com.opensymphony.xwork.TextProvider
Overrides:
getTexts in class com.opensymphony.xwork.ActionSupport

doExecute

public java.lang.String doExecute()
                           throws java.lang.Exception
Places the current user on the page

Returns:
webwork success status
Throws:
java.lang.Exception - something nasty went wrong

execute

public java.lang.String execute()
                         throws java.lang.Exception
Specified by:
execute in interface com.opensymphony.xwork.Action
Overrides:
execute in class com.opensymphony.xwork.ActionSupport
Throws:
java.lang.Exception

setCheckBoxFields

public void setCheckBoxFields(java.lang.String[] checkBoxFields)

isCheckboxSetInAction

public boolean isCheckboxSetInAction(@NotNull
                                     java.lang.String checkboxName)

getNavigationUrl

public java.lang.String getNavigationUrl()
Description copied from interface: NavigationAware
The url of the current action.

Specified by:
getNavigationUrl in interface NavigationAware
Returns:

getChainEquiv

public java.lang.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(java.lang.String chainEquiv)

getJobEquiv

public java.lang.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(java.lang.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(java.lang.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 java.lang.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(java.lang.String auth)
                          throws BambooRemoteException
Throws:
BambooRemoteException

isEnableJavascript

public boolean isEnableJavascript()

setEnableJavascript

public void setEnableJavascript(boolean enableJavascript)

getCurrentFormTheme

public java.lang.String getCurrentFormTheme()

setCurrentFormTheme

public void setCurrentFormTheme(java.lang.String currentFormTheme)

setAdministrationConfigurationAccessor

public void setAdministrationConfigurationAccessor(AdministrationConfigurationAccessor administrationConfigurationAccessor)

setAdministrationConfigurationManager

public void setAdministrationConfigurationManager(AdministrationConfigurationManager administrationConfigurationManager)

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(Jsonator jsonator)

setDeploymentProjectService

public void setDeploymentProjectService(DeploymentProjectService deploymentProjectService)

setEnvironmentService

public void setEnvironmentService(EnvironmentService environmentService)

getFormattedActionErrors

public java.util.Collection<java.lang.String> getFormattedActionErrors()

getFormattedActionMessages

public java.util.List<java.lang.String> getFormattedActionMessages()

getFormattedErrorMessages

@Deprecated
public java.util.Collection<java.lang.String> getFormattedErrorMessages()
Deprecated. since 3.0 use #getFormattedActionErrors

Returns:
list of formatted action error messages

getWebPanelContext

@NotNull
public final java.util.Map<java.lang.String,java.lang.Object> getWebPanelContext(@NotNull
                                                                                         java.lang.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 java.util.Map<java.lang.String,java.lang.Object> buildWebPanelContext(@NotNull
                                                                                        java.lang.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(java.lang.String decorator)

isInlineDialog

public boolean isInlineDialog()

getFieldErrorAccessTracker

public java.util.Set<java.lang.String> getFieldErrorAccessTracker()

toJson

public java.lang.String toJson(java.lang.Object object)

toJson

public java.lang.String toJson(java.lang.Object object,
                               Jsonator.EnumConversionMode enumConversionMode)

addHelpPanel

public void addHelpPanel(java.lang.String helpPanel)

getHelpPanels

public final java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getHelpPanels()

getDeploymentProject

public DeploymentProject getDeploymentProject(long environmentId)

setLinkedDeploymentProjectCacheService

public void setLinkedDeploymentProjectCacheService(LinkedDeploymentProjectCacheService linkedDeploymentProjectCacheService)


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.