Interface GeneralConfigurationService

  • All Known Implementing Classes:
    GeneralConfigurationServiceImpl

    public interface GeneralConfigurationService
    Service to manage general configuration
    Since:
    5.10
    • Method Detail

      • 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