org.codehaus.groovy.grails.commons.spring
[Java] Interface RuntimeSpringConfiguration

public interface RuntimeSpringConfiguration

A programmable runtime Spring configuration that allows a spring ApplicationContext to be constructed at runtime. Credit must go to Solomon Duskis and the article: http://jroller.com/page/Solomon?entry=programmatic_configuration_in_spring

Authors:

Graeme

Since:

0.3

addAbstractBean

public BeanConfiguration addAbstractBean(java.lang.String name)

\ Adds an abstract bean definition to the bean factory and returns the BeanConfiguration object.

Parameters:

name - The name of the bean

Returns:

The BeanConfiguration object

addAlias

public void addAlias(java.lang.String alias, java.lang.String beanName)

Adds an alias to a given bean name.

Parameters:

alias - The alias

beanName - The bean

addBeanConfiguration

public void addBeanConfiguration(java.lang.String beanName, BeanConfiguration beanConfiguration)

Adds a bean configuration to the list of beans to be created.

Parameters:

beanName - The name of the bean in the context

beanConfiguration - The BeanConfiguration instance

addBeanDefinition

public void addBeanDefinition(java.lang.String name, org.springframework.beans.factory.config.BeanDefinition bd)

Adds a Spring BeanDefinition. Differs from BeanConfiguration which is a factory class for creating BeanDefinition instances

Parameters:

name - The name of the bean

bd - The BeanDefinition instance

addPrototypeBean

public BeanConfiguration addPrototypeBean(java.lang.String name, @SuppressWarnings("rawtypes") java.lang.Class clazz)

Adds a prototype bean definition.

Parameters:

name - The name of the bean

clazz - The class of the bean

Returns:

A BeanConfiguration instance

addPrototypeBean

public BeanConfiguration addPrototypeBean(java.lang.String name)

Adds an empty prototype bean configuration.

Parameters:

name - The name of the prototype bean

Returns:

A BeanConfiguration instance

addSingletonBean

public BeanConfiguration addSingletonBean(java.lang.String name, @SuppressWarnings("rawtypes") java.lang.Class clazz)

Adds a singleton bean definition.

Parameters:

name - The name of the bean

clazz - The class of the bean

Returns:

A BeanConfiguration instance

addSingletonBean

public BeanConfiguration addSingletonBean(java.lang.String name)

Adds an empty singleton bean configuration.

Parameters:

name - The name of the singleton bean

Returns:

A BeanConfiguration instance

addSingletonBean

@SuppressWarnings("rawtypes")
public BeanConfiguration addSingletonBean(java.lang.String name, java.lang.Class clazz, java.util.Collection args)

Creates a new singleton bean and adds it to the list of bean references.

Parameters:

name - The name of the bean

clazz - The class of the bean

args - The constructor arguments of the bean

Returns:

A BeanConfiguration instance

containsBean

public boolean containsBean(java.lang.String name)

Returns whether the runtime spring config contains the specified bean.

Parameters:

name - The bean name

Returns:

True if it does

createBeanDefinition

public org.springframework.beans.factory.support.AbstractBeanDefinition createBeanDefinition(java.lang.String name)

Creates and returns the BeanDefinition that is regsitered within the given name or returns null.

Parameters:

name - The name of the bean definition

Returns:

A BeanDefinition

createPrototypeBean

public BeanConfiguration createPrototypeBean(java.lang.String name)

Creates a new prototype bean configuration. Differs from addPrototypeBean in that it doesn't add the bean to the list of bean references to be created via the getApplicationContext() method, hence can be used for creating nested beans

Parameters:

name - The bean name

Returns:

A BeanConfiguration instance

createSingletonBean

public BeanConfiguration createSingletonBean(@SuppressWarnings("rawtypes") java.lang.Class clazz)

Creates a singleton bean configuration. Differs from addSingletonBean in that it doesn't add the bean to the list of bean references. Hence should be used for creating nested beans.

Parameters:

clazz

Returns:

A BeanConfiguration instance

createSingletonBean

@SuppressWarnings("rawtypes")
public BeanConfiguration createSingletonBean(java.lang.Class clazz, java.util.Collection constructorArguments)

Creates a singleton bean configuration. Differs from addSingletonBean in that it doesn't add the bean to the list of bean references. Hence should be used for creating nested beans

Parameters:

clazz - The bean class

constructorArguments - The constructor arguments

Returns:

A BeanConfiguration instance

createSingletonBean

public BeanConfiguration createSingletonBean(java.lang.String name)

Creates a new singleton bean configuration. Differs from addSingletonBean in that it doesn't add the bean to the list of bean references to be created via the getApplicationContext() method, hence can be used for creating nested beans

Parameters:

name - The bean name

Returns:

A BeanConfiguration instance

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Retrieves the application context from the current state.

Returns:

The ApplicationContext instance

getBeanConfig

public BeanConfiguration getBeanConfig(java.lang.String name)

Returns the BeanConfiguration for the specified name.

Parameters:

name - The name of the bean configuration

Returns:

The BeanConfiguration

getBeanDefinition

public org.springframework.beans.factory.config.BeanDefinition getBeanDefinition(java.lang.String beanName)

Obtains a BeanDefinition instance for the given beanName.

Parameters:

beanName - The beanName

Returns:

The BeanDefinition or null if it doesn't exit

getBeanNames

public java.util.List getBeanNames()

getUnrefreshedApplicationContext

public org.springframework.context.ApplicationContext getUnrefreshedApplicationContext()

registerBeansWithConfig

public void registerBeansWithConfig(RuntimeSpringConfiguration targetSpringConfig)

Registers the beans held within this RuntimeSpringConfiguration instance with the given RuntimeSpringConfiguration.

Parameters:

targetSpringConfig - The RuntimeSpringConfiguration instance

registerBeansWithContext

public void registerBeansWithContext(org.springframework.context.support.GenericApplicationContext applicationContext)

Registers the beans held within this RuntimeSpringConfiguration instance with the given ApplicationContext.

Parameters:

applicationContext - The ApplicationContext instance

registerBeansWithRegistry

public void registerBeansWithRegistry(org.springframework.beans.factory.support.BeanDefinitionRegistry registry)

Registers the beans held within this RuntimeSpringConfiguration instance with the given BeanDefinitionRegistry.

Parameters:

registry - The BeanDefinitionRegistry instance

registerPostProcessor

public void registerPostProcessor(org.springframework.beans.factory.config.BeanFactoryPostProcessor processor)

Registers a bean factory post processor with the context.

Parameters:

processor - The BeanFactoryPostProcessor instance

setBeanFactory

public void setBeanFactory(org.springframework.beans.factory.ListableBeanFactory beanFactory)

Sets the BeanFactory implementation to use.

Parameters:

beanFactory - The BeanFactory implementation

Groovy Documentation