com.atlassian.bamboo.configuration

Interface AdministrationConfigurationInterface

All Known Implementing Classes:

AdministrationConfiguration, AdministrationConfigurationImpl

@Internal
public interface AdministrationConfigurationInterface

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

Method Summary

Modifier and Type	Method and Description
boolean	doesXsrfAllowMutativeGets()
String	getBaseUrl() What is the base url for this server?
int	getBranchDetectionCheckInterval() Get the interval between branch detection, in seconds (default is 300)
@NotNull BuildExpiryConfig	getBuildExpiryConfig()
@NotNull BuildHangingConfig	getBuildHangingConfig()
@NotNull CaptchaConfiguration	getCaptchaConfiguration()
@NotNull ConcurrentBuildConfig	getConcurrentBuildConfig()
int	getDashboardPageSize()
@NotNull DeploymentExpiryConfig	getDeploymentExpiryConfig()
@Nullable ElasticConfiguration	getElasticConfig()
String	getGravatarServerUrl()
@NotNull String	getInstanceName()
LookAndFeelConfiguration	getLookAndFeelConfiguration()
ManualEncryptionConfiguration	getManualEncryptionConfiguration() Get Manual Encryption configuration.
@NotNull QuarantineConfiguration	getQuarantineConfiguration()
@NotNull RepositorySettings	getRepositorySettings()
boolean	getResolveArtifactContentTypeByExtension() Use correct Content-Type header when return artifact content.
@NotNull RssDetectionConfiguration	getRssDetectionConfiguration() Get global RSS detection configuration.
@NotNull RssSecurityConfiguration	getRssSecurityConfiguration() Get RSS security configuration
ScheduleBackupConfiguration	getScheduleBackupConfiguration()
@NotNull SerializationSecurityConfig	getSerializationSecurityConfig()
@NotNull StorageLimits	getStorageLimit() Storage limits configuration.
@Nullable String	getSystemProperty(String key) Deprecated. since 6.0. Use BandanaManager for key-value storage.
int	getWebResourcesSystemCounter() Keeps a configuration counter for webresources cache busting
int	incrementAndGetWebResourcesSystemCounter()
boolean	isAgentAssignmentModificationByUsersAllowed()
boolean	isAuditLoggingEnabled()
boolean	isDeploymentExpiryEnabled() Returns true if deployments expiry is enabled.
boolean	isEnableAnonymousAccess()
default boolean	isEnableExternalUserManagement() Deprecated. since 6.6.0. Use GroupManager.isCreative() instead.
boolean	isEnableRestrictedAdmin()
boolean	isEnableSignup()
boolean	isEnableViewContactDetails()
boolean	isGravatarSupportEnabled()
boolean	isManageAcceptedSshHostKeys()
boolean	isRemoteAgentAuthenticationEnabled()
boolean	isRemoteAgentFunctionEnabled()
boolean	isSecurityTokenRequiredFromAgents() Whether security token is required from remote agents as a preliminary authentication method.
boolean	isShowAdminContactDetailsToAnonymousUsers()
boolean	isShowAuthorsDetailsToUsers()
boolean	isSoxComplianceModeEnabled() Whether Bamboo instance SOX compliance mode is enabled.
boolean	isUnauthenticatedRemoteTriggerAllowed()
boolean	isUseGzipCompression() Should we use gzip compression to compress Bamboo web pages?
boolean	isXsrfProtectionEnabled()
void	setAgentAssignmentModificationByUsersAllowed(boolean agentAssignmentModificationByUsersAllowed)
void	setAuditLoggingEnabled(boolean auditLoggingEnabled)
void	setBaseUrl(String baseUrl) Define the system base url
void	setBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in seconds
void	setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig)
void	setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)
void	setDashboardPageSize(int dashboardPageSize)
void	setDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig)
void	setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Enable or disable deployment expiry
void	setElasticConfig(ElasticConfiguration elasticConfig)
void	setEnableAnonymousAccess(boolean enableAnonymousAccess)
void	setEnableRestrictedAdmin(boolean enableRestrictedAdmin)
void	setEnableSignup(boolean enableSignup)
void	setEnableViewContactDetails(boolean enableViewContactDetails)
void	setGravatarServerUrl(String gravatarUrl)
void	setGravatarSupportEnabled(boolean gravatarSupportEnabled)
void	setInstanceName(String instanceName)
void	setLookAndFeelConfiguration(LookAndFeelConfiguration lookandfeelConfiguration)
void	setManageAcceptedSshHostKeys(boolean manageAcceptedSshHostKeys)
void	setManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration) Set Manual Encryption configuration.
void	setQuarantineConfiguration(@NotNull QuarantineConfiguration quarantineConfiguration)
void	setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled)
void	setRemoteAgentFunctionEnabled(boolean enabled)
void	setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension)
void	setRssDetectionConfiguration(RssDetectionConfiguration rssDetectionConfiguration) Set global RSS detection configuration.
void	setRssSecurityConfiguration(RssSecurityConfiguration configuration) Set RSS security configuration
void	setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)
void	setSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents) Set whether security token is required from remote agents as a preliminary authentication method.
void	setSerializationSecurityConfig(@NotNull SerializationSecurityConfig serializationSecurityConfig)
void	setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers)
void	setShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers)
void	setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Enables or disables Bamboo instance SOX compliance mode.
void	setStorageLimit(@NotNull StorageLimits storageLimits)
void	setSystemProperty(String key, String value) Deprecated. since 6.0. Use BandanaManager for key-value storage.
void	setUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed)
void	setUnconfigurableFeatureDefaults(@Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults)
void	setUseGzipCompression(boolean useGzipCompression) Specify if we should we use gzip compression to compress Bamboo web pages.
void	setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets)
void	setXsrfProtectionEnabled(boolean xsrfProtectionEnabled)

Method Detail

isAuditLoggingEnabled

boolean isAuditLoggingEnabled()

setAuditLoggingEnabled

void setAuditLoggingEnabled(boolean auditLoggingEnabled)

getBaseUrl

String getBaseUrl()

What is the base url for this server?

Returns:

the base url

setBaseUrl

void setBaseUrl(String baseUrl)

Define the system base url

Parameters:

baseUrl - the url

getBranchDetectionCheckInterval

int getBranchDetectionCheckInterval()

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

setBranchDetectionCheckInterval

void setBranchDetectionCheckInterval(int branchDetectionCheckInterval)

Set the interval between branch detection, in seconds

Parameters:

branchDetectionCheckInterval -

isDeploymentExpiryEnabled

boolean isDeploymentExpiryEnabled()

Returns true if deployments expiry is enabled.

setDeploymentExpiryEnabled

void setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled)

Enable or disable deployment expiry

getBuildExpiryConfig

@NotNull
@NotNull BuildExpiryConfig getBuildExpiryConfig()

setBuildExpiryConfig

void setBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig)

getBuildHangingConfig

@NotNull
@NotNull BuildHangingConfig getBuildHangingConfig()

setBuildHangingConfig

void setBuildHangingConfig(BuildHangingConfig myBuildHangingConfig)

getCaptchaConfiguration

@NotNull
@NotNull CaptchaConfiguration getCaptchaConfiguration()

getConcurrentBuildConfig

@NotNull
@NotNull ConcurrentBuildConfig getConcurrentBuildConfig()

getDashboardPageSize

int getDashboardPageSize()

setDashboardPageSize

void setDashboardPageSize(int dashboardPageSize)

getDeploymentExpiryConfig

@NotNull
@NotNull DeploymentExpiryConfig getDeploymentExpiryConfig()

setDeploymentExpiryConfig

void setDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig)

getElasticConfig

@Nullable
@Nullable ElasticConfiguration getElasticConfig()

setElasticConfig

void setElasticConfig(ElasticConfiguration elasticConfig)

isEnableAnonymousAccess

boolean isEnableAnonymousAccess()

setEnableAnonymousAccess

void setEnableAnonymousAccess(boolean enableAnonymousAccess)

isEnableExternalUserManagement

@Deprecated
default boolean isEnableExternalUserManagement()

Deprecated. since 6.6.0. Use GroupManager.isCreative() instead.

isEnableRestrictedAdmin

boolean isEnableRestrictedAdmin()

setEnableRestrictedAdmin

void setEnableRestrictedAdmin(boolean enableRestrictedAdmin)

isSoxComplianceModeEnabled

boolean isSoxComplianceModeEnabled()

Whether Bamboo instance SOX compliance mode is enabled.

setSoxComplianceModeEnabled

void setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled)

Enables or disables Bamboo instance SOX compliance mode.

isEnableSignup

boolean isEnableSignup()

setEnableSignup

void setEnableSignup(boolean enableSignup)

isEnableViewContactDetails

boolean isEnableViewContactDetails()

setEnableViewContactDetails

void setEnableViewContactDetails(boolean enableViewContactDetails)

getGravatarServerUrl

String getGravatarServerUrl()

setGravatarServerUrl

void setGravatarServerUrl(String gravatarUrl)

isGravatarSupportEnabled

boolean isGravatarSupportEnabled()

setGravatarSupportEnabled

void setGravatarSupportEnabled(boolean gravatarSupportEnabled)

getInstanceName

@NotNull
@NotNull String getInstanceName()

setInstanceName

void setInstanceName(String instanceName)

getWebResourcesSystemCounter

int getWebResourcesSystemCounter()

Keeps a configuration counter for webresources cache busting

incrementAndGetWebResourcesSystemCounter

int incrementAndGetWebResourcesSystemCounter()

getLookAndFeelConfiguration

LookAndFeelConfiguration getLookAndFeelConfiguration()

setLookAndFeelConfiguration

void setLookAndFeelConfiguration(LookAndFeelConfiguration lookandfeelConfiguration)

isManageAcceptedSshHostKeys

boolean isManageAcceptedSshHostKeys()

setManageAcceptedSshHostKeys

void setManageAcceptedSshHostKeys(boolean manageAcceptedSshHostKeys)

isRemoteAgentAuthenticationEnabled

boolean isRemoteAgentAuthenticationEnabled()

setRemoteAgentAuthenticationEnabled

void setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled)

isRemoteAgentFunctionEnabled

boolean isRemoteAgentFunctionEnabled()

setRemoteAgentFunctionEnabled

void setRemoteAgentFunctionEnabled(boolean enabled)

getRepositorySettings

@NotNull
@NotNull RepositorySettings getRepositorySettings()

getResolveArtifactContentTypeByExtension

boolean getResolveArtifactContentTypeByExtension()

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

Returns:

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

setResolveArtifactContentTypeByExtension

void setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension)

getScheduleBackupConfiguration

ScheduleBackupConfiguration getScheduleBackupConfiguration()

setScheduleBackupConfiguration

void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration)

isShowAdminContactDetailsToAnonymousUsers

boolean isShowAdminContactDetailsToAnonymousUsers()

setShowAdminContactDetailsToAnonymousUsers

void setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers)

isShowAuthorsDetailsToUsers

boolean isShowAuthorsDetailsToUsers()

Returns:

true if logged-in user can view authors' related subpages

setShowAuthorsDetailsToUsers

void setShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers)

isUnauthenticatedRemoteTriggerAllowed

boolean isUnauthenticatedRemoteTriggerAllowed()

Returns:

true if anonymous user can trigger repository remote trigger and Bamboo Specs detection

setUnauthenticatedRemoteTriggerAllowed

void setUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed)

isAgentAssignmentModificationByUsersAllowed

boolean isAgentAssignmentModificationByUsersAllowed()

Returns:

true if agent assignment can be changed by regular users

Since:

7.1

setAgentAssignmentModificationByUsersAllowed

void setAgentAssignmentModificationByUsersAllowed(boolean agentAssignmentModificationByUsersAllowed)

getStorageLimit

@NotNull
@NotNull StorageLimits getStorageLimit()

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

Returns:

storage limits

Since:

5.9

setStorageLimit

void setStorageLimit(@NotNull
                     @NotNull StorageLimits storageLimits)

getSystemProperty

@Deprecated
 @Nullable
@Nullable String getSystemProperty(String key)

Deprecated. since 6.0. Use BandanaManager for key-value storage.

setSystemProperty

@Deprecated
void setSystemProperty(String key,
                                   String value)

Deprecated. since 6.0. Use BandanaManager for key-value storage.

getQuarantineConfiguration

@NotNull
@NotNull QuarantineConfiguration getQuarantineConfiguration()

setQuarantineConfiguration

void setQuarantineConfiguration(@NotNull
                                @NotNull QuarantineConfiguration quarantineConfiguration)

setUnconfigurableFeatureDefaults

void setUnconfigurableFeatureDefaults(@Nullable
                                      @Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults)

isUseGzipCompression

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.

Returns:

true iff we require gzip compression

setUseGzipCompression

void setUseGzipCompression(boolean useGzipCompression)

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

Parameters:

useGzipCompression -

doesXsrfAllowMutativeGets

boolean doesXsrfAllowMutativeGets()

setXsrfAllowsMutativeGets

void setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets)

isXsrfProtectionEnabled

boolean isXsrfProtectionEnabled()

setXsrfProtectionEnabled

void setXsrfProtectionEnabled(boolean xsrfProtectionEnabled)

getSerializationSecurityConfig

@NotNull
@NotNull SerializationSecurityConfig getSerializationSecurityConfig()

setSerializationSecurityConfig

void setSerializationSecurityConfig(@NotNull
                                    @NotNull SerializationSecurityConfig serializationSecurityConfig)

isSecurityTokenRequiredFromAgents

boolean isSecurityTokenRequiredFromAgents()

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

setSecurityTokenRequiredFromAgents

void setSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents)

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

getRssSecurityConfiguration

@NotNull
@NotNull RssSecurityConfiguration getRssSecurityConfiguration()

Get RSS security configuration

setRssSecurityConfiguration

void setRssSecurityConfiguration(RssSecurityConfiguration configuration)

Set RSS security configuration

getRssDetectionConfiguration

@NotNull
@NotNull RssDetectionConfiguration getRssDetectionConfiguration()

Get global RSS detection configuration.

Since:

6.7

setRssDetectionConfiguration

void setRssDetectionConfiguration(RssDetectionConfiguration rssDetectionConfiguration)

Set global RSS detection configuration.

Since:

6.7

setManualEncryptionConfiguration

void setManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration)

Set Manual Encryption configuration.

Since:

6.9

getManualEncryptionConfiguration

ManualEncryptionConfiguration getManualEncryptionConfiguration()

Get Manual Encryption configuration.

Since:

6.9