Package org.kuali.rice.krad.bo

Class ModuleConfiguration

java.lang.Object
org.kuali.rice.krad.bo.ModuleConfiguration
All Implemented Interfaces:
org.springframework.beans.factory.Aware, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
public class ModuleConfiguration extends Object implements org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationContextAware
This class contains various configuration properties for a Rice module.

The Rice framework is composed of several separate modules, each of which is responsible for providing a set of functionality. These include:

  • KEW - the Rice enterprise workflow module
  • KIM - the Rice identity management module
  • KSB - the Rice service bus
  • KRAD - the Rice rapid application development module
  • KRMS - the Rice business rules management syste
  • ...as well as several others. Refer to the Rice documentation for a complete list.

Client Applications will also have their own module configurations. A client application could create a single module or multiple modules, depending on how it is organized.

This ModuleConfiguration object is created during Spring initialization. The properties of this ModuleConfiguration are specified in the module's SpringBean definition XML configuration file.

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Field Details

    • namespaceCode

      protected String namespaceCode
      the module's namespace.

    • applicationContext

      protected org.springframework.context.ApplicationContext applicationContext

    • packagePrefixes

      protected List<String> packagePrefixes
      the package name prefixes for classes used in this module

    • excludedPackagePrefixes

      protected List<String> excludedPackagePrefixes

    • databaseRepositoryFilePaths

      protected List<String> databaseRepositoryFilePaths
      a list of entity description files to be loaded during initialization of the persistence service.

      Currently only used by OJB repository service implementation.

    • dataDictionaryPackages

      protected List<String> dataDictionaryPackages
      the list of data dictionary packages to be loaded for this module by the data dictionary service during system startup.

    • scriptConfigurationFilePaths

      protected List<String> scriptConfigurationFilePaths

    • resourceBundleNames

      protected List<String> resourceBundleNames

    • dataSourceName

      protected String dataSourceName

    • externalizableBusinessObjectImplementations

      protected Map<Class,Class> externalizableBusinessObjectImplementations

    • initializeDataDictionary

      protected boolean initializeDataDictionary

    • persistenceService

      protected Object persistenceService

    • providerRegistry

      protected org.kuali.rice.krad.data.provider.ProviderRegistry providerRegistry

    • dataDictionaryService

      protected DataDictionaryService dataDictionaryService
      the implementation of the data dictionary service to use for this module.

    • providers

      protected List<org.kuali.rice.krad.data.provider.Provider> providers

  • Constructor Details

    • ModuleConfiguration

      public ModuleConfiguration()
      Constructor for a ModuleConfiguration.

      Initializes the arrays of this ModuleConfiguration to empty ArrayLists.

  • Method Details

    • afterPropertiesSet

      public void afterPropertiesSet() throws Exception
      Performs additional custom initialization after the bean is created and it's properties are set by the Spring framework.

      Loads the data dictionary packages configured for this module. Also loads any OJB database repository files configured.

      Specified by:
      afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean
      Throws:
      Exception

    • loadOjbRepositoryFiles

      @Deprecated protected void loadOjbRepositoryFiles()
      Deprecated.
      This method is deprecated and won't do anything if the database repository file paths are null or empty. We use reflection here to avoid having to reference PersistenceService directly since it may or may not be on our classpath depending on whether or not KSB is in use.

    • getDatabaseRepositoryFilePaths

      @Deprecated public List<String> getDatabaseRepositoryFilePaths()
      Deprecated.
      OJB is deprecated
      Retrieves the database repository file paths to be used by the persistence service configured for this module.

      Used by the OBJ persistence service to load entity descriptors. The file paths are returned as a List of Strings. If no file paths are configured, an empty list is returned. This method should never return null.

      Returns:
      a List containing the databaseRepositoryFilePaths

    • setDatabaseRepositoryFilePaths

      @Deprecated public void setDatabaseRepositoryFilePaths(List<String> databaseRepositoryFilePaths)
      Deprecated.
      OJB is deprecated
      Initializes the list of database repository files to load during persistence service initialization.

      The repository file names are listed in the module's Spring bean configuration file. This property is set during Spring initialization.

      Parameters:
      databaseRepositoryFilePaths - the List of entity descriptor files to load.

    • getDataDictionaryPackages

      public List<String> getDataDictionaryPackages()
      Returns a list of data dictionary packages configured for this ModuleConfiguration.

      If no data dictionary packages are defined, will return an empty list. Should never return null.

      Returns:
      a List of Strings containing the names of the dataDictionaryPackages

    • setDataDictionaryPackages

      public void setDataDictionaryPackages(List<String> dataDictionaryPackages)
      Initializes the list of data dictionary packages associated with this ModuleConfiguration.

      The data dictionary packages are listed in the module's Spring bean configuration file. This property is set during Spring initialization.

      Parameters:
      dataDictionaryPackages - a List of Strings containing the dataDictionaryPackages.

    • getExternalizableBusinessObjectImplementations

      public Map<Class,Class> getExternalizableBusinessObjectImplementations()

    • setExternalizableBusinessObjectImplementations

      public void setExternalizableBusinessObjectImplementations(Map<Class,Class> externalizableBusinessObjectImplementations)

    • getPackagePrefixes

      public List<String> getPackagePrefixes()

    • setPackagePrefixes

      public void setPackagePrefixes(List<String> packagePrefixes)

    • getExcludedPackagePrefixes

      public List<String> getExcludedPackagePrefixes()

    • setExcludedPackagePrefixes

      public void setExcludedPackagePrefixes(List<String> excludedPackagePrefixes)

    • setInitializeDataDictionary

      public void setInitializeDataDictionary(boolean initializeDataDictionary)

    • getScriptConfigurationFilePaths

      public List<String> getScriptConfigurationFilePaths()

    • getResourceBundleNames

      public List<String> getResourceBundleNames()
      List of resource bundle names that will provides messages for this module

      Each bundle will point to a resource property file that contain key/value message pairs. The properties file should be on the classpath and the name is given by specifying the fully qualified class name (dot notation).

      Returns:
      List<String> resource bundle names
      See Also:

    • setResourceBundleNames

      public void setResourceBundleNames(List<String> resourceBundleNames)
      Setter for the list of resource bundle names that provides messages for the module

    • isInitializeDataDictionary

      public boolean isInitializeDataDictionary()

    • setScriptConfigurationFilePaths

      public void setScriptConfigurationFilePaths(List<String> scriptConfigurationFilePaths)

    • getNamespaceCode

      public String getNamespaceCode()

    • setNamespaceCode

      public void setNamespaceCode(String namespaceCode)

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware

    • setProviders

      public void setProviders(List<org.kuali.rice.krad.data.provider.Provider> providers)

    • getProviders

      public List<org.kuali.rice.krad.data.provider.Provider> getProviders()

    • getDataDictionaryService

      public DataDictionaryService getDataDictionaryService()

    • setDataDictionaryService

      public void setDataDictionaryService(DataDictionaryService dataDictionaryService)

    • getProviderRegistry

      public org.kuali.rice.krad.data.provider.ProviderRegistry getProviderRegistry()

    • setProviderRegistry

      public void setProviderRegistry(org.kuali.rice.krad.data.provider.ProviderRegistry providerRegistry)

    • getPersistenceService

      @Deprecated public Object getPersistenceService()
      Deprecated.

    • setPersistenceService

      @Deprecated public void setPersistenceService(Object persistenceService)
      Deprecated.

    • getDataSourceName

      public String getDataSourceName()

    • setDataSourceName

      public void setDataSourceName(String dataSourceName)

    • trimList

      protected void trimList(List<String> stringList)
      This method passes by reference. It will alter the list passed in.

    • toString

      public String toString()
      Overrides:
      toString in class Object