org.springframework.beans.factory.groovy

Class GroovyBeanDefinitionReader

java.lang.Object

org.springframework.beans.factory.support.AbstractBeanDefinitionReader

org.springframework.beans.factory.groovy.GroovyBeanDefinitionReader

All Implemented Interfaces:

BeanDefinitionReader, EnvironmentCapable

public class GroovyBeanDefinitionReader
extends AbstractBeanDefinitionReader

A Groovy-based reader for Spring bean definitions: like a Groovy builder, but more of a DSL for Spring configuration.

This bean definition reader also understands XML bean definition files, allowing for seamless mixing and matching with Groovy bean definition files.

Typically applied to a DefaultListableBeanFactory or a GenericApplicationContext, but can be used against any BeanDefinitionRegistry implementation.

Example Syntax

 import org.hibernate.SessionFactory
 import org.apache.commons.dbcp.BasicDataSource

 def reader = new GroovyBeanDefinitionReader(myApplicationContext)
 reader.beans {
     dataSource(BasicDataSource) {                  // <--- invokeMethod
         driverClassName = "org.hsqldb.jdbcDriver"
         url = "jdbc:hsqldb:mem:grailsDB"
         username = "sa"                            // <-- setProperty
         password = ""
         settings = [mynew:"setting"]
     }
     sessionFactory(SessionFactory) {
         dataSource = dataSource                    // <-- getProperty for retrieving references
     }
     myService(MyService) {
         nestedBean = { AnotherBean bean ->         // <-- setProperty with closure for nested bean
             dataSource = dataSource
         }
     }
 }

You can also load resources containing beans defined in a Groovy script using either the AbstractBeanDefinitionReader.loadBeanDefinitions(Resource...) or AbstractBeanDefinitionReader.loadBeanDefinitions(String...) method, with a script looking similar to the following.

 import org.hibernate.SessionFactory
 import org.apache.commons.dbcp.BasicDataSource

 beans {
     dataSource(BasicDataSource) {
         driverClassName = "org.hsqldb.jdbcDriver"
         url = "jdbc:hsqldb:mem:grailsDB"
         username = "sa"
         password = ""
         settings = [mynew:"setting"]
     }
     sessionFactory(SessionFactory) {
         dataSource = dataSource
     }
     myService(MyService) {
         nestedBean = { AnotherBean bean ->
             dataSource = dataSource
         }
     }
 }

Since:

4.0

Author:

Jeff Brown, Graeme Rocher, Juergen Hoeller, Sam Brannen

See Also:

BeanDefinitionRegistry, DefaultListableBeanFactory, GenericApplicationContext, GenericGroovyApplicationContext

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	GroovyBeanDefinitionReader.DeferredProperty This class is used to defer the adding of a property to a bean definition until later.
private class	GroovyBeanDefinitionReader.GroovyRuntimeBeanReference A RuntimeBeanReference that takes care of adding new properties to runtime references.

Field Summary

Fields

Modifier and Type	Field and Description
private Binding	binding
private GroovyBeanDefinitionWrapper	currentBeanDefinition
private java.util.Map<java.lang.String,GroovyBeanDefinitionReader.DeferredProperty>	deferredProperties
private XmlBeanDefinitionReader	groovyDslXmlBeanDefinitionReader Groovy DSL XmlBeanDefinitionReader for loading bean definitions via the Groovy DSL, typically configured with XML validation disabled.
private MetaClass	metaClass
private java.util.Map<java.lang.String,java.lang.String>	namespaces
private XmlBeanDefinitionReader	standardXmlBeanDefinitionReader Standard XmlBeanDefinitionReader created with default settings for loading bean definitions from XML files.

Fields inherited from class org.springframework.beans.factory.support.AbstractBeanDefinitionReader

logger

Constructor Summary

Constructors

Constructor and Description
GroovyBeanDefinitionReader(BeanDefinitionRegistry registry) Create a new GroovyBeanDefinitionReader for the given BeanDefinitionRegistry.
GroovyBeanDefinitionReader(XmlBeanDefinitionReader xmlBeanDefinitionReader) Create a new GroovyBeanDefinitionReader based on the given XmlBeanDefinitionReader, loading bean definitions into its BeanDefinitionRegistry and delegating Groovy DSL loading to it.

Method Summary

Modifier and Type	Method and Description
private boolean	addDeferredProperty(java.lang.String property, java.lang.Object newValue)
protected void	applyPropertyToBeanDefinition(java.lang.String name, java.lang.Object value)
GenericBeanDefinition	bean(java.lang.Class<?> type) Define an inner bean definition.
AbstractBeanDefinition	bean(java.lang.Class<?> type, java.lang.Object... args) Define an inner bean definition.
GroovyBeanDefinitionReader	beans(Closure closure) Defines a set of beans for the given block or closure.
private GroovyDynamicElementReader	createDynamicElementReader(java.lang.String namespace)
private void	finalizeDeferredProperties()
Binding	getBinding() Return a specified binding for Groovy variables, if any.
MetaClass	getMetaClass()
java.lang.Object	getProperty(java.lang.String name) This method overrides property retrieval in the scope of the GroovyBeanDefinitionReader to either: Retrieve a variable from the bean builder's binding if it exists Retrieve a RuntimeBeanReference for a specific bean if it exists Otherwise just delegate to MetaClass.getProperty which will resolve properties from the GroovyBeanDefinitionReader itself
void	importBeans(java.lang.String resourcePattern) Import Spring bean definitions from either XML or Groovy sources into the current bean builder instance.
protected GroovyBeanDefinitionReader	invokeBeanDefiningClosure(Closure callable) When a method argument is only a closure it is a set of bean definitions.
private GroovyBeanDefinitionWrapper	invokeBeanDefiningMethod(java.lang.String beanName, java.lang.Object[] args) This method is called when a bean definition node is called.
java.lang.Object	invokeMethod(java.lang.String name, java.lang.Object arg) This method overrides method invocation to create beans for each method name that takes a class argument.
int	loadBeanDefinitions(EncodedResource encodedResource) Load bean definitions from the specified Groovy script or XML file.
int	loadBeanDefinitions(Resource resource) Load bean definitions from the specified Groovy script or XML file.
private java.lang.Object	manageListIfNecessary(java.util.List<?> list) Checks whether there are any RuntimeBeanReferences inside the List and converts it to a ManagedList if necessary.
private java.lang.Object	manageMapIfNecessary(java.util.Map<?,?> map) Checks whether there are any RuntimeBeanReferences inside the Map and converts it to a ManagedMap if necessary.
protected java.util.List<java.lang.Object>	resolveConstructorArguments(java.lang.Object[] args, int start, int end)
void	setBinding(Binding binding) Set the binding, i.e.
void	setMetaClass(MetaClass metaClass)
void	setProperty(java.lang.String name, java.lang.Object value) This method overrides property setting in the scope of the GroovyBeanDefinitionReader to set properties on the current bean definition.
void	xmlns(java.util.Map<java.lang.String,java.lang.String> definition) Define a Spring XML namespace definition to use.

Methods inherited from class org.springframework.beans.factory.support.AbstractBeanDefinitionReader

getBeanClassLoader, getBeanFactory, getBeanNameGenerator, getEnvironment, getRegistry, getResourceLoader, loadBeanDefinitions, loadBeanDefinitions, loadBeanDefinitions, loadBeanDefinitions, setBeanClassLoader, setBeanNameGenerator, setEnvironment, setResourceLoader

Methods inherited from class java.lang.Object

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

Field Detail

standardXmlBeanDefinitionReader

private final XmlBeanDefinitionReader standardXmlBeanDefinitionReader

Standard XmlBeanDefinitionReader created with default settings for loading bean definitions from XML files.

groovyDslXmlBeanDefinitionReader

private final XmlBeanDefinitionReader groovyDslXmlBeanDefinitionReader

Groovy DSL XmlBeanDefinitionReader for loading bean definitions via the Groovy DSL, typically configured with XML validation disabled.

namespaces

private final java.util.Map<java.lang.String,java.lang.String> namespaces

deferredProperties

private final java.util.Map<java.lang.String,GroovyBeanDefinitionReader.DeferredProperty> deferredProperties

metaClass

private MetaClass metaClass

binding

private Binding binding

currentBeanDefinition

private GroovyBeanDefinitionWrapper currentBeanDefinition

Constructor Detail

GroovyBeanDefinitionReader

public GroovyBeanDefinitionReader(BeanDefinitionRegistry registry)

Create a new GroovyBeanDefinitionReader for the given BeanDefinitionRegistry.

Parameters:

registry - the BeanDefinitionRegistry to load bean definitions into

GroovyBeanDefinitionReader

public GroovyBeanDefinitionReader(XmlBeanDefinitionReader xmlBeanDefinitionReader)

Create a new GroovyBeanDefinitionReader based on the given XmlBeanDefinitionReader, loading bean definitions into its BeanDefinitionRegistry and delegating Groovy DSL loading to it.

The supplied XmlBeanDefinitionReader should typically be pre-configured with XML validation disabled.

Parameters:

xmlBeanDefinitionReader - the XmlBeanDefinitionReader to derive the registry from and to delegate Groovy DSL loading to

Method Detail

setMetaClass

public void setMetaClass(MetaClass metaClass)

getMetaClass

public MetaClass getMetaClass()

setBinding

public void setBinding(Binding binding)

Set the binding, i.e. the Groovy variables available in the scope of a GroovyBeanDefinitionReader closure.

getBinding

public Binding getBinding()

Return a specified binding for Groovy variables, if any.

loadBeanDefinitions

public int loadBeanDefinitions(Resource resource)
                        throws BeanDefinitionStoreException

Load bean definitions from the specified Groovy script or XML file.

Note that ".xml" files will be parsed as XML content; all other kinds of resources will be parsed as Groovy scripts.

Parameters:

resource - the resource descriptor for the Groovy script or XML file

Returns:

the number of bean definitions found

Throws:

BeanDefinitionStoreException - in case of loading or parsing errors

loadBeanDefinitions

public int loadBeanDefinitions(EncodedResource encodedResource)
                        throws BeanDefinitionStoreException

Load bean definitions from the specified Groovy script or XML file.

Note that ".xml" files will be parsed as XML content; all other kinds of resources will be parsed as Groovy scripts.

Parameters:

encodedResource - the resource descriptor for the Groovy script or XML file, allowing specification of an encoding to use for parsing the file

Returns:

the number of bean definitions found

Throws:

BeanDefinitionStoreException - in case of loading or parsing errors

beans

public GroovyBeanDefinitionReader beans(Closure closure)

Defines a set of beans for the given block or closure.

Parameters:

closure - the block or closure

Returns:

this GroovyBeanDefinitionReader instance

bean

public GenericBeanDefinition bean(java.lang.Class<?> type)

Define an inner bean definition.

Parameters:

type - the bean type

Returns:

the bean definition

bean

public AbstractBeanDefinition bean(java.lang.Class<?> type,
                                   java.lang.Object... args)

Define an inner bean definition.

Parameters:

type - the bean type

args - the constructors arguments and closure configurer

Returns:

the bean definition

xmlns

public void xmlns(java.util.Map<java.lang.String,java.lang.String> definition)

Define a Spring XML namespace definition to use.

Parameters:

definition - the namespace definition

importBeans

public void importBeans(java.lang.String resourcePattern)
                 throws java.io.IOException

Import Spring bean definitions from either XML or Groovy sources into the current bean builder instance.

Parameters:

resourcePattern - the resource pattern

Throws:

java.io.IOException

invokeMethod

public java.lang.Object invokeMethod(java.lang.String name,
                                     java.lang.Object arg)

This method overrides method invocation to create beans for each method name that takes a class argument.

addDeferredProperty

private boolean addDeferredProperty(java.lang.String property,
                                    java.lang.Object newValue)

finalizeDeferredProperties

private void finalizeDeferredProperties()

invokeBeanDefiningClosure

protected GroovyBeanDefinitionReader invokeBeanDefiningClosure(Closure callable)

When a method argument is only a closure it is a set of bean definitions.

Parameters:

callable - the closure argument

Returns:

this GroovyBeanDefinitionReader instance

invokeBeanDefiningMethod

private GroovyBeanDefinitionWrapper invokeBeanDefiningMethod(java.lang.String beanName,
                                                             java.lang.Object[] args)

This method is called when a bean definition node is called.

Parameters:

beanName - the name of the bean to define

args - the arguments to the bean. The first argument is the class name, the last argument is sometimes a closure. All the arguments in between are constructor arguments.

Returns:

the bean definition wrapper

resolveConstructorArguments

protected java.util.List<java.lang.Object> resolveConstructorArguments(java.lang.Object[] args,
                                                                       int start,
                                                                       int end)

manageMapIfNecessary

private java.lang.Object manageMapIfNecessary(java.util.Map<?,?> map)

Checks whether there are any RuntimeBeanReferences inside the Map and converts it to a ManagedMap if necessary.

Parameters:

map - the original Map

Returns:

either the original map or a managed copy of it

manageListIfNecessary

private java.lang.Object manageListIfNecessary(java.util.List<?> list)

Checks whether there are any RuntimeBeanReferences inside the List and converts it to a ManagedList if necessary.

Parameters:

list - the original List

Returns:

either the original list or a managed copy of it

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

This method overrides property setting in the scope of the GroovyBeanDefinitionReader to set properties on the current bean definition.

applyPropertyToBeanDefinition

protected void applyPropertyToBeanDefinition(java.lang.String name,
                                             java.lang.Object value)

getProperty

public java.lang.Object getProperty(java.lang.String name)

This method overrides property retrieval in the scope of the GroovyBeanDefinitionReader to either:

• Retrieve a variable from the bean builder's binding if it exists
• Retrieve a RuntimeBeanReference for a specific bean if it exists
• Otherwise just delegate to MetaClass.getProperty which will resolve properties from the GroovyBeanDefinitionReader itself

createDynamicElementReader

private GroovyDynamicElementReader createDynamicElementReader(java.lang.String namespace)