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 -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanabstract StringWhat is the base url for this server?abstract intGet the interval between branch detection, in seconds (default is 300)abstract @NotNull BuildExpiryConfigabstract @NotNull BuildHangingConfigabstract @NotNull CaptchaConfigurationabstract @NotNull ConcurrentBuildConfigabstract intabstract @NotNull DeploymentExpiryConfigabstract @Nullable ElasticConfigurationabstract Stringabstract @NotNull Stringabstract LookAndFeelConfigurationabstract ManualEncryptionConfigurationGet Manual Encryption configuration.abstract OfflineAgentRemovalConfigGets the configuration for automatic offline agent removal.Get Personal Access Tokens expiration configuration.abstract @NotNull QuarantineConfigurationabstract @NotNull RepositorySettingsabstract booleanUse correct Content-Type header when return artifact content.abstract ScheduleBackupConfigurationabstract @NotNull StorageLimitsStorage limits configuration.abstract @Nullable StringgetSystemProperty(String key) abstract intKeeps a configuration counter for webresources cache bustingabstract intabstract booleanabstract booleanReturns true if deployments expiry is enabled.abstract booleanabstract booleanabstract booleanabstract booleanabstract booleanabstract booleanabstract booleanabstract booleanWhether security token is required from remote agents as a preliminary authentication method.abstract booleanabstract booleanabstract booleanWhether Bamboo instance SOX compliance mode is enabled.abstract booleanabstract booleanShould we use gzip compression to compress Bamboo web pages?abstract booleanabstract voidsetAuditLoggingEnabled(boolean auditLoggingEnabled) abstract voidsetBaseUrl(String baseUrl) Define the system base urlabstract voidsetBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in secondsabstract voidsetBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig) Deprecated.since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfigabstract voidsetBuildHangingConfig(BuildHangingConfig myBuildHangingConfig) abstract voidsetDashboardPageSize(int dashboardPageSize) abstract voidsetDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig) abstract voidsetDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Enable or disable deployment expiryabstract voidsetElasticConfig(ElasticConfiguration elasticConfig) abstract voidsetEnableAnonymousAccess(boolean enableAnonymousAccess) abstract voidsetEnableRestrictedAdmin(boolean enableRestrictedAdmin) abstract voidsetEnableSignup(boolean enableSignup) abstract voidsetEnableViewContactDetails(boolean enableViewContactDetails) abstract voidsetGravatarServerUrl(String gravatarUrl) abstract voidsetGravatarSupportEnabled(boolean gravatarSupportEnabled) abstract voidsetInstanceName(String instanceName) abstract voidsetLookAndFeelConfiguration(LookAndFeelConfiguration lookandfeelConfiguration) abstract voidsetManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration) Set Manual Encryption configuration.abstract voidsetOfflineAgentRemovalConfig(OfflineAgentRemovalConfig offlineAgentRemovalConfig) Sets the configuration for automatic offline agent removal.abstract voidsetPersonalAccessTokensExpirationConfiguration(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Set Personal Access Tokens expiration configuration.abstract voidsetQuarantineConfiguration(@NotNull QuarantineConfiguration quarantineConfiguration) abstract voidsetRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled) abstract voidsetRemoteAgentFunctionEnabled(boolean enabled) abstract voidsetResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension) abstract voidsetScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration) abstract voidsetSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents) Set whether security token is required from remote agents as a preliminary authentication method.abstract voidsetShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers) abstract voidsetShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers) abstract voidsetSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Enables or disables Bamboo instance SOX compliance mode.abstract voidsetStorageLimit(@NotNull StorageLimits storageLimits) abstract voidsetSystemProperty(String key, String value) abstract voidsetUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed) abstract voidsetUnconfigurableFeatureDefaults(@Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults) abstract voidsetUseGzipCompression(boolean useGzipCompression) Specify if we should we use gzip compression to compress Bamboo web pages.abstract voidsetXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets) abstract voidsetXsrfProtectionEnabled(boolean xsrfProtectionEnabled) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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:
isAuditLoggingEnabledin interfaceAdministrationConfigurationInterface
-
setAuditLoggingEnabled
public abstract void setAuditLoggingEnabled(boolean auditLoggingEnabled) - Specified by:
setAuditLoggingEnabledin interfaceAdministrationConfigurationInterface
-
getBaseUrl
What is the base url for this server?- Specified by:
getBaseUrlin interfaceAdministrationConfigurationInterface- Returns:
- the base url
-
setBaseUrl
Define the system base url- Specified by:
setBaseUrlin interfaceAdministrationConfigurationInterface- Parameters:
baseUrl- the url
-
getBranchDetectionCheckInterval
public abstract int getBranchDetectionCheckInterval()Get the interval between branch detection, in seconds (default is 300)- Specified by:
getBranchDetectionCheckIntervalin interfaceAdministrationConfigurationInterface
-
setBranchDetectionCheckInterval
public abstract void setBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in seconds- Specified by:
setBranchDetectionCheckIntervalin interfaceAdministrationConfigurationInterface- Parameters:
branchDetectionCheckInterval-
-
isDeploymentExpiryEnabled
public abstract boolean isDeploymentExpiryEnabled()Description copied from interface:AdministrationConfigurationInterfaceReturns true if deployments expiry is enabled.- Specified by:
isDeploymentExpiryEnabledin interfaceAdministrationConfigurationInterface
-
setDeploymentExpiryEnabled
public abstract void setDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Description copied from interface:AdministrationConfigurationInterfaceEnable or disable deployment expiry- Specified by:
setDeploymentExpiryEnabledin interfaceAdministrationConfigurationInterface
-
getBuildExpiryConfig
- Specified by:
getBuildExpiryConfigin interfaceAdministrationConfigurationInterface
-
setBuildExpiryConfig
Deprecated.since 5.6 use helper method AdministrationConfigurationImpl.setBuildExpiryConfig- Specified by:
setBuildExpiryConfigin interfaceAdministrationConfigurationInterface
-
getBuildHangingConfig
- Specified by:
getBuildHangingConfigin interfaceAdministrationConfigurationInterface
-
setBuildHangingConfig
- Specified by:
setBuildHangingConfigin interfaceAdministrationConfigurationInterface
-
getCaptchaConfiguration
- Specified by:
getCaptchaConfigurationin interfaceAdministrationConfigurationInterface
-
getConcurrentBuildConfig
- Specified by:
getConcurrentBuildConfigin interfaceAdministrationConfigurationInterface
-
getDashboardPageSize
public abstract int getDashboardPageSize()- Specified by:
getDashboardPageSizein interfaceAdministrationConfigurationInterface
-
setDashboardPageSize
public abstract void setDashboardPageSize(int dashboardPageSize) - Specified by:
setDashboardPageSizein interfaceAdministrationConfigurationInterface
-
getDeploymentExpiryConfig
- Specified by:
getDeploymentExpiryConfigin interfaceAdministrationConfigurationInterface
-
setDeploymentExpiryConfig
- Specified by:
setDeploymentExpiryConfigin interfaceAdministrationConfigurationInterface
-
getElasticConfig
- Specified by:
getElasticConfigin interfaceAdministrationConfigurationInterface
-
setElasticConfig
- Specified by:
setElasticConfigin interfaceAdministrationConfigurationInterface
-
isEnableAnonymousAccess
public abstract boolean isEnableAnonymousAccess()- Specified by:
isEnableAnonymousAccessin interfaceAdministrationConfigurationInterface
-
setEnableAnonymousAccess
public abstract void setEnableAnonymousAccess(boolean enableAnonymousAccess) - Specified by:
setEnableAnonymousAccessin interfaceAdministrationConfigurationInterface
-
isEnableRestrictedAdmin
public abstract boolean isEnableRestrictedAdmin()- Specified by:
isEnableRestrictedAdminin interfaceAdministrationConfigurationInterface
-
setEnableRestrictedAdmin
public abstract void setEnableRestrictedAdmin(boolean enableRestrictedAdmin) - Specified by:
setEnableRestrictedAdminin interfaceAdministrationConfigurationInterface
-
isSoxComplianceModeEnabled
public abstract boolean isSoxComplianceModeEnabled()Description copied from interface:AdministrationConfigurationInterfaceWhether Bamboo instance SOX compliance mode is enabled.- Specified by:
isSoxComplianceModeEnabledin interfaceAdministrationConfigurationInterface
-
setSoxComplianceModeEnabled
public abstract void setSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Description copied from interface:AdministrationConfigurationInterfaceEnables or disables Bamboo instance SOX compliance mode.- Specified by:
setSoxComplianceModeEnabledin interfaceAdministrationConfigurationInterface
-
isEnableSignup
public abstract boolean isEnableSignup()- Specified by:
isEnableSignupin interfaceAdministrationConfigurationInterface
-
setEnableSignup
public abstract void setEnableSignup(boolean enableSignup) - Specified by:
setEnableSignupin interfaceAdministrationConfigurationInterface
-
isEnableViewContactDetails
public abstract boolean isEnableViewContactDetails()- Specified by:
isEnableViewContactDetailsin interfaceAdministrationConfigurationInterface
-
setEnableViewContactDetails
public abstract void setEnableViewContactDetails(boolean enableViewContactDetails) - Specified by:
setEnableViewContactDetailsin interfaceAdministrationConfigurationInterface
-
getGravatarServerUrl
- Specified by:
getGravatarServerUrlin interfaceAdministrationConfigurationInterface
-
setGravatarServerUrl
- Specified by:
setGravatarServerUrlin interfaceAdministrationConfigurationInterface
-
isShowAdminContactDetailsToAnonymousUsers
public abstract boolean isShowAdminContactDetailsToAnonymousUsers()- Specified by:
isShowAdminContactDetailsToAnonymousUsersin interfaceAdministrationConfigurationInterface
-
setShowAdminContactDetailsToAnonymousUsers
public abstract void setShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers) - Specified by:
setShowAdminContactDetailsToAnonymousUsersin interfaceAdministrationConfigurationInterface
-
isShowAuthorsDetailsToUsers
public abstract boolean isShowAuthorsDetailsToUsers()- Specified by:
isShowAuthorsDetailsToUsersin interfaceAdministrationConfigurationInterface- Returns:
- true if logged-in user can view authors' related subpages
-
setShowAuthorsDetailsToUsers
public abstract void setShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers) - Specified by:
setShowAuthorsDetailsToUsersin interfaceAdministrationConfigurationInterface
-
isUnauthenticatedRemoteTriggerAllowed
public abstract boolean isUnauthenticatedRemoteTriggerAllowed()- Specified by:
isUnauthenticatedRemoteTriggerAllowedin interfaceAdministrationConfigurationInterface- Returns:
- true if anonymous user can trigger repository remote trigger and Bamboo Specs detection
-
setUnauthenticatedRemoteTriggerAllowed
public abstract void setUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed) - Specified by:
setUnauthenticatedRemoteTriggerAllowedin interfaceAdministrationConfigurationInterface
-
isGravatarSupportEnabled
public abstract boolean isGravatarSupportEnabled()- Specified by:
isGravatarSupportEnabledin interfaceAdministrationConfigurationInterface
-
setGravatarSupportEnabled
public abstract void setGravatarSupportEnabled(boolean gravatarSupportEnabled) - Specified by:
setGravatarSupportEnabledin interfaceAdministrationConfigurationInterface
-
getInstanceName
- Specified by:
getInstanceNamein interfaceAdministrationConfigurationInterface
-
setInstanceName
- Specified by:
setInstanceNamein interfaceAdministrationConfigurationInterface
-
getWebResourcesSystemCounter
public abstract int getWebResourcesSystemCounter()Description copied from interface:AdministrationConfigurationInterfaceKeeps a configuration counter for webresources cache busting- Specified by:
getWebResourcesSystemCounterin interfaceAdministrationConfigurationInterface
-
incrementAndGetWebResourcesSystemCounter
public abstract int incrementAndGetWebResourcesSystemCounter()- Specified by:
incrementAndGetWebResourcesSystemCounterin interfaceAdministrationConfigurationInterface
-
getLookAndFeelConfiguration
- Specified by:
getLookAndFeelConfigurationin interfaceAdministrationConfigurationInterface
-
setLookAndFeelConfiguration
- Specified by:
setLookAndFeelConfigurationin interfaceAdministrationConfigurationInterface
-
isRemoteAgentAuthenticationEnabled
public abstract boolean isRemoteAgentAuthenticationEnabled()- Specified by:
isRemoteAgentAuthenticationEnabledin interfaceAdministrationConfigurationInterface
-
setRemoteAgentAuthenticationEnabled
public abstract void setRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled) - Specified by:
setRemoteAgentAuthenticationEnabledin interfaceAdministrationConfigurationInterface
-
isRemoteAgentFunctionEnabled
public abstract boolean isRemoteAgentFunctionEnabled()- Specified by:
isRemoteAgentFunctionEnabledin interfaceAdministrationConfigurationInterface
-
setRemoteAgentFunctionEnabled
public abstract void setRemoteAgentFunctionEnabled(boolean enabled) - Specified by:
setRemoteAgentFunctionEnabledin interfaceAdministrationConfigurationInterface
-
getRepositorySettings
- Specified by:
getRepositorySettingsin interfaceAdministrationConfigurationInterface
-
getResolveArtifactContentTypeByExtension
public abstract boolean getResolveArtifactContentTypeByExtension()Description copied from interface:AdministrationConfigurationInterfaceUse correct Content-Type header when return artifact content. See components/bamboo-web-app/src/main/webapp/WEB-INF/mimetypes.xml- Specified by:
getResolveArtifactContentTypeByExtensionin interfaceAdministrationConfigurationInterface- Returns:
- true if artifact's Content-Type header is mapped to resource extension.
-
setResolveArtifactContentTypeByExtension
public abstract void setResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension) - Specified by:
setResolveArtifactContentTypeByExtensionin interfaceAdministrationConfigurationInterface
-
getScheduleBackupConfiguration
- Specified by:
getScheduleBackupConfigurationin interfaceAdministrationConfigurationInterface
-
setScheduleBackupConfiguration
public abstract void setScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration) - Specified by:
setScheduleBackupConfigurationin interfaceAdministrationConfigurationInterface
-
getStorageLimit
Description copied from interface:AdministrationConfigurationInterfaceStorage limits configuration. Allows to limit local disk usage by artifacts.- Specified by:
getStorageLimitin interfaceAdministrationConfigurationInterface- Returns:
- storage limits
-
setStorageLimit
- Specified by:
setStorageLimitin interfaceAdministrationConfigurationInterface
-
getSystemProperty
- Specified by:
getSystemPropertyin interfaceAdministrationConfigurationInterface
-
setSystemProperty
- Specified by:
setSystemPropertyin interfaceAdministrationConfigurationInterface
-
getQuarantineConfiguration
- Specified by:
getQuarantineConfigurationin interfaceAdministrationConfigurationInterface
-
setQuarantineConfiguration
public abstract void setQuarantineConfiguration(@NotNull @NotNull QuarantineConfiguration quarantineConfiguration) - Specified by:
setQuarantineConfigurationin interfaceAdministrationConfigurationInterface
-
setUnconfigurableFeatureDefaults
public abstract void setUnconfigurableFeatureDefaults(@Nullable @Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults) - Specified by:
setUnconfigurableFeatureDefaultsin 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:
isUseGzipCompressionin 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:
setUseGzipCompressionin interfaceAdministrationConfigurationInterface- Parameters:
useGzipCompression-
-
doesXsrfAllowMutativeGets
public abstract boolean doesXsrfAllowMutativeGets()- Specified by:
doesXsrfAllowMutativeGetsin interfaceAdministrationConfigurationInterface
-
setXsrfAllowsMutativeGets
public abstract void setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets) - Specified by:
setXsrfAllowsMutativeGetsin interfaceAdministrationConfigurationInterface
-
isXsrfProtectionEnabled
public abstract boolean isXsrfProtectionEnabled()- Specified by:
isXsrfProtectionEnabledin interfaceAdministrationConfigurationInterface
-
setXsrfProtectionEnabled
public abstract void setXsrfProtectionEnabled(boolean xsrfProtectionEnabled) - Specified by:
setXsrfProtectionEnabledin interfaceAdministrationConfigurationInterface
-
isSecurityTokenRequiredFromAgents
public abstract boolean isSecurityTokenRequiredFromAgents()Description copied from interface:AdministrationConfigurationInterfaceWhether security token is required from remote agents as a preliminary authentication method.- Specified by:
isSecurityTokenRequiredFromAgentsin interfaceAdministrationConfigurationInterface
-
setSecurityTokenRequiredFromAgents
public abstract void setSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents) Description copied from interface:AdministrationConfigurationInterfaceSet whether security token is required from remote agents as a preliminary authentication method.- Specified by:
setSecurityTokenRequiredFromAgentsin interfaceAdministrationConfigurationInterface
-
setManualEncryptionConfiguration
public abstract void setManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration) Description copied from interface:AdministrationConfigurationInterfaceSet Manual Encryption configuration.- Specified by:
setManualEncryptionConfigurationin interfaceAdministrationConfigurationInterface
-
getManualEncryptionConfiguration
Description copied from interface:AdministrationConfigurationInterfaceGet Manual Encryption configuration.- Specified by:
getManualEncryptionConfigurationin interfaceAdministrationConfigurationInterface
-
setPersonalAccessTokensExpirationConfiguration
public abstract void setPersonalAccessTokensExpirationConfiguration(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Description copied from interface:AdministrationConfigurationInterfaceSet Personal Access Tokens expiration configuration.- Specified by:
setPersonalAccessTokensExpirationConfigurationin interfaceAdministrationConfigurationInterface
-
getPersonalAccessTokensExpirationConfiguration
public abstract PersonalAccessTokensExpirationConfiguration getPersonalAccessTokensExpirationConfiguration()Description copied from interface:AdministrationConfigurationInterfaceGet Personal Access Tokens expiration configuration.- Specified by:
getPersonalAccessTokensExpirationConfigurationin interfaceAdministrationConfigurationInterface
-
setOfflineAgentRemovalConfig
public abstract void setOfflineAgentRemovalConfig(OfflineAgentRemovalConfig offlineAgentRemovalConfig) Description copied from interface:AdministrationConfigurationInterfaceSets the configuration for automatic offline agent removal.- Specified by:
setOfflineAgentRemovalConfigin interfaceAdministrationConfigurationInterface- Parameters:
offlineAgentRemovalConfig- the configuration for offline agent removal
-
getOfflineAgentRemovalConfig
Description copied from interface:AdministrationConfigurationInterfaceGets the configuration for automatic offline agent removal.- Specified by:
getOfflineAgentRemovalConfigin interfaceAdministrationConfigurationInterface- Returns:
- the configuration for offline agent removal
-