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 TypeMethodDescriptionbooleanWhat is the base url for this server?intGet the interval between branch detection, in seconds (default is 300)@NotNull BuildExpiryConfig@NotNull BuildHangingConfig@NotNull CaptchaConfiguration@NotNull ConcurrentBuildConfigint@NotNull DeploymentExpiryConfig@Nullable ElasticConfiguration@NotNull EphemeralAgentsConfigurationEphemeral agents global configuration.@NotNull StringGet Manual Encryption configuration.Get Personal Access Tokens expiration configuration.@NotNull QuarantineConfiguration@NotNull RepositorySettingsbooleanUse correct Content-Type header when return artifact content.@NotNull RssDetectionConfigurationGet global RSS detection configuration.@NotNull RssSecurityConfigurationGet RSS security configuration@NotNull SerializationSecurityConfig@NotNull StorageLimitsStorage limits configuration.@Nullable StringgetSystemProperty(String key) Deprecated.since 6.0.intKeeps a configuration counter for webresources cache bustingintbooleanbooleanbooleanReturns true if deployments expiry is enabled.booleandefault booleanDeprecated.since 6.6.0.booleanbooleanbooleanbooleanbooleanWhether the quiet period is disabled globally or can be configured per repository.booleanbooleanbooleanWhether security token is required from remote agents as a preliminary authentication method.booleanbooleanbooleanWhether Bamboo instance SOX compliance mode is enabled.booleanbooleanShould we use gzip compression to compress Bamboo web pages?booleanvoidsetAgentAssignmentModificationByUsersAllowed(boolean agentAssignmentModificationByUsersAllowed) voidsetAuditLoggingEnabled(boolean auditLoggingEnabled) voidsetBaseUrl(String baseUrl) Define the system base urlvoidsetBranchDetectionCheckInterval(int branchDetectionCheckInterval) Set the interval between branch detection, in secondsvoidsetBuildExpiryConfig(BuildExpiryConfig buildExpiryConfig) voidsetBuildHangingConfig(BuildHangingConfig myBuildHangingConfig) voidsetDashboardPageSize(int dashboardPageSize) voidsetDeploymentExpiryConfig(DeploymentExpiryConfig deploymentExpiryConfig) voidsetDeploymentExpiryEnabled(boolean deploymentExpiryEnabled) Enable or disable deployment expiryvoidsetElasticConfig(ElasticConfiguration elasticConfig) voidsetEnableAnonymousAccess(boolean enableAnonymousAccess) voidsetEnableRestrictedAdmin(boolean enableRestrictedAdmin) voidsetEnableSignup(boolean enableSignup) voidsetEnableViewContactDetails(boolean enableViewContactDetails) voidsetEphemeralAgentsConfiguration(EphemeralAgentsConfiguration ephemeralAgentsConfiguration) voidsetGravatarServerUrl(String gravatarUrl) voidsetGravatarSupportEnabled(boolean gravatarSupportEnabled) voidsetInstanceName(String instanceName) voidsetLookAndFeelConfiguration(LookAndFeelConfiguration lookandfeelConfiguration) voidsetManageAcceptedSshHostKeys(boolean manageAcceptedSshHostKeys) voidsetManualEncryptionConfiguration(ManualEncryptionConfiguration manualEncryptionConfiguration) Set Manual Encryption configuration.voidsetPersonalAccessTokensExpirationConfiguration(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Set Personal Access Tokens expiration configuration.voidsetQuarantineConfiguration(@NotNull QuarantineConfiguration quarantineConfiguration) voidsetQuietPeriodGloballyDisabled(Boolean quietPeriodGloballyDisabled) Sets a quiet period globally.voidsetRemoteAgentAuthenticationEnabled(boolean remoteAgentAuthenticationEnabled) voidsetRemoteAgentFunctionEnabled(boolean enabled) voidsetResolveArtifactContentTypeByExtension(boolean resolveArtifactContentTypeByExtension) voidsetRssDetectionConfiguration(RssDetectionConfiguration rssDetectionConfiguration) Set global RSS detection configuration.voidsetRssSecurityConfiguration(RssSecurityConfiguration configuration) Set RSS security configurationvoidsetScheduleBackupConfiguration(ScheduleBackupConfiguration scheduleBackupConfiguration) voidsetSecurityTokenRequiredFromAgents(boolean securityTokenRequiredFromAgents) Set whether security token is required from remote agents as a preliminary authentication method.voidsetSerializationSecurityConfig(@NotNull SerializationSecurityConfig serializationSecurityConfig) voidsetShowAdminContactDetailsToAnonymousUsers(boolean showAdminContactDetailsToAnonymousUsers) voidsetShowAuthorsDetailsToUsers(boolean showAuthorsDetailsToUsers) voidsetSoxComplianceModeEnabled(boolean soxComplianceModeEnabled) Enables or disables Bamboo instance SOX compliance mode.voidsetStorageLimit(@NotNull StorageLimits storageLimits) voidsetSystemProperty(String key, String value) Deprecated.since 6.0.voidsetUnauthenticatedRemoteTriggerAllowed(boolean unauthenticatedRemoteTriggerAllowed) voidsetUnconfigurableFeatureDefaults(@Nullable UnconfigurableFeatureDefaults unconfigurableFeatureDefaults) voidsetUseGzipCompression(boolean useGzipCompression) Specify if we should we use gzip compression to compress Bamboo web pages.voidsetXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets) voidsetXsrfProtectionEnabled(boolean xsrfProtectionEnabled)
-
Method Details
-
isAuditLoggingEnabled
boolean isAuditLoggingEnabled() -
setAuditLoggingEnabled
void setAuditLoggingEnabled(boolean auditLoggingEnabled) -
getBaseUrl
String getBaseUrl()What is the base url for this server?- Returns:
- the base url
-
setBaseUrl
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
-
setBuildExpiryConfig
-
getBuildHangingConfig
-
setBuildHangingConfig
-
getCaptchaConfiguration
-
getConcurrentBuildConfig
-
getDashboardPageSize
int getDashboardPageSize() -
setDashboardPageSize
void setDashboardPageSize(int dashboardPageSize) -
getDeploymentExpiryConfig
-
setDeploymentExpiryConfig
-
getElasticConfig
-
setElasticConfig
-
isEnableAnonymousAccess
boolean isEnableAnonymousAccess() -
setEnableAnonymousAccess
void setEnableAnonymousAccess(boolean enableAnonymousAccess) -
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
-
isGravatarSupportEnabled
boolean isGravatarSupportEnabled() -
setGravatarSupportEnabled
void setGravatarSupportEnabled(boolean gravatarSupportEnabled) -
getInstanceName
-
setInstanceName
-
getWebResourcesSystemCounter
int getWebResourcesSystemCounter()Keeps a configuration counter for webresources cache busting -
incrementAndGetWebResourcesSystemCounter
int incrementAndGetWebResourcesSystemCounter() -
getLookAndFeelConfiguration
LookAndFeelConfiguration getLookAndFeelConfiguration() -
setLookAndFeelConfiguration
-
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
-
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
-
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
Storage limits configuration. Allows to limit local disk usage by artifacts.- Returns:
- storage limits
- Since:
- 5.9
-
setStorageLimit
-
getSystemProperty
Deprecated.since 6.0. UseBandanaManagerfor key-value storage. -
setSystemProperty
Deprecated.since 6.0. UseBandanaManagerfor key-value storage. -
getQuarantineConfiguration
-
setQuarantineConfiguration
-
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. -
doesXsrfAllowMutativeGets
boolean doesXsrfAllowMutativeGets() -
setXsrfAllowsMutativeGets
void setXsrfAllowsMutativeGets(boolean xsrfAllowsMutativeGets) -
isXsrfProtectionEnabled
boolean isXsrfProtectionEnabled() -
setXsrfProtectionEnabled
void setXsrfProtectionEnabled(boolean xsrfProtectionEnabled) -
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
Get RSS security configuration -
setRssSecurityConfiguration
Set RSS security configuration -
getRssDetectionConfiguration
Get global RSS detection configuration.- Since:
- 6.7
-
setRssDetectionConfiguration
Set global RSS detection configuration.- Since:
- 6.7
-
setManualEncryptionConfiguration
Set Manual Encryption configuration.- Since:
- 6.9
-
getManualEncryptionConfiguration
ManualEncryptionConfiguration getManualEncryptionConfiguration()Get Manual Encryption configuration.- Since:
- 6.9
-
isQuietPeriodGloballyDisabled
Boolean isQuietPeriodGloballyDisabled()Whether the quiet period is disabled globally or can be configured per repository.- Since:
- 9.3
-
setQuietPeriodGloballyDisabled
Sets a quiet period globally. If disabled, a quiet period won't be used on any repository. If enabled, the configuration is repository specific.- Since:
- 9.3
-
getEphemeralAgentsConfiguration
Ephemeral agents global configuration.- Since:
- 9.3
-
setEphemeralAgentsConfiguration
-
setPersonalAccessTokensExpirationConfiguration
void setPersonalAccessTokensExpirationConfiguration(PersonalAccessTokensExpirationConfiguration personalAccessTokensExpirationConfiguration) Set Personal Access Tokens expiration configuration.- Since:
- 9.4
-
getPersonalAccessTokensExpirationConfiguration
PersonalAccessTokensExpirationConfiguration getPersonalAccessTokensExpirationConfiguration()Get Personal Access Tokens expiration configuration.- Since:
- 9.4
-