org.kuali.rice.kew.config
Class KEWConfigurer

java.lang.Object
  org.kuali.rice.core.lifecycle.BaseLifecycle
      org.kuali.rice.core.lifecycle.BaseCompositeLifecycle
          org.kuali.rice.core.config.ModuleConfigurer
              org.kuali.rice.kew.config.KEWConfigurer

All Implemented Interfaces:

Configurer, RiceConfigEventListener, Lifecycle, org.springframework.beans.factory.InitializingBean

public class KEWConfigurer
extends ModuleConfigurer

Configures the KEW Rice module. KEW module initiation proceeds as follows:

1. Parse and load configuration for:
• Client Protocol
• Database
2. Configure and startup KEW for "Thin Client" mode OR
3. Configure and startup KEW for "Embedded Mode"

Author:

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

Field Summary

static String	KEW_DATASOURCE_JNDI
static String	KEW_DATASOURCE_OBJ

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

EMBEDDED_RUN_MODE, exposeServicesOnBus, includeUserInterfaceComponents, LOCAL_RUN_MODE, LOG, REMOTE_RUN_MODE, resourceLoaderName, setSOAPServicesAsDefault, springFileLocations, testMode, THIN_RUN_MODE, VALID_RUN_MODES, webInterface, webModuleBaseUrl, webModuleConfigName, webModuleConfigurationFiles

Constructor Summary

KEWConfigurer()

Method Summary

protected void	configureClientProtocol(Config config)
protected void	configureDataSource(Config config)
protected Lifecycle	createEmbeddedLifeCycle() TODO Because a lot of our lifecycles live behind the embedded plugin and the KEWConfigurer does not, this is a simple measure to load these without having to deal with the removal of the embedded plugin right away.
protected Lifecycle	createThinClientLifecycle()
String	getClientProtocol()
DataSource	getDataSource()
String	getDataSourceJndiName()
String	getEmbeddedSpringFileLocation()
ResourceLoader	getResourceLoaderToRegister() This method returns a resource loader that this module might want to register with the global resource loader.
protected String	getServiceNamespace(Config config)
String	getSpringFileLocations() This method returns a comma separated string of spring file locations for this module.
protected boolean	isStandaloneServer()
Config	loadConfig(Config parentConfig)
protected List<Lifecycle>	loadLifecycles() This overridden method ...
protected void	mergeDefaultsIntoParentConfig(Config parentConfig, Config defaultConfig) Merges any default configuration into the parent config.
protected Config	parseConfig(Config parentConfig)
void	setClientProtocol(String clientProtocol)
void	setDataSource(DataSource dataSource)
void	setDataSourceJndiName(String jndiDatasourceLocation)

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

afterPropertiesSet, configureRunMode, configureWebConfiguration, createResourceLoader, getDefaultConfigPackagePath, getDefaultResourceLoaderName, getDefaultResourceLoaderQName, getDefaultSpringBeansPath, getModuleName, getRunMode, getWebModuleBaseUrl, getWebModuleConfigName, getWebModuleConfigurationFiles, hasWebInterface, isExposeServicesOnBus, isIncludeUserInterfaceComponents, isSetSOAPServicesAsDefault, isTestMode, onEvent, setExposeServicesOnBus, setHasWebInterface, setIncludeUserInterfaceComponents, setModuleName, setRunMode, setSetSOAPServicesAsDefault, setSpringFileLocations, setTestMode, setWebModuleBaseUrl, setWebModuleConfigName, setWebModuleConfigurationFiles, shouldRenderWebInterface

Methods inherited from class org.kuali.rice.core.lifecycle.BaseCompositeLifecycle

start, stop

Methods inherited from class org.kuali.rice.core.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.lifecycle.Lifecycle

isStarted, start, stop

Field Detail

KEW_DATASOURCE_OBJ

public static final String KEW_DATASOURCE_OBJ

See Also:

Constant Field Values

KEW_DATASOURCE_JNDI

public static final String KEW_DATASOURCE_JNDI

See Also:

Constant Field Values

Constructor Detail

KEWConfigurer

public KEWConfigurer()

Method Detail

getSpringFileLocations

public String getSpringFileLocations()

Description copied from class: ModuleConfigurer

This method returns a comma separated string of spring file locations for this module.

Overrides:

getSpringFileLocations in class ModuleConfigurer

getEmbeddedSpringFileLocation

public String getEmbeddedSpringFileLocation()

loadLifecycles

protected List<Lifecycle> loadLifecycles()
                                  throws Exception

Description copied from class: ModuleConfigurer

This overridden method ...

Overrides:

loadLifecycles in class ModuleConfigurer

Throws:

Exception

See Also:

BaseCompositeLifecycle.loadLifecycles()

isStandaloneServer

protected boolean isStandaloneServer()

createEmbeddedLifeCycle

protected Lifecycle createEmbeddedLifeCycle()
                                     throws Exception

TODO Because a lot of our lifecycles live behind the embedded plugin and the KEWConfigurer does not, this is a simple measure to load these without having to deal with the removal of the embedded plugin right away.

Returns:

Life Cycle

Throws:

Exception - if life cycle not created

createThinClientLifecycle

protected Lifecycle createThinClientLifecycle()
                                       throws Exception

Throws:

Exception

loadConfig

public Config loadConfig(Config parentConfig)
                  throws Exception

Overrides:

loadConfig in class ModuleConfigurer

Throws:

Exception

parseConfig

protected Config parseConfig(Config parentConfig)
                      throws Exception

Throws:

Exception

mergeDefaultsIntoParentConfig

protected void mergeDefaultsIntoParentConfig(Config parentConfig,
                                             Config defaultConfig)

Merges any default configuration into the parent config. If a property appears in both places, precedence is given to the parentConfig. This allows for our defaults to not override any property which has already been defined.

Parameters:

parentConfig - parent configuration

defaultConfig - original configuration

getServiceNamespace

protected String getServiceNamespace(Config config)

configureClientProtocol

protected void configureClientProtocol(Config config)

configureDataSource

protected void configureDataSource(Config config)

getResourceLoaderToRegister

public ResourceLoader getResourceLoaderToRegister()
                                           throws Exception

Description copied from class: ModuleConfigurer

This method returns a resource loader that this module might want to register with the global resource loader.

Overrides:

getResourceLoaderToRegister in class ModuleConfigurer

Throws:

Exception

getClientProtocol

public String getClientProtocol()

setClientProtocol

public void setClientProtocol(String clientProtocol)

getDataSource

public DataSource getDataSource()

setDataSource

public void setDataSource(DataSource dataSource)

getDataSourceJndiName

public String getDataSourceJndiName()

setDataSourceJndiName

public void setDataSourceJndiName(String jndiDatasourceLocation)