org.kuali.rice.kim.config
Class KIMConfigurer

java.lang.Object
  org.kuali.rice.core.api.lifecycle.BaseLifecycle
      org.kuali.rice.core.api.lifecycle.BaseCompositeLifecycle
          org.kuali.rice.core.framework.config.module.ModuleConfigurer
              org.kuali.rice.kim.config.KIMConfigurer

All Implemented Interfaces:

Configurer, Lifecycle, org.springframework.beans.factory.Aware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.web.context.ServletContextAware

public class KIMConfigurer
extends ModuleConfigurer

This class handles the Spring based KIM configuration that is part of the Rice Configurer that must exist in all Rice based systems and clients.

Author:

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

Field Summary

static String

KIM_DATASOURCE_OBJ

Fields inherited from class org.kuali.rice.core.framework.config.module.ModuleConfigurer

LOG

Constructor Summary

KIMConfigurer()

Method Summary

void	addAdditonalToConfig()
DataSource	getDataSource()
protected String	getDefaultConfigPackagePath()
List<String>	getPrimarySpringFiles()
boolean	hasWebInterface() Indicates whether or not this module has a web interface module.
protected WebModuleConfiguration	loadWebModule() Subclasses can override the default implementation of this method if they want to provide a custom implementation for loading the web module configuration.
void	setDataSource(DataSource dataSource)

Methods inherited from class org.kuali.rice.core.framework.config.module.ModuleConfigurer

addToConfig, afterPropertiesSet, createResourceLoader, destroy, doAdditionalModuleStartLogic, doAdditionalModuleStopLogic, doAdditonalConfigurerValidations, getAdditionalSpringFiles, getCurrentContextConfigurers, getDefaultSpringBeansPath, getModuleName, getProperties, getResourceLoadersToRegister, getRunMode, getServletContext, getValidRunModes, getWebModuleConfiguration, initializeResourceLoaders, isExposeServicesOnBus, loadLifecycles, parseFileList, setModuleName, setProperties, setServletContext, setValidRunModes, shouldRenderWebInterface, start, stop, validateConfigurerState

Methods inherited from class org.kuali.rice.core.api.lifecycle.BaseLifecycle

isStarted, setStarted

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.core.api.lifecycle.Lifecycle

isStarted

Field Detail

KIM_DATASOURCE_OBJ

public static final String KIM_DATASOURCE_OBJ

See Also:

Constant Field Values

Constructor Detail

KIMConfigurer

public KIMConfigurer()

Method Detail

getDefaultConfigPackagePath

protected String getDefaultConfigPackagePath()

Overrides:

getDefaultConfigPackagePath in class ModuleConfigurer

getPrimarySpringFiles

public List<String> getPrimarySpringFiles()

Specified by:

getPrimarySpringFiles in interface Configurer

Overrides:

getPrimarySpringFiles in class ModuleConfigurer

addAdditonalToConfig

public void addAdditonalToConfig()

Overrides:

addAdditonalToConfig in class ModuleConfigurer

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

hasWebInterface

public boolean hasWebInterface()

Description copied from class: ModuleConfigurer

Indicates whether or not this module has a web interface module. Default implementation returns false, but subclasses can override to return true if they have a web module that can be loaded.

Overrides:

hasWebInterface in class ModuleConfigurer

Returns:

true if this module has a web interface, false otherwise

loadWebModule

protected WebModuleConfiguration loadWebModule()

Description copied from class: ModuleConfigurer

Subclasses can override the default implementation of this method if they want to provide a custom implementation for loading the web module configuration. This method will be called from #getWebModuleConfiguration when #hasWebInterface return true.

Overrides:

loadWebModule in class ModuleConfigurer

Returns:

the loaded web module configuration, this method should *never* return null.