org.kuali.rice.ksb.messaging.config
Class KSBConfigurer

java.lang.Object
  org.kuali.rice.core.api.lifecycle.BaseLifecycle
      org.kuali.rice.core.api.lifecycle.BaseCompositeLifecycle
          org.kuali.rice.core.impl.config.module.ModuleConfigurer
              org.kuali.rice.ksb.messaging.config.KSBConfigurer

All Implemented Interfaces:

EventListener, Configurer, Lifecycle, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.ApplicationListener<org.springframework.context.ApplicationEvent>, org.springframework.web.context.ServletContextAware

public class KSBConfigurer
extends ModuleConfigurer

Used to configure the embedded workflow. This could be used to configure embedded workflow programmatically but mostly this is a base class by which to hang specific configuration behavior off of through subclassing

Author:

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

Nested Class Summary

private class

KSBConfigurer.ServicePublisher

Field Summary

private List<AlternateEndpointLocation>	alternateEndpointLocations
private List<AlternateEndpoint>	alternateEndpoints
private static String	BAM_SPRING
private DataSource	bamDataSource
private org.quartz.Scheduler	exceptionMessagingScheduler
private List<Lifecycle>	internalLifecycles
private static String	MESSAGE_CLIENT_SPRING
private DataSource	messageDataSource
private static String	MODULE_SPRING
private DataSource	nonTransactionalMessageDataSource
private static String	OJB_BAM_SPRING
private static String	OJB_MESSAGE_CLIENT_SPRING
private static String	OJB_REGISTRY_SPRING
private org.springframework.transaction.PlatformTransactionManager	platformTransactionManager
private static String	REGISTRY_SERVER_SPRING
private DataSource	registryDataSource
private static String	SERVICE_BUS_CLIENT_SPRING
private List<ServiceDefinition>	services
private static String	WEB_SPRING

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

LOG

Constructor Summary

KSBConfigurer()

Method Summary

void	addAdditonalToConfig()
protected void	cleanUpConfiguration() Because our configuration is global, shutting down Rice does not get rid of objects stored there.
protected void	configureAlternateEndpoints()
protected void	configureDataSource()
protected void	configurePlatformTransactionManager()
protected void	configureScheduler()
void	doAdditionalContextStartedLogic()
void	doAdditionalContextStoppedLogic()
protected void	doAdditionalModuleStopLogic()
void	doAdditonalConfigurerValidations()
List<AlternateEndpointLocation>	getAlternateEndpointLocations()
List<AlternateEndpoint>	getAlternateEndpoints()
DataSource	getBamDataSource()
org.quartz.Scheduler	getExceptionMessagingScheduler()
DataSource	getMessageDataSource()
DataSource	getNonTransactionalMessageDataSource()
org.springframework.transaction.PlatformTransactionManager	getPlatformTransactionManager()
List<String>	getPrimarySpringFiles()
DataSource	getRegistryDataSource()
Collection<ResourceLoader>	getResourceLoadersToRegister()
List<ServiceDefinition>	getServices()
protected boolean	isBamEnabled()
protected boolean	isMessagePersistenceEnabled()
List<Lifecycle>	loadLifecycles()
private void	requeueMessages() Used to refresh the service registry after the Application Context is initialized.
void	setAlternateEndpointLocations(List<AlternateEndpointLocation> alternateEndpointLocations)
void	setAlternateEndpoints(List<AlternateEndpoint> alternateEndpoints)
void	setBamDataSource(DataSource bamDataSource)
void	setExceptionMessagingScheduler(org.quartz.Scheduler exceptionMessagingScheduler)
void	setMessageDataSource(DataSource messageDataSource)
void	setNonTransactionalMessageDataSource(DataSource nonTransactionalMessageDataSource)
void	setPlatformTransactionManager(org.springframework.transaction.PlatformTransactionManager springTransactionManager)
void	setRegistryDataSource(DataSource registryDataSource)
void	setServices(List<ServiceDefinition> javaServices)
boolean	shouldRenderWebInterface() Returns true - KSB UI should always be included.

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

addToConfig, afterPropertiesSet, destroy, doAdditionalModuleStartLogic, doContextStartedLogic, doContextStoppedLogic, getAdditionalSpringFiles, getDefaultConfigPackagePath, getDefaultSpringBeansPath, getModuleName, getProperties, getRunMode, getValidRunModes, getWebModuleBaseUrl, getWebModuleConfigName, getWebModuleConfigurationFiles, hasWebInterface, initializeResourceLoaders, isExposeServicesOnBus, isIncludeUserInterfaceComponents, isSetSOAPServicesAsDefault, onApplicationEvent, setHasWebInterface, setModuleName, setProperties, setServletContext, setValidRunModes, 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

SERVICE_BUS_CLIENT_SPRING

private static final String SERVICE_BUS_CLIENT_SPRING

See Also:

Constant Field Values

MESSAGE_CLIENT_SPRING

private static final String MESSAGE_CLIENT_SPRING

See Also:

Constant Field Values

OJB_MESSAGE_CLIENT_SPRING

private static final String OJB_MESSAGE_CLIENT_SPRING

See Also:

Constant Field Values

BAM_SPRING

private static final String BAM_SPRING

See Also:

Constant Field Values

OJB_BAM_SPRING

private static final String OJB_BAM_SPRING

See Also:

Constant Field Values

MODULE_SPRING

private static final String MODULE_SPRING

See Also:

Constant Field Values

REGISTRY_SERVER_SPRING

private static final String REGISTRY_SERVER_SPRING

See Also:

Constant Field Values

OJB_REGISTRY_SPRING

private static final String OJB_REGISTRY_SPRING

See Also:

Constant Field Values

WEB_SPRING

private static final String WEB_SPRING

See Also:

Constant Field Values

services

private List<ServiceDefinition> services

alternateEndpointLocations

private List<AlternateEndpointLocation> alternateEndpointLocations

alternateEndpoints

private List<AlternateEndpoint> alternateEndpoints

registryDataSource

private DataSource registryDataSource

messageDataSource

private DataSource messageDataSource

nonTransactionalMessageDataSource

private DataSource nonTransactionalMessageDataSource

bamDataSource

private DataSource bamDataSource

exceptionMessagingScheduler

private org.quartz.Scheduler exceptionMessagingScheduler

platformTransactionManager

private org.springframework.transaction.PlatformTransactionManager platformTransactionManager

internalLifecycles

private List<Lifecycle> internalLifecycles

Constructor Detail

KSBConfigurer

public KSBConfigurer()

Method Detail

addAdditonalToConfig

public void addAdditonalToConfig()

Overrides:

addAdditonalToConfig in class ModuleConfigurer

getPrimarySpringFiles

public List<String> getPrimarySpringFiles()

Specified by:

getPrimarySpringFiles in interface Configurer

Overrides:

getPrimarySpringFiles in class ModuleConfigurer

shouldRenderWebInterface

public boolean shouldRenderWebInterface()

Returns true - KSB UI should always be included.

Overrides:

shouldRenderWebInterface in class ModuleConfigurer

See Also:

org.kuali.rice.core.ConfigContext.getCurrentContextConfig().ModuleConfigurer#shouldRenderWebInterface()

getResourceLoadersToRegister

public Collection<ResourceLoader> getResourceLoadersToRegister()
                                                        throws Exception

Overrides:

getResourceLoadersToRegister in class ModuleConfigurer

Throws:

Exception

loadLifecycles

public List<Lifecycle> loadLifecycles()
                               throws Exception

Specified by:

loadLifecycles in interface Configurer

Overrides:

loadLifecycles in class ModuleConfigurer

Throws:

Exception

doAdditonalConfigurerValidations

public void doAdditonalConfigurerValidations()

Overrides:

doAdditonalConfigurerValidations in class ModuleConfigurer

doAdditionalContextStartedLogic

public void doAdditionalContextStartedLogic()

Overrides:

doAdditionalContextStartedLogic in class ModuleConfigurer

doAdditionalModuleStopLogic

protected void doAdditionalModuleStopLogic()
                                    throws Exception

Overrides:

doAdditionalModuleStopLogic in class ModuleConfigurer

Throws:

Exception

requeueMessages

private void requeueMessages()

Used to refresh the service registry after the Application Context is initialized. This way any services that were exported on startup will be available in the service registry once startup is complete.

isMessagePersistenceEnabled

protected boolean isMessagePersistenceEnabled()

isBamEnabled

protected boolean isBamEnabled()

configureScheduler

protected void configureScheduler()

configureDataSource

protected void configureDataSource()

configurePlatformTransactionManager

protected void configurePlatformTransactionManager()

configureAlternateEndpoints

protected void configureAlternateEndpoints()

doAdditionalContextStoppedLogic

public void doAdditionalContextStoppedLogic()

Overrides:

doAdditionalContextStoppedLogic in class ModuleConfigurer

cleanUpConfiguration

protected void cleanUpConfiguration()

Because our configuration is global, shutting down Rice does not get rid of objects stored there. For that reason we need to manually clean these up. This is most important in the case of the service bus because the configuration is used to store services to be exported. If we don't clean this up then a shutdown/startup within the same class loading context causes the service list to be doubled and results in "multiple endpoint" error messages.

getServices

public List<ServiceDefinition> getServices()

setServices

public void setServices(List<ServiceDefinition> javaServices)

getMessageDataSource

public DataSource getMessageDataSource()

setMessageDataSource

public void setMessageDataSource(DataSource messageDataSource)

getNonTransactionalMessageDataSource

public DataSource getNonTransactionalMessageDataSource()

setNonTransactionalMessageDataSource

public void setNonTransactionalMessageDataSource(DataSource nonTransactionalMessageDataSource)

getRegistryDataSource

public DataSource getRegistryDataSource()

setRegistryDataSource

public void setRegistryDataSource(DataSource registryDataSource)

getBamDataSource

public DataSource getBamDataSource()

setBamDataSource

public void setBamDataSource(DataSource bamDataSource)

getExceptionMessagingScheduler

public org.quartz.Scheduler getExceptionMessagingScheduler()

setExceptionMessagingScheduler

public void setExceptionMessagingScheduler(org.quartz.Scheduler exceptionMessagingScheduler)

getPlatformTransactionManager

public org.springframework.transaction.PlatformTransactionManager getPlatformTransactionManager()

setPlatformTransactionManager

public void setPlatformTransactionManager(org.springframework.transaction.PlatformTransactionManager springTransactionManager)

getAlternateEndpointLocations

public List<AlternateEndpointLocation> getAlternateEndpointLocations()

setAlternateEndpointLocations

public void setAlternateEndpointLocations(List<AlternateEndpointLocation> alternateEndpointLocations)

getAlternateEndpoints

public List<AlternateEndpoint> getAlternateEndpoints()

setAlternateEndpoints

public void setAlternateEndpoints(List<AlternateEndpoint> alternateEndpoints)