Package org.sakaiproject.component.api

Interface ServerConfigurationService.ConfigurationProvider

  • Enclosing interface:
    ServerConfigurationService
    public static interface ServerConfigurationService.ConfigurationProvider
    Allows registration of configuration settings (config items) from outside the Server Configuration Service and the standard set of properties files which will be loaded early on the configuration cycle NOTE: the implemented ConfigurationProvider MUST be a Spring singleton and it MUST be registered in the main Sakai application context from a component (from a webapp will not work), it also must be set explicitly to not lazy initialize (lazy-init="false"), it is always possible to update the configuration later using registerConfigItems(ConfigData) so this is mainly for loading configurations very early in the system startup

    • Method Detail

      • registerConfigItems

        List<ServerConfigurationService.ConfigItem> registerConfigItems​(ServerConfigurationService.ConfigData configData)
        Register a set of configuration items, these will be loaded after the base properties are loaded (from properties files) but before the rest of Sakai starts up so they will be allowed to override the base properties
        Parameters:
        configData - the set of current config data that currently exists
        Returns:
        a list of ConfigItems which will be loaded into the current configuration, these MUST have the name, value (OR defaultValue), and source set to non-null/non-empty values, use BasicConfigItem as an easy way to ensure the configitems are setup correctly