Package com.atlassian.bamboo.admin.configuration

Interface GeneralConfigurationService

All Known Implementing Classes:

GeneralConfigurationServiceImpl

public interface GeneralConfigurationService

Service to manage general configuration

Since:

5.10

Method Summary

Modifier and Type	Method	Description
GeneralConfiguration	getGeneralConfiguration()	Retrieve the current general configuration.
GeneralConfiguration	updateGeneralConfiguration(@Nullable String instanceName, @Nullable String baseUrl, @Nullable String gravatarServerUrl, @Nullable String brokerUrl, @Nullable String brokerClientUrl, @Nullable Integer dashboardDefaultSize, @Nullable Integer branchDetectionIntervalSeconds, @Nullable Boolean gravatarSupportEnabled, @Nullable Boolean gzipCompressionEnabled, @Nullable Boolean enableRssPolling, @Nullable String rssPollingCronExpression, @Nullable Boolean quietPeriodGloballyDisabled)	Set the general configuration settings

Method Details

getGeneralConfiguration

GeneralConfiguration getGeneralConfiguration()
                                      throws URISyntaxException

Retrieve the current general configuration.

Returns:

current state of the general configuration

Throws:

URISyntaxException - if brokerURI or brokerClientURI is malformed (this should never happen)

org.acegisecurity.AccessDeniedException - if user does not have appropriate permissions (Restricted Admin)

updateGeneralConfiguration

GeneralConfiguration updateGeneralConfiguration(@Nullable
 @Nullable String instanceName,
 @Nullable
 @Nullable String baseUrl,
 @Nullable
 @Nullable String gravatarServerUrl,
 @Nullable
 @Nullable String brokerUrl,
 @Nullable
 @Nullable String brokerClientUrl,
 @Nullable
 @Nullable Integer dashboardDefaultSize,
 @Nullable
 @Nullable Integer branchDetectionIntervalSeconds,
 @Nullable
 @Nullable Boolean gravatarSupportEnabled,
 @Nullable
 @Nullable Boolean gzipCompressionEnabled,
 @Nullable
 @Nullable Boolean enableRssPolling,
 @Nullable
 @Nullable String rssPollingCronExpression,
 @Nullable
 @Nullable Boolean quietPeriodGloballyDisabled)
                                         throws WebValidationException,
URISyntaxException

Set the general configuration settings

Parameters:

instanceName -

baseUrl -

gravatarServerUrl -

brokerUrl -

brokerClientUrl -

dashboardDefaultSize -

branchDetectionIntervalSeconds -

gravatarSupportEnabled -

gzipCompressionEnabled -

enableRssPolling -

rssPollingCronExpression -

Throws:

WebValidationException - if the supplied configuration is invalid

URISyntaxException