com.atlassian.bamboo.configuration
Class AbstractConfigurationAction

java.lang.Object
  com.opensymphony.xwork.ActionSupport
      com.atlassian.bamboo.ww2.BambooActionSupport
          com.atlassian.bamboo.configuration.AbstractLicenseAction
              com.atlassian.bamboo.configuration.AbstractConfigurationAction

All Implemented Interfaces:

ErrorCollection, BambooSessionAware, DomainObjectSecurityAware, GlobalReadSecurityAware, ReturnUrlAware, 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:

ConfigurationAction, WelcomeWizard1

public abstract class AbstractConfigurationAction
extends AbstractLicenseAction

This provides common System configuration behaviour - used in both the welcome wizard and the System Properties page.

See Also:

Serialized Form

Field Summary

static java.lang.String

SETUP_MARKER

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

buildManager, CONFIRM, cookieCutter, dashboardCachingManager

Fields inherited from class com.opensymphony.xwork.ActionSupport

LOG

Fields inherited from interface com.opensymphony.xwork.Action

ERROR, INPUT, LOGIN, NONE, SUCCESS

Constructor Summary

protected

AbstractConfigurationAction()

Method Summary

protected void	customPostProcess(AdministrationConfiguration administrationConfiguration)
java.lang.String	doExecute() Update the system with the adimistration configuration.
boolean	getAcceptRemoteApiCalls() Informs the UI if the Remote API option is enabled.
java.lang.String	getBaseUrl() Supply the form with the base url so the form does not loose it
java.lang.String	getBuildDirectory()
BuilderManager	getBuilderManager()
java.lang.String	getDefaultBaseUrl() See if we can determine the default base url from the servlet request...
java.lang.String	getEmailSubjectPrefix() What email subject prefix should Bamboo use?
FileBasedPersisterOptions	getFilePersisterOptions() Provide the GUI with the file persister
java.lang.String	getFromEmailAddress() Which email address should Bamboo use to send emails from.
boolean	getGzipCompression() Informs the UI if the Gzip option is enabled.
java.lang.String	getInstanceName() Get and Set the name of the Bamboo Instance
java.lang.String	getRepositoryPollingPeriod()
java.lang.String	getSmtpServer() Supply the form with the base url so the form does not loose it
void	setAcceptRemoteApiCalls(boolean enabled) The user has enabled the remote API (via a checkbox)
void	setBaseUrl(java.lang.String url) Accept the base url of the system from the html form.
void	setBuildDirectory(java.lang.String buildDirectory)
void	setBuilderManager(BuilderManager builderManager)
void	setEmailSubjectPrefix(java.lang.String emailSubjectPrefix) Accept the email subject prefix from the html form.
void	setFileBasedPersisterOptions(FileBasedPersisterOptions myFileBasedPersisterOptions)
void	setFromEmailAddress(java.lang.String fromEmailAddress) Accept the email originating address from the html form.
void	setGzipCompression(boolean enabled) The user has selected the GZip webpages (via a checkbox)
void	setInstanceName(java.lang.String instanceName)
void	setRepositoryPollingPeriod(java.lang.String repositoryPollingPeriod)
void	setSmtpServer(java.lang.String smtpServerUrl) Accept the SMTP server url of the system from the html form.
void	validate()

Methods inherited from class com.atlassian.bamboo.configuration.AbstractLicenseAction

getLicense, setLicense

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

addError, addError, addErrorCollection, addErrorMessage, addErrorMessage, addErrorMessages, addErrors, addIllegalArgumentException, areCheckBoxesEmpty, doDefault, doesLabelKeyHaveMatchingDescription, execute, getAdministrationConfiguration, getAsPreformattedText, getBamboo, getBambooLicenseManager, getBambooSession, getBambooUserManager, getBootstrapManager, getBreadCrumbs, getBuildManager, getConglomerateCookieValue, getCookieCutter, getCookieValue, getCurrentSystemTime, getCurrentUrl, getDefaultPersister, getDescriptionFromLabelKey, getFlushedErrorMessages, getReturnUrl, getSecuredDomainObject, getSessionUser, getTotalErrors, getUser, getWebFragmentsContextMap, getWebItemsForSection, getWebResourceManager, getWebSectionsForLocation, hasAnyErrors, hasBuilds, hasGlobalPermission, hasPlanPermission, hasPlanPermission, isEnableSignup, isSelectFieldAndNull, renderFreemarkerTemplate, setAdministrationConfiguration, setAuthenticationContext, setBambooLicenseManager, setBambooPermissionManager, setBambooUserManager, setBuildManager, setCookieCutter, setDashboardCachingManager, setErrorMessages, setHtmlUtils, setReturnUrl, setWebInterfaceManager, setWebResourceManager

Methods inherited from class com.opensymphony.xwork.ActionSupport

addActionError, addActionMessage, addFieldError, clearErrorsAndMessages, clone, doInput, getActionErrors, getActionMessages, getErrorMessages, getErrors, getFieldErrors, getLocale, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTexts, getTexts, hasActionErrors, hasActionMessages, hasErrors, hasFieldErrors, hasKey, pause, setActionErrors, setActionMessages, setFieldErrors

Methods inherited from class java.lang.Object

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

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

getErrorMessages, getErrors, getFieldErrors

Field Detail

SETUP_MARKER

public static final java.lang.String SETUP_MARKER

See Also:

Constant Field Values

Constructor Detail

AbstractConfigurationAction

protected AbstractConfigurationAction()

Method Detail

validate

public void validate()

Specified by:

validate in interface com.opensymphony.xwork.Validateable

Overrides:

validate in class com.opensymphony.xwork.ActionSupport

getBaseUrl

public java.lang.String getBaseUrl()

Supply the form with the base url so the form does not loose it

Overrides:

getBaseUrl in class BambooActionSupport

Returns:

The base url

setBaseUrl

public void setBaseUrl(java.lang.String url)

Accept the base url of the system from the html form.

Adds a form error if the given url is not specified.

Parameters:

url - The email

getSmtpServer

public java.lang.String getSmtpServer()

Supply the form with the base url so the form does not loose it

Returns:

The base url

setSmtpServer

public void setSmtpServer(java.lang.String smtpServerUrl)

Accept the SMTP server url of the system from the html form.

Adds a form error if the given smtpServerUrl is not specified.

Parameters:

smtpServerUrl - The email server

getEmailSubjectPrefix

public java.lang.String getEmailSubjectPrefix()

What email subject prefix should Bamboo use?

Returns:

The prefix

setEmailSubjectPrefix

public void setEmailSubjectPrefix(java.lang.String emailSubjectPrefix)

Accept the email subject prefix from the html form.

Parameters:

emailSubjectPrefix -

getFromEmailAddress

public java.lang.String getFromEmailAddress()

Which email address should Bamboo use to send emails from.

Returns:

The email address

setFromEmailAddress

public void setFromEmailAddress(java.lang.String fromEmailAddress)

Accept the email originating address from the html form.

Parameters:

fromEmailAddress - The email address bamboo sends email from

getFilePersisterOptions

public FileBasedPersisterOptions getFilePersisterOptions()

Provide the GUI with the file persister

Returns:

The file persister

setFileBasedPersisterOptions

public void setFileBasedPersisterOptions(FileBasedPersisterOptions myFileBasedPersisterOptions)

getRepositoryPollingPeriod

public java.lang.String getRepositoryPollingPeriod()

setRepositoryPollingPeriod

public void setRepositoryPollingPeriod(java.lang.String repositoryPollingPeriod)

getBuildDirectory

public java.lang.String getBuildDirectory()

setBuildDirectory

public void setBuildDirectory(java.lang.String buildDirectory)

setGzipCompression

public void setGzipCompression(boolean enabled)

The user has selected the GZip webpages (via a checkbox)

Parameters:

enabled - set to "on" by the webwork framework

getGzipCompression

public boolean getGzipCompression()

Informs the UI if the Gzip option is enabled.

Returns:

true if the pages should be compressed, false if not.

setAcceptRemoteApiCalls

public void setAcceptRemoteApiCalls(boolean enabled)

The user has enabled the remote API (via a checkbox)

Parameters:

enabled - set to "on" by the webwork framework

getAcceptRemoteApiCalls

public boolean getAcceptRemoteApiCalls()

Informs the UI if the Remote API option is enabled.

Returns:

true if the API is enabled, false if not.

doExecute

public java.lang.String doExecute()
                           throws java.lang.Exception

Update the system with the adimistration configuration.

Overrides:

doExecute in class BambooActionSupport

Returns:

WebWork status

Throws:

java.lang.Exception - something nasty went wrong

customPostProcess

protected void customPostProcess(AdministrationConfiguration administrationConfiguration)

setBuilderManager

public void setBuilderManager(BuilderManager builderManager)

getBuilderManager

public BuilderManager getBuilderManager()

getDefaultBaseUrl

public java.lang.String getDefaultBaseUrl()

See if we can determine the default base url from the servlet request... otherwise use a preset default one

Returns:

The url

getInstanceName

public java.lang.String getInstanceName()

Get and Set the name of the Bamboo Instance

Overrides:

getInstanceName in class BambooActionSupport

setInstanceName

public void setInstanceName(java.lang.String instanceName)