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
-
Method Summary
Modifier and TypeMethodDescriptionabstract boolean
abstract String
What is the base url for this server?abstract int
Get the interval between branch detection, in seconds (default is 300)abstract @NotNull BuildExpiryConfig
abstract @NotNull BuildHangingConfig
abstract @NotNull CaptchaConfiguration
abstract @NotNull ConcurrentBuildConfig
abstract int
abstract @NotNull DeploymentExpiryConfig
abstract @Nullable ElasticConfiguration
abstract String
abstract @NotNull String
abstract LookAndFeelConfiguration
abstract ManualEncryptionConfiguration
Get Manual Encryption configuration.Get Personal Access Tokens expiration configuration.abstract @NotNull QuarantineConfiguration
abstract @NotNull RepositorySettings
abstract boolean
Use correct Content-Type header when return artifact content.abstract ScheduleBackupConfiguration
abstract @NotNull StorageLimits
Storage limits configuration.abstract @Nullable String
getSystemProperty
(String key) abstract int
Keeps a configuration counter for webresources cache bustingabstract int
abstract boolean
abstract boolean
Returns true if deployments expiry is enabled.abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract boolean
abstract Boolean
Whether the quiet period is disabled globally or can be configured per repository.abstract boolean
abstract boolean
abstract boolean
Whether security token is required from remote agents as a preliminary authentication method.abstract boolean
abstract boolean
abstract boolean
Whether Bamboo instance SOX compliance mode is enabled.abstract boolean
abstract boolean
Should we use gzip compression to compress Bamboo web pages?abstract boolean
abstract void
setAuditLoggingEnabled
(boolean auditLoggingEnabled) abstract void
setBaseUrl
(String baseUrl) Define the system base urlabstract void
setBranchDetectionCheckInterval
(int branchDetectionCheckInterval) Set the interval between branch detection, in secondsabstract void
setBuildExpiryConfig
(BuildExpiryConfig buildExpiryConfig) Deprecated.since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfigabstract void
setBuildHangingConfig
(BuildHangingConfig myBuildHangingConfig) abstract void
setDashboardPageSize
(int dashboardPageSize) abstract void
setDeploymentExpiryConfig
(DeploymentExpiryConfig deploymentExpiryConfig) abstract void
setDeploymentExpiryEnabled
(boolean deploymentExpiryEnabled) Enable or disable deployment expiryabstract void
setElasticConfig
(ElasticConfiguration elasticConfig) abstract void
setEnableAnonymousAccess
(boolean enableAnonymousAccess) abstract void
setEnableRestrictedAdmin
(boolean enableRestrictedAdmin) abstract void
setEnableSignup
(boolean enableSignup) abstract void
setEnableViewContactDetails
(boolean enableViewContactDetails) abstract void
setGravatarServerUrl
(String gravatarUrl) abstract void
setGravatarSupportEnabled
(boolean gravatarSupportEnabled) abstract void
setInstanceName
(String instanceName) abstract void
setLookAndFeelConfiguration
(LookAndFeelConfiguration lookandfeelConfiguration) abstract void
setManualEncryptionConfiguration
(ManualEncryptionConfiguration manualEncryptionConfiguration) Set Manual Encryption configuration.abstract void
setPersonalAccessTokensExpirationConfiguration
(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Set Personal Access Tokens expiration configuration.abstract void
setQuarantineConfiguration
(@NotNull QuarantineConfiguration quarantineConfiguration) abstract void
setQuietPeriodGloballyDisabled
(Boolean quietPeriodGloballyDisabled) Sets a quiet period globally.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
setShowAuthorsDetailsToUsers
(boolean showAuthorsDetailsToUsers) abstract void
setSoxComplianceModeEnabled
(boolean soxComplianceModeEnabled) Enables or disables Bamboo instance SOX compliance mode.abstract void
setStorageLimit
(@NotNull StorageLimits storageLimits) abstract void
setSystemProperty
(String key, String value) abstract void
setUnauthenticatedRemoteTriggerAllowed
(boolean unauthenticatedRemoteTriggerAllowed) abstract void
setUnconfigurableFeatureDefaults
(@Nullable 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
getEphemeralAgentsConfiguration, getRssDetectionConfiguration, getRssSecurityConfiguration, getSerializationSecurityConfig, isAgentAssignmentModificationByUsersAllowed, isEnableExternalUserManagement, isManageAcceptedSshHostKeys, setAgentAssignmentModificationByUsersAllowed, setEphemeralAgentsConfiguration, setManageAcceptedSshHostKeys, setRssDetectionConfiguration, setRssSecurityConfiguration, setSerializationSecurityConfig
-
Constructor Details
-
AdministrationConfiguration
public AdministrationConfiguration()
-
-
Method Details
-
isAuditLoggingEnabled
public abstract boolean isAuditLoggingEnabled()- Specified by:
isAuditLoggingEnabled
in interfaceAdministrationConfigurationInterface
-
setAuditLoggingEnabled
public abstract void setAuditLoggingEnabled(boolean auditLoggingEnabled) - Specified by:
setAuditLoggingEnabled
in interfaceAdministrationConfigurationInterface
-
getBaseUrl
What is the base url for this server?- Specified by:
getBaseUrl
in interfaceAdministrationConfigurationInterface
- Returns:
- the base url
-
setBaseUrl
Define the system base url- Specified by:
setBaseUrl
in interfaceAdministrationConfigurationInterface
- Parameters:
baseUrl
- the url
-
getBranchDetectionCheckInterval
public abstract int getBranchDetectionCheckInterval()Get the interval between branch detection, in seconds (default is 300)- Specified by:
getBranchDetectionCheckInterval
in interfaceAdministrationConfigurationInterface
-
setBranchDetectionCheckInterval
public abstract void setBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in seconds- Specified by:
setBranchDetectionCheckInterval
in interfaceAdministrationConfigurationInterface
- Parameters:
branchDetectionCheckInterval
-
-
isDeploymentExpiryEnabled
public abstract boolean isDeploymentExpiryEnabled()Description copied from interface:AdministrationConfigurationInterface
Returns true if deployments expiry is enabled.- Specified by:
isDeploymentExpiryEnabled
in interfaceAdministrationConfigurationInterface
-
setDeploymentExpiryEnabled
public abstract void setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Description copied from interface:AdministrationConfigurationInterface
Enable or disable deployment expiry- Specified by:
setDeploymentExpiryEnabled
in interfaceAdministrationConfigurationInterface
-
getBuildExpiryConfig
- Specified by:
getBuildExpiryConfig
in interfaceAdministrationConfigurationInterface
-
setBuildExpiryConfig
Deprecated.since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfig- Specified by:
setBuildExpiryConfig
in interfaceAdministrationConfigurationInterface
-
getBuildHangingConfig
- Specified by:
getBuildHangingConfig
in interfaceAdministrationConfigurationInterface
-
setBuildHangingConfig
- Specified by:
setBuildHangingConfig
in interfaceAdministrationConfigurationInterface
-
getCaptchaConfiguration
- Specified by:
getCaptchaConfiguration
in interfaceAdministrationConfigurationInterface
-
getConcurrentBuildConfig
- Specified by:
getConcurrentBuildConfig
in interfaceAdministrationConfigurationInterface
-
getDashboardPageSize
public abstract int getDashboardPageSize()- Specified by:
getDashboardPageSize
in interfaceAdministrationConfigurationInterface
-
setDashboardPageSize
public abstract void setDashboardPageSize(int dashboardPageSize) - Specified by:
setDashboardPageSize
in interfaceAdministrationConfigurationInterface
-
getDeploymentExpiryConfig
- Specified by:
getDeploymentExpiryConfig
in interfaceAdministrationConfigurationInterface
-
setDeploymentExpiryConfig
- Specified by:
setDeploymentExpiryConfig
in interfaceAdministrationConfigurationInterface
-
getElasticConfig
- Specified by:
getElasticConfig
in interfaceAdministrationConfigurationInterface
-
setElasticConfig
- Specified by:
setElasticConfig
in interfaceAdministrationConfigurationInterface
-
isEnableAnonymousAccess
public abstract boolean isEnableAnonymousAccess()- Specified by:
isEnableAnonymousAccess
in interfaceAdministrationConfigurationInterface
-
setEnableAnonymousAccess
public abstract void setEnableAnonymousAccess(boolean enableAnonymousAccess) - Specified by:
setEnableAnonymousAccess
in interfaceAdministrationConfigurationInterface
-
isEnableRestrictedAdmin
public abstract boolean isEnableRestrictedAdmin()- Specified by:
isEnableRestrictedAdmin
in interfaceAdministrationConfigurationInterface
-
setEnableRestrictedAdmin
public abstract void setEnableRestrictedAdmin(boolean enableRestrictedAdmin) - Specified by:
setEnableRestrictedAdmin
in interfaceAdministrationConfigurationInterface
-
isSoxComplianceModeEnabled
public abstract boolean isSoxComplianceModeEnabled()Description copied from interface:AdministrationConfigurationInterface
Whether Bamboo instance SOX compliance mode is enabled.- Specified by:
isSoxComplianceModeEnabled
in interfaceAdministrationConfigurationInterface
-
setSoxComplianceModeEnabled
public abstract void setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Description copied from interface:AdministrationConfigurationInterface
Enables or disables Bamboo instance SOX compliance mode.- Specified by:
setSoxComplianceModeEnabled
in interfaceAdministrationConfigurationInterface
-
isEnableSignup
public abstract boolean isEnableSignup()- Specified by:
isEnableSignup
in interfaceAdministrationConfigurationInterface
-
setEnableSignup
public abstract void setEnableSignup(boolean enableSignup) - Specified by:
setEnableSignup
in interfaceAdministrationConfigurationInterface
-
isEnableViewContactDetails
public abstract boolean isEnableViewContactDetails()- Specified by:
isEnableViewContactDetails
in interfaceAdministrationConfigurationInterface
-
setEnableViewContactDetails
public abstract void setEnableViewContactDetails(boolean enableViewContactDetails) - Specified by:
setEnableViewContactDetails
in interfaceAdministrationConfigurationInterface
-
getGravatarServerUrl
- Specified by:
getGravatarServerUrl
in interfaceAdministrationConfigurationInterface
-
setGravatarServerUrl
- Specified by:
setGravatarServerUrl
in interfaceAdministrationConfigurationInterface
-
isShowAdminContactDetailsToAnonymousUsers
public abstract boolean isShowAdminContactDetailsToAnonymousUsers()- Specified by:
isShowAdminContactDetailsToAnonymousUsers
in interfaceAdministrationConfigurationInterface
-
setShowAdminContactDetailsToAnonymousUsers
public abstract void setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers) - Specified by:
setShowAdminContactDetailsToAnonymousUsers
in interfaceAdministrationConfigurationInterface
-
isShowAuthorsDetailsToUsers
public abstract boolean isShowAuthorsDetailsToUsers()- Specified by:
isShowAuthorsDetailsToUsers
in interfaceAdministrationConfigurationInterface
- Returns:
- true if logged-in user can view authors' related subpages
-
setShowAuthorsDetailsToUsers
public abstract void setShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers) - Specified by:
setShowAuthorsDetailsToUsers
in interfaceAdministrationConfigurationInterface
-
isUnauthenticatedRemoteTriggerAllowed
public abstract boolean isUnauthenticatedRemoteTriggerAllowed()- Specified by:
isUnauthenticatedRemoteTriggerAllowed
in interfaceAdministrationConfigurationInterface
- Returns:
- true if anonymous user can trigger repository remote trigger and Bamboo Specs detection
-
setUnauthenticatedRemoteTriggerAllowed
public abstract void setUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed) - Specified by:
setUnauthenticatedRemoteTriggerAllowed
in interfaceAdministrationConfigurationInterface
-
isGravatarSupportEnabled
public abstract boolean isGravatarSupportEnabled()- Specified by:
isGravatarSupportEnabled
in interfaceAdministrationConfigurationInterface
-
setGravatarSupportEnabled
public abstract void setGravatarSupportEnabled(boolean gravatarSupportEnabled) - Specified by:
setGravatarSupportEnabled
in interfaceAdministrationConfigurationInterface
-
getInstanceName
- Specified by:
getInstanceName
in interfaceAdministrationConfigurationInterface
-
setInstanceName
- Specified by:
setInstanceName
in interfaceAdministrationConfigurationInterface
-
getWebResourcesSystemCounter
public abstract int getWebResourcesSystemCounter()Description copied from interface:AdministrationConfigurationInterface
Keeps a configuration counter for webresources cache busting- Specified by:
getWebResourcesSystemCounter
in interfaceAdministrationConfigurationInterface
-
incrementAndGetWebResourcesSystemCounter
public abstract int incrementAndGetWebResourcesSystemCounter()- Specified by:
incrementAndGetWebResourcesSystemCounter
in interfaceAdministrationConfigurationInterface
-
getLookAndFeelConfiguration
- Specified by:
getLookAndFeelConfiguration
in interfaceAdministrationConfigurationInterface
-
setLookAndFeelConfiguration
- Specified by:
setLookAndFeelConfiguration
in interfaceAdministrationConfigurationInterface
-
isRemoteAgentAuthenticationEnabled
public abstract boolean isRemoteAgentAuthenticationEnabled()- Specified by:
isRemoteAgentAuthenticationEnabled
in interfaceAdministrationConfigurationInterface
-
setRemoteAgentAuthenticationEnabled
public abstract void setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled) - Specified by:
setRemoteAgentAuthenticationEnabled
in interfaceAdministrationConfigurationInterface
-
isRemoteAgentFunctionEnabled
public abstract boolean isRemoteAgentFunctionEnabled()- Specified by:
isRemoteAgentFunctionEnabled
in interfaceAdministrationConfigurationInterface
-
setRemoteAgentFunctionEnabled
public abstract void setRemoteAgentFunctionEnabled(boolean enabled) - Specified by:
setRemoteAgentFunctionEnabled
in interfaceAdministrationConfigurationInterface
-
getRepositorySettings
- Specified by:
getRepositorySettings
in interfaceAdministrationConfigurationInterface
-
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 interfaceAdministrationConfigurationInterface
- Returns:
- true if artifact's Content-Type header is mapped to resource extension.
-
setResolveArtifactContentTypeByExtension
public abstract void setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension) - Specified by:
setResolveArtifactContentTypeByExtension
in interfaceAdministrationConfigurationInterface
-
getScheduleBackupConfiguration
- Specified by:
getScheduleBackupConfiguration
in interfaceAdministrationConfigurationInterface
-
setScheduleBackupConfiguration
public abstract void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration) - Specified by:
setScheduleBackupConfiguration
in interfaceAdministrationConfigurationInterface
-
getStorageLimit
Description copied from interface:AdministrationConfigurationInterface
Storage limits configuration. Allows to limit local disk usage by artifacts.- Specified by:
getStorageLimit
in interfaceAdministrationConfigurationInterface
- Returns:
- storage limits
-
setStorageLimit
- Specified by:
setStorageLimit
in interfaceAdministrationConfigurationInterface
-
getSystemProperty
- Specified by:
getSystemProperty
in interfaceAdministrationConfigurationInterface
-
setSystemProperty
- Specified by:
setSystemProperty
in interfaceAdministrationConfigurationInterface
-
getQuarantineConfiguration
- Specified by:
getQuarantineConfiguration
in interfaceAdministrationConfigurationInterface
-
setQuarantineConfiguration
public abstract void setQuarantineConfiguration(@NotNull @NotNull QuarantineConfiguration quarantineConfiguration) - Specified by:
setQuarantineConfiguration
in interfaceAdministrationConfigurationInterface
-
setUnconfigurableFeatureDefaults
public abstract void setUnconfigurableFeatureDefaults(@Nullable @Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults) - Specified by:
setUnconfigurableFeatureDefaults
in interfaceAdministrationConfigurationInterface
-
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 interfaceAdministrationConfigurationInterface
- 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 interfaceAdministrationConfigurationInterface
- Parameters:
useGzipCompression
-
-
doesXsrfAllowMutativeGets
public abstract boolean doesXsrfAllowMutativeGets()- Specified by:
doesXsrfAllowMutativeGets
in interfaceAdministrationConfigurationInterface
-
setXsrfAllowsMutativeGets
public abstract void setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets) - Specified by:
setXsrfAllowsMutativeGets
in interfaceAdministrationConfigurationInterface
-
isXsrfProtectionEnabled
public abstract boolean isXsrfProtectionEnabled()- Specified by:
isXsrfProtectionEnabled
in interfaceAdministrationConfigurationInterface
-
setXsrfProtectionEnabled
public abstract void setXsrfProtectionEnabled(boolean xsrfProtectionEnabled) - Specified by:
setXsrfProtectionEnabled
in interfaceAdministrationConfigurationInterface
-
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 interfaceAdministrationConfigurationInterface
-
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 interfaceAdministrationConfigurationInterface
-
setManualEncryptionConfiguration
public abstract void setManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration) Description copied from interface:AdministrationConfigurationInterface
Set Manual Encryption configuration.- Specified by:
setManualEncryptionConfiguration
in interfaceAdministrationConfigurationInterface
-
getManualEncryptionConfiguration
Description copied from interface:AdministrationConfigurationInterface
Get Manual Encryption configuration.- Specified by:
getManualEncryptionConfiguration
in interfaceAdministrationConfigurationInterface
-
isQuietPeriodGloballyDisabled
Description copied from interface:AdministrationConfigurationInterface
Whether the quiet period is disabled globally or can be configured per repository.- Specified by:
isQuietPeriodGloballyDisabled
in interfaceAdministrationConfigurationInterface
-
setQuietPeriodGloballyDisabled
Description copied from interface:AdministrationConfigurationInterface
Sets a quiet period globally. If disabled, a quiet period won't be used on any repository. If enabled, the configuration is repository specific.- Specified by:
setQuietPeriodGloballyDisabled
in interfaceAdministrationConfigurationInterface
-
setPersonalAccessTokensExpirationConfiguration
public abstract void setPersonalAccessTokensExpirationConfiguration(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Description copied from interface:AdministrationConfigurationInterface
Set Personal Access Tokens expiration configuration.- Specified by:
setPersonalAccessTokensExpirationConfiguration
in interfaceAdministrationConfigurationInterface
-
getPersonalAccessTokensExpirationConfiguration
public abstract PersonalAccessTokensExpirationConfiguration getPersonalAccessTokensExpirationConfiguration()Description copied from interface:AdministrationConfigurationInterface
Get Personal Access Tokens expiration configuration.- Specified by:
getPersonalAccessTokensExpirationConfiguration
in interfaceAdministrationConfigurationInterface
-