Skip navigation links
A B C D E G H I L M N O P R S T U V W X 

A

addChildAc() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Increment the count of ACs that call this one parent.
afterPropertiesSet() - Method in class org.sakaiproject.util.SakaiProperties
 
afterPropertiesSet() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
afterSingletonCreation(String) - Method in class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 

B

BasicConfigHistory - Class in org.sakaiproject.util
This is a basic version of the Config history to make it easy for people to create items to place in the config history
BasicConfigHistory(int, String, Object) - Constructor for class org.sakaiproject.util.BasicConfigHistory
Make a basic history config to store in the history of a config item
BasicConfigHistory(int, long, String, Object) - Constructor for class org.sakaiproject.util.BasicConfigHistory
 
BasicConfigItem - Class in org.sakaiproject.util
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
BasicConfigItem() - Constructor for class org.sakaiproject.util.BasicConfigItem
Do NOT use this - INTERNAL ONLY
BasicConfigItem(String, Object, Object, String, String, boolean) - Constructor for class org.sakaiproject.util.BasicConfigItem
Constructor for when you know the source, leave defaultValue null if you do not know have one OR if this is a registration for a defaultValue then fill in the defaultValue and leave the value null (either value OR defaultValue MUST be set) Recommend use of the static make methods unless you know what you are doing
BeanFactoryPostProcessorCreator - Interface in org.sakaiproject.util
Allows for programmatic creation of BeanFactoryPostProcessor objects.
BlockingConfigItem() - Constructor for class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
SPECIAL marker class, indicates that the config change should stop processing the change and retain the original value

C

CACHE_COMPONENTS - Static variable in class org.sakaiproject.component.cover.ComponentManager
If true, covers will cache the components they find once - good for production, bad for some unit testing.
changed(Object, String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
Called whenever this config item is changed
changed(Object, String) - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
changed(ServerConfigurationService.ConfigItem, ServerConfigurationService.ConfigItem) - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener
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
changed(Object, String) - Method in class org.sakaiproject.util.BasicConfigItem
 
changing(ServerConfigurationService.ConfigItem, ServerConfigurationService.ConfigItem) - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener
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.
close() - Method in interface org.sakaiproject.component.api.ComponentManager
Close the component manager, shutting down any created singletons.
close() - Static method in class org.sakaiproject.component.cover.ComponentManager
 
close() - Method in class org.sakaiproject.component.impl.MockCompMgr
 
close() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Close the component manager, shutting down any created singletons.
CLOSE_ON_SHUTDOWN - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
System property to control if we close on jvm shutdown (if set) or on the loss of our last child (if not set).
ComponentManager - Interface in org.sakaiproject.component.api
...
ComponentManager - Class in org.sakaiproject.component.cover
ComponentManager is a static Cover for the Component Manager; see that interface for usage details.
components - Variable in class org.sakaiproject.component.impl.MockCompMgr
Not really needed but this allows us to at least put fake ones into this CM for tests if we like
ComponentsLoader - Class in org.sakaiproject.util
Load the available Sakai components into the shared component manager's Spring ApplicationContext
ComponentsLoader() - Constructor for class org.sakaiproject.util.ComponentsLoader
 
ComponentsLoader(File) - Constructor for class org.sakaiproject.util.ComponentsLoader
 
CONFIGURATION_COMPONENT_PACKAGE - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
The Sakai configuration component package, which must be the last defined.
CONFIGURATION_COMPONENTS - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
The Sakai configuration components, which must be the first loaded.
CONFIGURATION_FILE_NAME - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
 
contains(Class) - Method in interface org.sakaiproject.component.api.ComponentManager
Check if this interface Class has a registered component.
contains(String) - Method in interface org.sakaiproject.component.api.ComponentManager
Check if this interface Class name has a registered component.
contains(Class) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
contains(String) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
contains(Class) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
contains(String) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
contains(Class) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Check if this interface Class has a registered component.
contains(String) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Check if this interface Class name has a registered component.
contextDestroyed(ServletContextEvent) - Method in class org.sakaiproject.util.SakaiContextLoaderListener
Close the root web application context.
contextInitialized(ServletContextEvent) - Method in class org.sakaiproject.util.SakaiContextLoaderListener
Initialize the root web application context.
copy() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
Duplicate this config item This is mostly used to ensure we do not send the internal objects out where they could be changed
copy() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
copy() - Method in class org.sakaiproject.util.BasicConfigItem
 
createInstance() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
CURRENT_PORTAL_PATH - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
Key in the ThreadLocalManager for the path based on the current request.
CURRENT_PORTAL_PATH - Static variable in class org.sakaiproject.component.cover.ServerConfigurationService
 
CURRENT_SERVER_URL - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
Key in the ThreadLocalManager for the serverUrl based on the current request.
CURRENT_SERVER_URL - Static variable in class org.sakaiproject.component.cover.ServerConfigurationService
 

D

DEFAULT_CONFIGURATION_FILE - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
 
defaultValue - Variable in class org.sakaiproject.util.BasicConfigItem
the default value for this config (null indicates it is not set)
description - Variable in class org.sakaiproject.util.BasicConfigItem
the human readable description for this configuration value (null if not set)
destroySingletons() - Method in class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 
dynamic - Variable in class org.sakaiproject.util.BasicConfigItem
Indicates if this config item is dynamic (true) or static (false).
DynamicDefaultSakaiProperties - Class in org.sakaiproject.component.impl
Handle any default sakai.properties values that need to be set dynamically.
DynamicDefaultSakaiProperties() - Constructor for class org.sakaiproject.component.impl.DynamicDefaultSakaiProperties
 

E

equals(Object) - Method in class org.sakaiproject.util.BasicConfigHistory
 

G

generateSiteId() - Method in class org.sakaiproject.component.cover.TestComponentManagerContainer
Convenience method to create a somewhat unique site id for testing.
get(Class<T>) - Method in interface org.sakaiproject.component.api.ComponentManager
Find a component that is registered to provide this interface.
get(String) - Method in interface org.sakaiproject.component.api.ComponentManager
Find a component that is registered to provide this interface.
get(Class<T>) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
get(String) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
get(Class<T>) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
get(String) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
get(Class<T>) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Find a component that is registered to provide this interface.
get(String) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Find a component that is registered to provide this interface.
getAccessPath() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the path to the access service on the server relative to the base URL for the server.
getAccessPath() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getAccessUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the access service on the server - append any additional path to the end.
getAccessUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getApplicationContext() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Access the ApplicationContext
getBean(String, Class, Object[]) - Method in class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 
getBeanFactoryPostProcessors() - Method in interface org.sakaiproject.util.BeanFactoryPostProcessorCreator
 
getBeanFactoryPostProcessors() - Method in class org.sakaiproject.util.SakaiProperties
 
getBoolean(String, boolean) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access some named configuration value as a boolean.
getBoolean(String, boolean) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getCatalina() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Check the environment for catalina's base or home directory.
getCategoryGroups(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
KNL-989 Access the list of groups by category (site type)
getCategoryGroups(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
Access the list of groups by category (site type)
getChanged() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getChanged() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getChanged() - Method in class org.sakaiproject.util.BasicConfigItem
 
getComponentManager() - Method in class org.sakaiproject.component.cover.TestComponentManagerContainer
get the current component manager
getConfig() - Method in interface org.sakaiproject.component.api.ComponentManager
Deprecated.
This method is redundant, not used by any known client, would expose implementation details, and will be removed in a future release. Use the ServerConfigurationService instead.
getConfig(String, T) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Retrieves config values from the configuration service
getConfig() - Static method in class org.sakaiproject.component.cover.ComponentManager
Deprecated.
This method is redundant, not used by any known client, would expose implementation details, and will be removed in a future release. Use the ServerConfigurationService instead.
getConfig() - Method in class org.sakaiproject.component.impl.MockCompMgr
 
getConfig() - Method in class org.sakaiproject.component.impl.SpringCompMgr
 
getConfigData() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Returns data about all the configuration values which are known to the system at the time and some stats which are useful
getConfigItem(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
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)
getDefaultTools(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the list of tool ids that are selected by default for this category.
getDefaultTools(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getDefaultValue() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getDefaultValue() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getDefaultValue() - Method in class org.sakaiproject.util.BasicConfigItem
 
getDescription() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getDescription() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getDescription() - Method in class org.sakaiproject.util.BasicConfigItem
 
getGatewaySiteId() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the site id for the gateway (public) site.
getGatewaySiteId() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getHelpUrl(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the help service on the server - append in the path the tool well known id for context sensitive help.
getHelpUrl(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getHistory() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getHistory() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getHistory() - Method in class org.sakaiproject.util.BasicConfigItem
 
getInstance() - Static method in class org.sakaiproject.component.cover.ComponentManager
Access the component manager of the single instance.
getInstance() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
Access the component instance: special cover only method.
getInt(String, int) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access some named configuration value as an int.
getInt(String, int) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getItems() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigData
 
getLoadedProperties() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
getLocaleFromString(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Parse a string into a Locale
getLoggedOutUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to use as a redirect when the user has logged out.
getLoggedOutUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getName() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getName() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getName() - Method in class org.sakaiproject.util.BasicConfigItem
 
getObject() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
getObjectType() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
getPortalUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the portal service on the server - append any additional path to the end.
getPortalUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getProperties() - Method in class org.sakaiproject.util.SakaiProperties
INTERNAL
getRawProperties() - Method in class org.sakaiproject.util.SakaiProperties
INTERNAL
getRawProperty(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the undereferenced value of the given property.
getRegisteredConfigItems() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigData
 
getRegisteredInterfaces() - Method in interface org.sakaiproject.component.api.ComponentManager
Get all interfaces registered in the component manager.
getRegisteredInterfaces() - Static method in class org.sakaiproject.component.cover.ComponentManager
 
getRegisteredInterfaces() - Method in class org.sakaiproject.component.impl.MockCompMgr
 
getRegisteredInterfaces() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Get all interfaces registered in the component manager.
getRequested() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getRequested() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getRequested() - Method in class org.sakaiproject.util.BasicConfigItem
 
getSakaiHomePath() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the file path to the "sakai home" on the app server.
getSakaiHomePath() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getSakaiLocales() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Get the list of allowed locales as controlled by config params for "locales" and "locales.more" Defaults when nothing is specified in the config files come from SakaiLocales.SAKAI_LOCALES_DEFAULT
getSeparateProperties() - Method in class org.sakaiproject.util.SakaiProperties
Gets the individual properties from each properties file which is read in
getServerId() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the unique (to the cluster) id of the server.
getServerId() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getServerIdInstance() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the combined server / instance id.
getServerIdInstance() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getServerInstance() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the unique (to the cluster) instance id of the server.
getServerInstance() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getServerName() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the server DNS name.
getServerName() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getServerUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the root of the server - append any additional path to the end.
getServerUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getService(String) - Method in class org.sakaiproject.component.cover.TestComponentManagerContainer
Convenience method to get a service bean from the Sakai component manager.
getServiceProxy(Class, InvocationHandler) - Static method in class org.sakaiproject.component.cover.TestComponentManagerContainer
Returns a dynamic proxy for a service interface.
getSource() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigHistory
 
getSource() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getSource() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getSource() - Method in class org.sakaiproject.util.BasicConfigHistory
 
getSource() - Method in class org.sakaiproject.util.BasicConfigItem
 
getSources() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigData
 
getString(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access some named configuration value as a string. 1) IF "name=value" THEN this will return "value" 2) IF "name=" THEN this will return null 3) IF name is not defined in the config THEN this will return "" (empty string)
getString(String, String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access some named configuration value as a string. 1) IF "name=value" THEN this will return "value" 2) IF "name=" THEN this will return null 3) IF name is not defined in the config THEN this will return the provided default value
getString(String, String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getString(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getStrings(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access some named configuration values as an array of strings.
getStrings(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getTimestamp() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigHistory
 
getTimestamp() - Method in class org.sakaiproject.util.BasicConfigHistory
 
getToolCategories(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
access the list of tool categories for the given site type
getToolCategories(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
access the list of tool categories for the given site type
getToolCategoriesAsMap(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
access the map of tool categories to tool ids for this site type
getToolCategoriesAsMap(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
access the map of tool categories to tool ids for this site type
getToolGroup(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
KNL-989 Access the list of tools by group
getToolGroup(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getToolOrder(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
KNL-989 Access the list of tool ids in order for this category, to impose on the displays of many tools
getToolOrder(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getToolsRequired(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the list of tool ids that are required for this category.
getToolsRequired(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
Access the list of tools by group
getToolToCategoryMap(String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
access a map of tool id to tool category id for this site type
getToolToCategoryMap(String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
access a map of tool id to tool category id for this site type
getToolUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the tool dispatcher service on the server - append any additional path to the end.
getToolUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getTotalConfigItems() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigData
 
getType() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getType() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getType() - Method in class org.sakaiproject.util.BasicConfigItem
 
getType() - Method in class org.sakaiproject.util.SakaiComponentEvent
 
getUnRegisteredConfigItems() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigData
 
getUserHomeUrl() - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Access the URL to the user's "home" (My Workspace) in the service.
getUserHomeUrl() - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
getValue() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigHistory
 
getValue() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getValue() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getValue() - Method in class org.sakaiproject.util.BasicConfigHistory
 
getValue() - Method in class org.sakaiproject.util.BasicConfigItem
 
getVersion() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigHistory
 
getVersion() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
getVersion() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
getVersion() - Method in class org.sakaiproject.util.BasicConfigHistory
 
getVersion() - Method in class org.sakaiproject.util.BasicConfigItem
 

H

hasBeenClosed() - Method in interface org.sakaiproject.component.api.ComponentManager
Check if the ComponentManager has already been or is in the processing of being closed.
hasBeenClosed() - Static method in class org.sakaiproject.component.cover.ComponentManager
 
hasBeenClosed() - Method in class org.sakaiproject.component.impl.MockCompMgr
 
hasBeenClosed() - Method in class org.sakaiproject.component.impl.SpringCompMgr
 
hashCode() - Method in class org.sakaiproject.util.BasicConfigHistory
 

I

init() - Method in class org.sakaiproject.component.impl.DynamicDefaultSakaiProperties
 
init(boolean) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Initialize the component manager.
init() - Method in class org.sakaiproject.util.SakaiPropertyPromoter
 
initWebApplicationContext(ServletContext) - Method in class org.sakaiproject.component.impl.SakaiContextLoader
Allows loading/override of custom bean definitions from sakai.home The pattern is the 'servlet_name-context.xml'
instance() - Static method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
invokePostProcessorCreators(ConfigurableListableBeanFactory) - Method in class org.sakaiproject.util.SakaiApplicationContext
Add bean-created post processors.
isBeanNameAtEnd() - Method in class org.sakaiproject.util.ReversiblePropertyOverrideConfigurer
 
isDefaulted() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
isDefaulted() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
isDefaulted() - Method in class org.sakaiproject.util.BasicConfigItem
 
isDynamic() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
Indicates is this config item is dynamic or static (default is static)
isDynamic() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
isDynamic() - Method in class org.sakaiproject.util.BasicConfigItem
 
isRegistered() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
isRegistered() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
isRegistered() - Method in class org.sakaiproject.util.BasicConfigItem
 
isSecured() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
 
isSecured() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
isSecured() - Method in class org.sakaiproject.util.BasicConfigHistory
 
isSecured() - Method in class org.sakaiproject.util.BasicConfigItem
 
isSingleton() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
isTestingMode() - Static method in class org.sakaiproject.component.cover.ComponentManager
 

L

load(ConfigurableApplicationContext, String) - Method in class org.sakaiproject.util.ComponentsLoader
 
loadBeanDefinitions(ConfigurableListableBeanFactory) - Method in class org.sakaiproject.util.SakaiApplicationContext
 
loadComponent(Class, Object) - Method in interface org.sakaiproject.component.api.ComponentManager
Load a singleton already created component for this interface class as a singleton.
loadComponent(String, Object) - Method in interface org.sakaiproject.component.api.ComponentManager
Load a singleton already created component for this interface class as a singleton.
loadComponent(Class, Object) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
loadComponent(String, Object) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
loadComponent(ConfigurableApplicationContext, List<Resource>, ClassLoader) - Method in class org.sakaiproject.component.cover.TestComponentManagerContainer
Load the application context using a single classloader
loadComponent(Class, Object) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
loadComponent(String, Object) - Method in class org.sakaiproject.component.impl.MockCompMgr
 
loadComponent(Class, Object) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Load a singleton already created component for this interface class as a singleton.
loadComponent(String, Object) - Method in class org.sakaiproject.component.impl.SpringCompMgr
Load a singleton already created component for this interface class as a singleton.
loadComponentPackage(File, ConfigurableApplicationContext) - Method in class org.sakaiproject.util.ComponentsLoader
Load one component package into the AC
loadComponents() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Locate the component loader, and load any available components.
loadParentContext(ServletContext) - Method in class org.sakaiproject.component.impl.SakaiContextLoader
Spring allows a parent ApplicationContext to be set during the creation of a new ApplicationContext Sakai sets the SakaiApplicationContext as the parent which managed by the ComponentManager
loadProperties(Properties) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
Load properties into the given instance.

M

m_ac - Variable in class org.sakaiproject.component.impl.SpringCompMgr
The Spring Application Context.
m_childCount - Variable in class org.sakaiproject.component.impl.SpringCompMgr
A count of the # of child AC's that call us parent.
m_componentManager - Static variable in class org.sakaiproject.component.cover.ComponentManager
A component manager - use the Spring based one.
m_hasBeenClosed - Variable in class org.sakaiproject.component.impl.SpringCompMgr
Records that close has been called.
m_loadedComponents - Variable in class org.sakaiproject.component.impl.SpringCompMgr
The already created components given to manage (their interface names).
makeConfigItem(String, Object, String) - Static method in class org.sakaiproject.util.BasicConfigItem
Create a basic config item which stores a value
makeConfigItem(String, Object, String, boolean) - Static method in class org.sakaiproject.util.BasicConfigItem
Create a basic config item which can be dynamic
makeConfigItem(String, Object, String, String, boolean) - Static method in class org.sakaiproject.util.BasicConfigItem
Create a basic config item with description which can be dynamic
makeConfigItem(String, Object, Object, String, String, boolean) - Static method in class org.sakaiproject.util.BasicConfigItem
Create a complete config item with default value and a description which can be dynamic
makeDefaultedConfigItem(String, Object, String) - Static method in class org.sakaiproject.util.BasicConfigItem
Create a config item which stores a default value but does not have an actual value
mergeProperties() - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
Return a merged Properties instance containing both the loaded properties and properties set on this FactoryBean.
MockCompMgr - Class in org.sakaiproject.component.impl
This is a totally fake component manager which is just going to pretend to try to find services, maybe later this could try to use the sakai mock stuff but for now it is just here to stop the CM from firing up during unit tests
MockCompMgr(boolean) - Constructor for class org.sakaiproject.component.impl.MockCompMgr
Startup the CM as a mock system for unit tests

N

name - Variable in class org.sakaiproject.util.BasicConfigItem
the name/key for this configuration value
newPackageClassLoader(File) - Method in class org.sakaiproject.util.ComponentsLoader
Create the class loader for this component package
NoisierDefaultListableBeanFactory - Class in org.sakaiproject.util
In Spring 1.2.6 and 1.2.8, when there's a problem pre-instantiating any singleton bean, all existing singleton beans are immediately destroyed.
NoisierDefaultListableBeanFactory() - Constructor for class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 
noisyClose - Static variable in class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 

O

onRefresh() - Method in class org.sakaiproject.util.SakaiApplicationContext
Load initial beans before going through the default logic.
org.sakaiproject.component.api - package org.sakaiproject.component.api
 
org.sakaiproject.component.cover - package org.sakaiproject.component.cover
 
org.sakaiproject.component.impl - package org.sakaiproject.component.impl
 
org.sakaiproject.component.locales - package org.sakaiproject.component.locales
 
org.sakaiproject.util - package org.sakaiproject.util
 

P

postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class org.sakaiproject.util.SakaiApplicationContext
Before post-processing, load beans which have declared that they want to add post-processors dynamically.
preInstantiateSingletons() - Method in class org.sakaiproject.util.NoisierDefaultListableBeanFactory
 
prepareBeanFactory(ConfigurableListableBeanFactory) - Method in class org.sakaiproject.util.SakaiApplicationContext
Load component manager configurations.
processKey(ConfigurableListableBeanFactory, String, String) - Method in class org.sakaiproject.util.ReversiblePropertyOverrideConfigurer
 

R

registerConfigItem(ServerConfigurationService.ConfigItem) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Register a configuration item (or override an existing config), this should be called when changing or creating a configuration setting
registerConfigItems(ServerConfigurationService.ConfigData) - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigurationProvider
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
registerListener(ServerConfigurationService.ConfigurationListener) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
Register a listener which will be notified whenever there is a configuration setting change, there is no need to unregister a listener as all listener references will be held weakly (if there are no more variables which reference the listener then it will be GCed and removed from the list of listeners) Registering the same ServerConfigurationService.ConfigurationListener object multiple times has no effect
removeChildAc() - Method in class org.sakaiproject.component.impl.SpringCompMgr
Decrement the count of ACs that call this one parent.
requested() - Method in interface org.sakaiproject.component.api.ServerConfigurationService.ConfigItem
Called whenever this config item is requested
requested() - Method in class org.sakaiproject.component.api.ServerConfigurationService.ConfigurationListener.BlockingConfigItem
 
requested() - Method in class org.sakaiproject.util.BasicConfigItem
 
ReversiblePropertyOverrideConfigurer - Class in org.sakaiproject.util
This is just a version of Spring's PropertyOverrideConfigurer that lets the bean name be specified Sakai-style before the property name instead of after.
ReversiblePropertyOverrideConfigurer() - Constructor for class org.sakaiproject.util.ReversiblePropertyOverrideConfigurer
 

S

SAKAI_COMPONENTS_ROOT_SYS_PROP - Static variable in interface org.sakaiproject.component.api.ComponentManager
The java system property name where the full path to the components packages.
SAKAI_COMPONENTS_ROOT_SYS_PROP - Static variable in class org.sakaiproject.component.cover.ComponentManager
 
SAKAI_LOCALES_DEFAULT - Static variable in class org.sakaiproject.component.locales.SakaiLocales
This should be complete list of supported locales and should match the commented list in default.sakai.properties It MUST be a comma separated list of locale keys (be careful with your formatting)
SakaiApplicationContext - Class in org.sakaiproject.util
Hook some Sakai-specific operations into the normal ApplicationContext refresh cycle: read component manager configuration files, give creators of PostProcessor objects (e.g., SakaiProperties) a chance to do their work, and load a few central components before the rest.
SakaiApplicationContext() - Constructor for class org.sakaiproject.util.SakaiApplicationContext
 
SakaiComponentEvent - Class in org.sakaiproject.util
Sakai specific events.
SakaiComponentEvent(Object, SakaiComponentEvent.Type) - Constructor for class org.sakaiproject.util.SakaiComponentEvent
 
SakaiComponentEvent.Type - Enum in org.sakaiproject.util
 
SakaiContextLoader - Class in org.sakaiproject.component.impl
Sakai's extension to Spring's ContextLoader - adds the location of the ComponentManager shared AC, linking the local AC to it as parent, and loading localy hosted components into shared.
SakaiContextLoader() - Constructor for class org.sakaiproject.component.impl.SakaiContextLoader
 
SakaiContextLoaderListener - Class in org.sakaiproject.util
Sakai's extension to the Spring ContextLoaderListener - use our ContextLoader, and increment / decrement the child count of the ComponentManager on init / destroy.
SakaiContextLoaderListener() - Constructor for class org.sakaiproject.util.SakaiContextLoaderListener
 
SakaiLocales - Class in org.sakaiproject.component.locales
This stores constants related to the Sakai default locales
SakaiLocales() - Constructor for class org.sakaiproject.component.locales.SakaiLocales
 
SakaiProperties - Class in org.sakaiproject.util
A configurer for "sakai.properties" files.
SakaiProperties() - Constructor for class org.sakaiproject.util.SakaiProperties
 
SakaiProperties.SakaiPropertiesFactoryBean - Class in org.sakaiproject.util
Blatantly stolen from the Spring classes in order to get access to the properties files as they are read in, this could not be done by overrides because the stupid finals and private vars, this is why frameworks should never use final and private in their code.... sigh
SakaiPropertiesFactoryBean() - Constructor for class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
SakaiPropertyPromoter - Class in org.sakaiproject.util
Some Sakai properties have traditionally also been exposed as Java system properties.
SakaiPropertyPromoter() - Constructor for class org.sakaiproject.util.SakaiPropertyPromoter
 
secured - Variable in class org.sakaiproject.util.BasicConfigHistory
 
ServerConfigurationService - Interface in org.sakaiproject.component.api
ServerConfigurationService provides information about how the server is configured.
ServerConfigurationService - Class in org.sakaiproject.component.cover
ServerConfigurationService is a static Cover for the ServerConfigurationService; see that interface for usage details.
ServerConfigurationService() - Constructor for class org.sakaiproject.component.cover.ServerConfigurationService
 
ServerConfigurationService.ConfigData - Interface in org.sakaiproject.component.api
Defines the config data holding class
ServerConfigurationService.ConfigHistory - Interface in org.sakaiproject.component.api
Defines the config item history class
ServerConfigurationService.ConfigItem - Interface in org.sakaiproject.component.api
Defines the config item holding class
ServerConfigurationService.ConfigurationListener - Interface in org.sakaiproject.component.api
Allows a service to be notified when configuration settings are changed, It is up to the implementor to ignore the changes they do not care about.
ServerConfigurationService.ConfigurationListener.BlockingConfigItem - Class in org.sakaiproject.component.api
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
ServerConfigurationService.ConfigurationProvider - Interface in org.sakaiproject.component.api
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
SERVICE_NAME - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
This string can be used to find the service in the service manager.
SERVICE_NAME - Static variable in class org.sakaiproject.component.cover.ServerConfigurationService
 
setBeanNameAtEnd(boolean) - Method in class org.sakaiproject.util.ReversiblePropertyOverrideConfigurer
 
setBeanNameAtEnd(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setBeanNameSeparator(String) - Method in class org.sakaiproject.util.ReversiblePropertyOverrideConfigurer
 
setBeanNameSeparator(String) - Method in class org.sakaiproject.util.SakaiProperties
 
setConfigLocations(String[]) - Method in class org.sakaiproject.util.SakaiApplicationContext
 
setFileEncoding(String) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setFileEncoding(String) - Method in class org.sakaiproject.util.SakaiProperties
 
setIgnoreInvalidKeys(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setIgnoreResourceNotFound(boolean) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setIgnoreResourceNotFound(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setIgnoreUnresolvablePlaceholders(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setInitialSingletonNames(String[]) - Method in class org.sakaiproject.util.SakaiApplicationContext
 
setLateRefresh(boolean) - Static method in class org.sakaiproject.component.cover.ComponentManager
 
setLocalOverride(boolean) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setLocalOverride(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setLocation(Resource) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setLocation(Resource) - Method in class org.sakaiproject.util.SakaiProperties
 
setLocations(Resource[]) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setLocations(Resource[]) - Method in class org.sakaiproject.util.SakaiProperties
 
setOrder(int) - Method in class org.sakaiproject.util.SakaiProperties
 
setPlaceholderPrefix(String) - Method in class org.sakaiproject.util.SakaiProperties
 
setPlaceholderSuffix(String) - Method in class org.sakaiproject.util.SakaiProperties
 
setProperties(Properties) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setProperties(Properties) - Method in class org.sakaiproject.util.SakaiProperties
 
setPropertiesArray(Properties[]) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setPropertiesArray(Properties[]) - Method in class org.sakaiproject.util.SakaiProperties
 
setPropertiesPersister(PropertiesPersister) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setSakaiHome(String) - Static method in class org.sakaiproject.component.cover.TestComponentManagerContainer
 
setSakaiProperties(SakaiProperties) - Method in class org.sakaiproject.util.SakaiPropertyPromoter
 
setSakaiPropertyToSystemPropertyMap(Map<String, String>) - Method in class org.sakaiproject.util.SakaiPropertyPromoter
 
setSearchSystemEnvironment(boolean) - Method in class org.sakaiproject.util.SakaiProperties
 
setSecured(boolean) - Method in class org.sakaiproject.util.BasicConfigHistory
 
setSingleton(boolean) - Method in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
setSystemPropertiesMode(int) - Method in class org.sakaiproject.util.SakaiProperties
 
setSystemPropertiesModeName(String) - Method in class org.sakaiproject.util.SakaiProperties
 
shutdown() - Static method in class org.sakaiproject.component.cover.ComponentManager
TESTING ONLY
closes and then destroys the component manager
WARNING: this is NOT safe to do in a production system
SHUTDOWN_ON_ERROR - Static variable in class org.sakaiproject.component.impl.SpringCompMgr
System property to control if we close the jvm on a error occurring at startup.
source - Variable in class org.sakaiproject.util.BasicConfigHistory
 
source - Variable in class org.sakaiproject.util.BasicConfigItem
the name of the most recent source for this config value (e.g. sakai/sakai.properties)
SPRING_CONTEXT_SUFFIX - Static variable in class org.sakaiproject.component.impl.SakaiContextLoader
 
SpringCompMgr - Class in org.sakaiproject.component.impl
SpringCompMgr manages API implementation components using the Springframework ApplicationContext.
SpringCompMgr(ComponentManager) - Constructor for class org.sakaiproject.component.impl.SpringCompMgr
Initialize.

T

TestComponentManagerContainer - Class in org.sakaiproject.component.cover
A container for a Test Component Manager that can be configured with one of more components.
TestComponentManagerContainer(String) - Constructor for class org.sakaiproject.component.cover.TestComponentManagerContainer
 
TestComponentManagerContainer(String, Properties) - Constructor for class org.sakaiproject.component.cover.TestComponentManagerContainer
create a component manager based on a list of component.xml
testingMode - Static variable in class org.sakaiproject.component.cover.ComponentManager
Setup the CM in testingMode if this is true (this is to be used for unit tests only), has no effect if the CM is already initialized
timestamp - Variable in class org.sakaiproject.util.BasicConfigHistory
This is the time when the config was changed
toolGroupIsRequired(String, String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
KNL-989 Returns true if selected tool is contained in pre-initialized list of required items
toolGroupIsRequired(String, String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
toolGroupIsSelected(String, String) - Method in interface org.sakaiproject.component.api.ServerConfigurationService
KNL-989 Returns true if selected tool is contained in pre-initialized list of selected items
toolGroupIsSelected(String, String) - Static method in class org.sakaiproject.component.cover.ServerConfigurationService
 
toString() - Method in class org.sakaiproject.util.BasicConfigHistory
 
TYPE_ARRAY - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 
TYPE_BOOLEAN - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 
TYPE_INT - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 
TYPE_STRING - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 
TYPES - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 

U

UNKNOWN - Static variable in interface org.sakaiproject.component.api.ServerConfigurationService
 

V

validComponentsPackage(File) - Method in class org.sakaiproject.util.ComponentsLoader
Test if this File is a valid components package directory.
value - Variable in class org.sakaiproject.util.BasicConfigHistory
This is the previous value of the config (the value from before the timestamp)
value - Variable in class org.sakaiproject.util.BasicConfigItem
the actual stored value for this config (null indicates it is not set)
valueOf(String) - Static method in enum org.sakaiproject.util.SakaiComponentEvent.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.sakaiproject.util.SakaiComponentEvent.Type
Returns an array containing the constants of this enum type, in the order they are declared.
version - Variable in class org.sakaiproject.util.BasicConfigHistory
 

W

waitTillConfigured() - Method in interface org.sakaiproject.component.api.ComponentManager
Deprecated. 
waitTillConfigured() - Static method in class org.sakaiproject.component.cover.ComponentManager
When the component manager this can be called by a background thread to wait until the component manager has been configured.
waitTillConfigured() - Method in class org.sakaiproject.component.impl.MockCompMgr
 
waitTillConfigured() - Method in class org.sakaiproject.component.impl.SpringCompMgr
 

X

XML_FILE_EXTENSION - Static variable in class org.sakaiproject.util.SakaiProperties.SakaiPropertiesFactoryBean
 
A B C D E G H I L M N O P R S T U V W X 
Skip navigation links

Copyright © 2003–2016 The Sakai Foundation. All rights reserved.