Uses of Interface
org.sakaiproject.component.api.ServerConfigurationService.ConfigItem

Packages that use ServerConfigurationService.ConfigItem

Package	Description
org.sakaiproject.component.api
org.sakaiproject.util

Uses of ServerConfigurationService.ConfigItem in org.sakaiproject.component.api

Classes in org.sakaiproject.component.api that implement ServerConfigurationService.ConfigItem

Modifier and Type	Class and Description
static class	ServerConfigurationService.ConfigurationListener.BlockingConfigItem This is a special marker class that is used in the ServerConfigurationService.ConfigurationListener, returning this indicates that the config change should stop processing the change and retain the original value

Methods in org.sakaiproject.component.api that return ServerConfigurationService.ConfigItem

Modifier and Type	Method and Description
ServerConfigurationService.ConfigItem	ServerConfigurationService.ConfigurationListener.changing(ServerConfigurationService.ConfigItem currentConfigItem, ServerConfigurationService.ConfigItem newConfigItem) This will be called each time a ServerConfigurationService.ConfigItem is changed, this will be called before the item has been changed and will reflect the current values for this config item.
ServerConfigurationService.ConfigItem	ServerConfigurationService.ConfigItem.copy() Duplicate this config item This is mostly used to ensure we do not send the internal objects out where they could be changed
ServerConfigurationService.ConfigItem	ServerConfigurationService.ConfigurationListener.BlockingConfigItem.copy()
ServerConfigurationService.ConfigItem	ServerConfigurationService.getConfigItem(String name) Retrieve the internally stored the config item, this is not really for general use, if you want the value of a configuration variable then you should use ServerConfigurationService.getConfig(String, Object)
ServerConfigurationService.ConfigItem	ServerConfigurationService.registerConfigItem(ServerConfigurationService.ConfigItem configItem) Register a configuration item (or override an existing config), this should be called when changing or creating a configuration setting

Methods in org.sakaiproject.component.api that return types with arguments of type ServerConfigurationService.ConfigItem

Modifier and Type	Method and Description
List<ServerConfigurationService.ConfigItem>	ServerConfigurationService.ConfigData.getItems()
List<ServerConfigurationService.ConfigItem>	ServerConfigurationService.ConfigurationProvider.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

Methods in org.sakaiproject.component.api with parameters of type ServerConfigurationService.ConfigItem

Modifier and Type	Method and Description
void	ServerConfigurationService.ConfigurationListener.changed(ServerConfigurationService.ConfigItem configItem, ServerConfigurationService.ConfigItem previousConfigItem) This will be called each time a ServerConfigurationService.ConfigItem is changed, this will be called after the item has been changed and will reflect the new values for this config item NOTE: it does NOT include the the initial registration of that config item and initial startup of the ServerConfigurationService
ServerConfigurationService.ConfigItem	ServerConfigurationService.ConfigurationListener.changing(ServerConfigurationService.ConfigItem currentConfigItem, ServerConfigurationService.ConfigItem newConfigItem) This will be called each time a ServerConfigurationService.ConfigItem is changed, this will be called before the item has been changed and will reflect the current values for this config item.
ServerConfigurationService.ConfigItem	ServerConfigurationService.registerConfigItem(ServerConfigurationService.ConfigItem configItem) Register a configuration item (or override an existing config), this should be called when changing or creating a configuration setting

Uses of ServerConfigurationService.ConfigItem in org.sakaiproject.util

Classes in org.sakaiproject.util that implement ServerConfigurationService.ConfigItem

Modifier and Type	Class and Description
class	BasicConfigItem Provides an easy way for someone to create a ServerConfigurationService.ConfigItem which is valid without having to build their own implementation Use the static methods to easily generate the ServerConfigurationService.ConfigItem for use with the methods in the ServerConfigurationService

Methods in org.sakaiproject.util that return ServerConfigurationService.ConfigItem

Modifier and Type	Method and Description
ServerConfigurationService.ConfigItem	BasicConfigItem.copy()
static ServerConfigurationService.ConfigItem	BasicConfigItem.makeConfigItem(String name, Object value, Object defaultValue, String description, String source, boolean dynamic) Create a complete config item with default value and a description which can be dynamic
static ServerConfigurationService.ConfigItem	BasicConfigItem.makeConfigItem(String name, Object value, String source) Create a basic config item which stores a value
static ServerConfigurationService.ConfigItem	BasicConfigItem.makeConfigItem(String name, Object value, String source, boolean dynamic) Create a basic config item which can be dynamic
static ServerConfigurationService.ConfigItem	BasicConfigItem.makeConfigItem(String name, Object value, String description, String source, boolean dynamic) Create a basic config item with description which can be dynamic
static ServerConfigurationService.ConfigItem	BasicConfigItem.makeDefaultedConfigItem(String name, Object defaultValue, String source) Create a config item which stores a default value but does not have an actual value