com.atlassian.bamboo.configuration

Class AdministrationConfiguration

java.lang.Object

com.atlassian.bamboo.configuration.AdministrationConfiguration

All Implemented Interfaces:

AdministrationConfigurationInterface

Direct Known Subclasses:

AdministrationConfigurationImpl

public abstract class AdministrationConfiguration
extends Object
implements AdministrationConfigurationInterface

Administration configuration interface. When adding stuff please try keep alphabetical order of properties.

Constructor Summary

Constructors

Constructor and Description
AdministrationConfiguration()

Method Summary

Modifier and Type	Method and Description
abstract boolean	doesXsrfAllowMutativeGets()
abstract String	getBaseUrl() What is the base url for this server?
abstract int	getBranchDetectionCheckInterval() Get the interval between branch detection, in seconds (default is 300)
abstract BuildExpiryConfig	getBuildExpiryConfig()
abstract BuildHangingConfig	getBuildHangingConfig()
abstract CaptchaConfiguration	getCaptchaConfiguration()
abstract ConcurrentBuildConfig	getConcurrentBuildConfig()
abstract int	getDashboardPageSize()
abstract DeploymentExpiryConfig	getDeploymentExpiryConfig()
abstract ElasticConfiguration	getElasticConfig()
abstract String	getGravatarServerUrl()
abstract String	getInstanceName()
abstract QuarantineConfiguration	getQuarantineConfiguration()
abstract RepositorySettings	getRepositorySettings()
abstract boolean	getResolveArtifactContentTypeByExtension() Use correct Content-Type header when return artifact content.
abstract ScheduleBackupConfiguration	getScheduleBackupConfiguration()
abstract StorageLimits	getStorageLimit() Storage limits configuration.
abstract String	getSystemProperty(String key)
abstract boolean	isAuditLoggingEnabled()
abstract boolean	isDeploymentExpiryEnabled() Returns true if deployments expiry is enabled.
abstract boolean	isEnableAnonymousAccess()
abstract boolean	isEnableExternalUserManagement()
abstract boolean	isEnableRestrictedAdmin()
abstract boolean	isEnableSignup()
abstract boolean	isEnableViewContactDetails()
abstract boolean	isGravatarSupportEnabled()
abstract boolean	isRemoteAgentAuthenticationEnabled()
abstract boolean	isRemoteAgentFunctionEnabled()
abstract boolean	isSecurityTokenRequiredFromAgents() Whether security token is required from remote agents as a preliminary authentication method.
abstract boolean	isShowAdminContactDetailsToAnonymousUsers()
abstract boolean	isSoxComplianceModeEnabled() Whether Bamboo instance SOX compliance mode is enabled.
abstract boolean	isTestQuarantineEnabled() Deprecated. since 5.9 - use getQuarantineConfiguration() and then QuarantineConfiguration.isEnabled()
abstract boolean	isUseGzipCompression() Should we use gzip compression to compress Bamboo web pages?
abstract boolean	isXsrfProtectionEnabled()
abstract void	setAuditLoggingEnabled(boolean auditLoggingEnabled)
abstract void	setBaseUrl(String baseUrl) Define the system base url
abstract void	setBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in seconds
abstract void	setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig) Deprecated. since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfig
abstract void	setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)
abstract void	setDashboardPageSize(int dashboardPageSize)
abstract void	setDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig)
abstract void	setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Enable or disable deployment expiry
abstract void	setElasticConfig(ElasticConfiguration elasticConfig)
abstract void	setEnableAnonymousAccess(boolean enableAnonymousAccess)
abstract void	setEnableExternalUserManagement(boolean enableExternalUserManagement)
abstract void	setEnableRestrictedAdmin(boolean enableRestrictedAdmin)
abstract void	setEnableSignup(boolean enableSignup)
abstract void	setEnableTestQuarantine(boolean enableTestQuarantine) Deprecated. since 5.9 - use getQuarantineConfiguration() and then QuarantineConfiguration.setEnabled(boolean)
abstract void	setEnableViewContactDetails(boolean enableViewContactDetails)
abstract void	setGravatarServerUrl(String gravatarUrl)
abstract void	setGravatarSupportEnabled(boolean gravatarSupportEnabled)
abstract void	setInstanceName(String instanceName)
abstract void	setQuarantineConfiguration(QuarantineConfiguration quarantineConfiguration)
abstract void	setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled)
abstract void	setRemoteAgentFunctionEnabled(boolean enabled)
abstract void	setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension)
abstract void	setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)
abstract void	setSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents) Set whether security token is required from remote agents as a preliminary authentication method.
abstract void	setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers)
abstract void	setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Enables or disables Bamboo instance SOX compliance mode.
abstract void	setStorageLimit(StorageLimits storageLimits)
abstract void	setSystemProperty(String key, String value)
abstract void	setUnconfigurableFeatureDefaults(UnconfigurableFeatureDefaults unconfigurableFeatureDefaults)
abstract void	setUseGzipCompression(boolean useGzipCompression) Specify if we should we use gzip compression to compress Bamboo web pages.
abstract void	setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets)
abstract void	setXsrfProtectionEnabled(boolean xsrfProtectionEnabled)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.bamboo.configuration.AdministrationConfigurationInterface

getSerializationSecurityConfig, isManageAcceptedSshHostKeys, setManageAcceptedSshHostKeys, setSerializationSecurityConfig

Constructor Detail

AdministrationConfiguration

public AdministrationConfiguration()

Method Detail

isAuditLoggingEnabled

public abstract boolean isAuditLoggingEnabled()

Specified by:

isAuditLoggingEnabled in interface AdministrationConfigurationInterface

setAuditLoggingEnabled

public abstract void setAuditLoggingEnabled(boolean auditLoggingEnabled)

Specified by:

setAuditLoggingEnabled in interface AdministrationConfigurationInterface

getBaseUrl

public abstract String getBaseUrl()

What is the base url for this server?

Specified by:

getBaseUrl in interface AdministrationConfigurationInterface

Returns:

the base url

setBaseUrl

public abstract void setBaseUrl(String baseUrl)

Define the system base url

Specified by:

setBaseUrl in interface AdministrationConfigurationInterface

Parameters:

baseUrl - the url

getBranchDetectionCheckInterval

public abstract int getBranchDetectionCheckInterval()

Get the interval between branch detection, in seconds (default is 300)

Specified by:

getBranchDetectionCheckInterval in interface AdministrationConfigurationInterface

setBranchDetectionCheckInterval

public abstract void setBranchDetectionCheckInterval(int branchDetectionCheckInterval)

Set the interval between branch detection, in seconds

Specified by:

setBranchDetectionCheckInterval in interface AdministrationConfigurationInterface

Parameters:

branchDetectionCheckInterval -

isDeploymentExpiryEnabled

public abstract boolean isDeploymentExpiryEnabled()

Description copied from interface: AdministrationConfigurationInterface

Returns true if deployments expiry is enabled.

Specified by:

isDeploymentExpiryEnabled in interface AdministrationConfigurationInterface

setDeploymentExpiryEnabled

public abstract void setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled)

Description copied from interface: AdministrationConfigurationInterface

Enable or disable deployment expiry

Specified by:

setDeploymentExpiryEnabled in interface AdministrationConfigurationInterface

getBuildExpiryConfig

@NotNull
public abstract BuildExpiryConfig getBuildExpiryConfig()

Specified by:

getBuildExpiryConfig in interface AdministrationConfigurationInterface

setBuildExpiryConfig

@Deprecated
public abstract void setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig)

Deprecated. since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfig

Specified by:

setBuildExpiryConfig in interface AdministrationConfigurationInterface

getBuildHangingConfig

public abstract BuildHangingConfig getBuildHangingConfig()

Specified by:

getBuildHangingConfig in interface AdministrationConfigurationInterface

setBuildHangingConfig

public abstract void setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)

Specified by:

setBuildHangingConfig in interface AdministrationConfigurationInterface

getCaptchaConfiguration

@NotNull
public abstract CaptchaConfiguration getCaptchaConfiguration()

Specified by:

getCaptchaConfiguration in interface AdministrationConfigurationInterface

getConcurrentBuildConfig

@NotNull
public abstract ConcurrentBuildConfig getConcurrentBuildConfig()

Specified by:

getConcurrentBuildConfig in interface AdministrationConfigurationInterface

getDashboardPageSize

public abstract int getDashboardPageSize()

Specified by:

getDashboardPageSize in interface AdministrationConfigurationInterface

setDashboardPageSize

public abstract void setDashboardPageSize(int dashboardPageSize)

Specified by:

setDashboardPageSize in interface AdministrationConfigurationInterface

getDeploymentExpiryConfig

@NotNull
public abstract DeploymentExpiryConfig getDeploymentExpiryConfig()

Specified by:

getDeploymentExpiryConfig in interface AdministrationConfigurationInterface

setDeploymentExpiryConfig

public abstract void setDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig)

Specified by:

setDeploymentExpiryConfig in interface AdministrationConfigurationInterface

getElasticConfig

@Nullable
public abstract ElasticConfiguration getElasticConfig()

Specified by:

getElasticConfig in interface AdministrationConfigurationInterface

setElasticConfig

public abstract void setElasticConfig(ElasticConfiguration elasticConfig)

Specified by:

setElasticConfig in interface AdministrationConfigurationInterface

isEnableAnonymousAccess

public abstract boolean isEnableAnonymousAccess()

Specified by:

isEnableAnonymousAccess in interface AdministrationConfigurationInterface

setEnableAnonymousAccess

public abstract void setEnableAnonymousAccess(boolean enableAnonymousAccess)

Specified by:

setEnableAnonymousAccess in interface AdministrationConfigurationInterface

isEnableExternalUserManagement

public abstract boolean isEnableExternalUserManagement()

Specified by:

isEnableExternalUserManagement in interface AdministrationConfigurationInterface

setEnableExternalUserManagement

public abstract void setEnableExternalUserManagement(boolean enableExternalUserManagement)

Specified by:

setEnableExternalUserManagement in interface AdministrationConfigurationInterface

isEnableRestrictedAdmin

public abstract boolean isEnableRestrictedAdmin()

Specified by:

isEnableRestrictedAdmin in interface AdministrationConfigurationInterface

setEnableRestrictedAdmin

public abstract void setEnableRestrictedAdmin(boolean enableRestrictedAdmin)

Specified by:

setEnableRestrictedAdmin in interface AdministrationConfigurationInterface

isSoxComplianceModeEnabled

public abstract boolean isSoxComplianceModeEnabled()

Description copied from interface: AdministrationConfigurationInterface

Whether Bamboo instance SOX compliance mode is enabled.

Specified by:

isSoxComplianceModeEnabled in interface AdministrationConfigurationInterface

setSoxComplianceModeEnabled

public abstract void setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled)

Description copied from interface: AdministrationConfigurationInterface

Enables or disables Bamboo instance SOX compliance mode.

Specified by:

setSoxComplianceModeEnabled in interface AdministrationConfigurationInterface

isEnableSignup

public abstract boolean isEnableSignup()

Specified by:

isEnableSignup in interface AdministrationConfigurationInterface

setEnableSignup

public abstract void setEnableSignup(boolean enableSignup)

Specified by:

setEnableSignup in interface AdministrationConfigurationInterface

isEnableViewContactDetails

public abstract boolean isEnableViewContactDetails()

Specified by:

isEnableViewContactDetails in interface AdministrationConfigurationInterface

setEnableViewContactDetails

public abstract void setEnableViewContactDetails(boolean enableViewContactDetails)

Specified by:

setEnableViewContactDetails in interface AdministrationConfigurationInterface

getGravatarServerUrl

public abstract String getGravatarServerUrl()

Specified by:

getGravatarServerUrl in interface AdministrationConfigurationInterface

setGravatarServerUrl

public abstract void setGravatarServerUrl(String gravatarUrl)

Specified by:

setGravatarServerUrl in interface AdministrationConfigurationInterface

isShowAdminContactDetailsToAnonymousUsers

public abstract boolean isShowAdminContactDetailsToAnonymousUsers()

Specified by:

isShowAdminContactDetailsToAnonymousUsers in interface AdministrationConfigurationInterface

setShowAdminContactDetailsToAnonymousUsers

public abstract void setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers)

Specified by:

setShowAdminContactDetailsToAnonymousUsers in interface AdministrationConfigurationInterface

isGravatarSupportEnabled

public abstract boolean isGravatarSupportEnabled()

Specified by:

isGravatarSupportEnabled in interface AdministrationConfigurationInterface

setGravatarSupportEnabled

public abstract void setGravatarSupportEnabled(boolean gravatarSupportEnabled)

Specified by:

setGravatarSupportEnabled in interface AdministrationConfigurationInterface

getInstanceName

@NotNull
public abstract String getInstanceName()

Specified by:

getInstanceName in interface AdministrationConfigurationInterface

setInstanceName

public abstract void setInstanceName(String instanceName)

Specified by:

setInstanceName in interface AdministrationConfigurationInterface

isRemoteAgentAuthenticationEnabled

public abstract boolean isRemoteAgentAuthenticationEnabled()

Specified by:

isRemoteAgentAuthenticationEnabled in interface AdministrationConfigurationInterface

setRemoteAgentAuthenticationEnabled

public abstract void setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled)

Specified by:

setRemoteAgentAuthenticationEnabled in interface AdministrationConfigurationInterface

isRemoteAgentFunctionEnabled

public abstract boolean isRemoteAgentFunctionEnabled()

Specified by:

isRemoteAgentFunctionEnabled in interface AdministrationConfigurationInterface

setRemoteAgentFunctionEnabled

public abstract void setRemoteAgentFunctionEnabled(boolean enabled)

Specified by:

setRemoteAgentFunctionEnabled in interface AdministrationConfigurationInterface

getRepositorySettings

@NotNull
public abstract RepositorySettings getRepositorySettings()

Specified by:

getRepositorySettings in interface AdministrationConfigurationInterface

getResolveArtifactContentTypeByExtension

public abstract boolean getResolveArtifactContentTypeByExtension()

Description copied from interface: AdministrationConfigurationInterface

Use correct Content-Type header when return artifact content. See components/bamboo-web-app/src/main/webapp/WEB-INF/mimetypes.xml

Specified by:

getResolveArtifactContentTypeByExtension in interface AdministrationConfigurationInterface

Returns:

true if artifact's Content-Type header is mapped to resource extension.

setResolveArtifactContentTypeByExtension

public abstract void setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension)

Specified by:

setResolveArtifactContentTypeByExtension in interface AdministrationConfigurationInterface

getScheduleBackupConfiguration

public abstract ScheduleBackupConfiguration getScheduleBackupConfiguration()

Specified by:

getScheduleBackupConfiguration in interface AdministrationConfigurationInterface

setScheduleBackupConfiguration

public abstract void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)

Specified by:

setScheduleBackupConfiguration in interface AdministrationConfigurationInterface

getStorageLimit

@NotNull
public abstract StorageLimits getStorageLimit()

Description copied from interface: AdministrationConfigurationInterface

Storage limits configuration. Allows to limit local disk usage by artifacts.

Specified by:

getStorageLimit in interface AdministrationConfigurationInterface

Returns:

storage limits

setStorageLimit

public abstract void setStorageLimit(@NotNull
                                     StorageLimits storageLimits)

Specified by:

setStorageLimit in interface AdministrationConfigurationInterface

getSystemProperty

@Nullable
public abstract String getSystemProperty(String key)

Specified by:

getSystemProperty in interface AdministrationConfigurationInterface

setSystemProperty

public abstract void setSystemProperty(String key,
                                       String value)

Specified by:

setSystemProperty in interface AdministrationConfigurationInterface

isTestQuarantineEnabled

@Deprecated
public abstract boolean isTestQuarantineEnabled()

Deprecated. since 5.9 - use getQuarantineConfiguration() and then QuarantineConfiguration.isEnabled()

Specified by:

isTestQuarantineEnabled in interface AdministrationConfigurationInterface

setEnableTestQuarantine

@Deprecated
public abstract void setEnableTestQuarantine(boolean enableTestQuarantine)

Deprecated. since 5.9 - use getQuarantineConfiguration() and then QuarantineConfiguration.setEnabled(boolean)

Specified by:

setEnableTestQuarantine in interface AdministrationConfigurationInterface

getQuarantineConfiguration

@NotNull
public abstract QuarantineConfiguration getQuarantineConfiguration()

Specified by:

getQuarantineConfiguration in interface AdministrationConfigurationInterface

setQuarantineConfiguration

public abstract void setQuarantineConfiguration(@NotNull
                                                QuarantineConfiguration quarantineConfiguration)

Specified by:

setQuarantineConfiguration in interface AdministrationConfigurationInterface

setUnconfigurableFeatureDefaults

public abstract void setUnconfigurableFeatureDefaults(@Nullable
                                                      UnconfigurableFeatureDefaults unconfigurableFeatureDefaults)

Specified by:

setUnconfigurableFeatureDefaults in interface AdministrationConfigurationInterface

isUseGzipCompression

public abstract boolean isUseGzipCompression()

Should we use gzip compression to compress Bamboo web pages?

This is useful if Bamboo is being run over slow networks. It incurs a slight performance penalty, and may not work for non-english languages.

Specified by:

isUseGzipCompression in interface AdministrationConfigurationInterface

Returns:

true iff we require gzip compression

setUseGzipCompression

public abstract void setUseGzipCompression(boolean useGzipCompression)

Specify if we should we use gzip compression to compress Bamboo web pages.

Specified by:

setUseGzipCompression in interface AdministrationConfigurationInterface

Parameters:

useGzipCompression -

doesXsrfAllowMutativeGets

public abstract boolean doesXsrfAllowMutativeGets()

Specified by:

doesXsrfAllowMutativeGets in interface AdministrationConfigurationInterface

setXsrfAllowsMutativeGets

public abstract void setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets)

Specified by:

setXsrfAllowsMutativeGets in interface AdministrationConfigurationInterface

isXsrfProtectionEnabled

public abstract boolean isXsrfProtectionEnabled()

Specified by:

isXsrfProtectionEnabled in interface AdministrationConfigurationInterface

setXsrfProtectionEnabled

public abstract void setXsrfProtectionEnabled(boolean xsrfProtectionEnabled)

Specified by:

setXsrfProtectionEnabled in interface AdministrationConfigurationInterface

isSecurityTokenRequiredFromAgents

public abstract boolean isSecurityTokenRequiredFromAgents()

Description copied from interface: AdministrationConfigurationInterface

Whether security token is required from remote agents as a preliminary authentication method.

Specified by:

isSecurityTokenRequiredFromAgents in interface AdministrationConfigurationInterface

setSecurityTokenRequiredFromAgents

public abstract void setSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents)

Description copied from interface: AdministrationConfigurationInterface

Set whether security token is required from remote agents as a preliminary authentication method.

Specified by:

setSecurityTokenRequiredFromAgents in interface AdministrationConfigurationInterface