org.springframework.beans.factory.xml
Class DefaultXmlBeanDefinitionParser

java.lang.Object
  org.springframework.beans.factory.xml.DefaultXmlBeanDefinitionParser

All Implemented Interfaces:

XmlBeanDefinitionParser

public class DefaultXmlBeanDefinitionParser
extends Object
implements XmlBeanDefinitionParser

Default implementation of the XmlBeanDefinitionParser interface. Parses bean definitions according to the "spring-beans" DTD, that is, Spring's default XML bean definition format.

The structure, elements and attribute names of the required XML document are hard-coded in this class. (Of course a transform could be run if necessary to produce this format). <beans> doesn't need to be the root element of the XML document: This class will parse all bean definition elements in the XML file, not regarding the actual root element.

Since:

18.12.2003

Author:

Rod Johnson, Juergen Hoeller, Rob Harrop

Field Summary

static String	ABSTRACT_ATTRIBUTE
static String	ALIAS_ATTRIBUTE
static String	ALIAS_ELEMENT
static String	ARG_TYPE_ELEMENT
static String	ARG_TYPE_MATCH_ATTRIBUTE
static String	AUTOWIRE_ATTRIBUTE
static String	AUTOWIRE_AUTODETECT_VALUE
static String	AUTOWIRE_BY_NAME_VALUE
static String	AUTOWIRE_BY_TYPE_VALUE
static String	AUTOWIRE_CONSTRUCTOR_VALUE
static String	BEAN_ELEMENT
static String	BEAN_NAME_DELIMITERS
static String	BEAN_REF_ATTRIBUTE
static String	CLASS_ATTRIBUTE
static String	CONSTRUCTOR_ARG_ELEMENT
static String	DEFAULT_AUTOWIRE_ATTRIBUTE
static String	DEFAULT_DEPENDENCY_CHECK_ATTRIBUTE
static String	DEFAULT_DESTROY_METHOD_ATTRIBUTE
static String	DEFAULT_INIT_METHOD_ATTRIBUTE
static String	DEFAULT_LAZY_INIT_ATTRIBUTE
static String	DEFAULT_VALUE
static String	DEPENDENCY_CHECK_ALL_ATTRIBUTE_VALUE
static String	DEPENDENCY_CHECK_ATTRIBUTE
static String	DEPENDENCY_CHECK_OBJECTS_ATTRIBUTE_VALUE
static String	DEPENDENCY_CHECK_SIMPLE_ATTRIBUTE_VALUE
static String	DEPENDS_ON_ATTRIBUTE
static String	DESCRIPTION_ELEMENT
static String	DESTROY_METHOD_ATTRIBUTE
static String	ENTRY_ELEMENT
static String	FACTORY_BEAN_ATTRIBUTE
static String	FACTORY_METHOD_ATTRIBUTE
static String	ID_ATTRIBUTE
static String	IDREF_ELEMENT
static String	IMPORT_ELEMENT
static String	INDEX_ATTRIBUTE
static String	INIT_METHOD_ATTRIBUTE
static String	KEY_ATTRIBUTE
static String	KEY_ELEMENT
static String	KEY_REF_ATTRIBUTE
static String	LAZY_INIT_ATTRIBUTE
static String	LIST_ELEMENT
static String	LOCAL_REF_ATTRIBUTE
protected org.apache.commons.logging.Log	logger
static String	LOOKUP_METHOD_ELEMENT
static String	MAP_ELEMENT
static String	NAME_ATTRIBUTE
static String	NULL_ELEMENT
static String	PARENT_ATTRIBUTE
static String	PARENT_REF_ATTRIBUTE
static String	PROP_ELEMENT
static String	PROPERTY_ELEMENT
static String	PROPS_ELEMENT
static String	REF_ATTRIBUTE
static String	REF_ELEMENT
static String	REPLACED_METHOD_ELEMENT
static String	REPLACER_ATTRIBUTE
static String	RESOURCE_ATTRIBUTE
static String	SET_ELEMENT
static String	SINGLETON_ATTRIBUTE
static String	TRUE_VALUE Value of a T/F attribute that represents true.
static String	TYPE_ATTRIBUTE
static String	VALUE_ATTRIBUTE
static String	VALUE_ELEMENT
static String	VALUE_REF_ATTRIBUTE

Constructor Summary

DefaultXmlBeanDefinitionParser()

Method Summary

protected int	getAutowireMode(String att)
protected BeanDefinitionReader	getBeanDefinitionReader() Return the BeanDefinitionReader that this parser has been called from.
protected String	getDefaultAutowire() Return the default autowire setting for the document that's currently parsed.
protected String	getDefaultDependencyCheck() Return the default dependency-check setting for the document that's currently parsed.
protected String	getDefaultDestroyMethod() Return the default destroy-method setting for the document that's currently parsed.
protected String	getDefaultInitMethod() Return the default init-method setting for the document that's currently parsed.
protected String	getDefaultLazyInit() Return the default lazy-init flag for the document that's currently parsed.
protected int	getDependencyCheck(String att)
protected Resource	getResource() Return the descriptor for the XML resource that this parser works on.
protected void	importBeanDefinitionResource(Element ele) Parse an "import" element and load the bean definitions from the given resource into the bean factory.
protected void	initDefaults(Element root) Initialize the default lazy-init, autowire and dependency check settings.
protected BeanDefinitionHolder	parseBeanDefinitionElement(Element ele, boolean isInnerBean) Parse a standard bean definition into a BeanDefinitionHolder, including bean name and aliases.
protected BeanDefinition	parseBeanDefinitionElement(Element ele, String beanName) Parse the BeanDefinition itself, without regard to name or aliases.
protected int	parseBeanDefinitions(Element root) Parse the elements at the root level in the document: "import", "alias", "bean".
protected void	parseConstructorArgElement(Element ele, String beanName, ConstructorArgumentValues cargs) Parse a constructor-arg element.
protected ConstructorArgumentValues	parseConstructorArgElements(Element beanEle, String beanName) Parse constructor-arg sub-elements of the given bean element.
protected Object	parseKeyElement(Element keyEle, String beanName) Parse a key sub-element of a map element.
protected List	parseListElement(Element collectionEle, String beanName) Parse a list element.
protected void	parseLookupOverrideSubElements(Element beanEle, String beanName, MethodOverrides overrides) Parse lookup-override sub-elements of the given bean element.
protected Map	parseMapElement(Element mapEle, String beanName) Parse a map element.
protected void	parsePropertyElement(Element ele, String beanName, MutablePropertyValues pvs) Parse a property element.
protected MutablePropertyValues	parsePropertyElements(Element beanEle, String beanName) Parse property sub-elements of the given bean element.
protected Object	parsePropertySubElement(Element ele, String beanName) Parse a value, ref or collection sub-element of a property or constructor-arg element.
protected Object	parsePropertyValue(Element ele, String beanName, String propertyName) Get the value of a property element.
protected Properties	parsePropsElement(Element propsEle, String beanName) Parse a props element.
protected void	parseReplacedMethodSubElements(Element beanEle, String beanName, MethodOverrides overrides) Parse replaced-method sub-elements of the given bean element.
protected Set	parseSetElement(Element collectionEle, String beanName) Parse a set element.
protected void	postProcessXml(Element root) Allow the XML to be extensible by processing any custom element types last, after we finished processing the bean definitions.
protected void	preProcessXml(Element root) Allow the XML to be extensible by processing any custom element types first, before we start to process the bean definitions.
int	registerBeanDefinitions(BeanDefinitionReader reader, Document doc, Resource resource) Parses bean definitions according to the "spring-beans" DTD.
protected void	setDefaultAutowire(String defaultAutowire) Set the default autowire setting for the document that's currently parsed.
protected void	setDefaultDependencyCheck(String defaultDependencyCheck) Set the default dependency-check setting for the document that's currently parsed.
protected void	setDefaultDestroyMethod(String defaultDestroyMethod) Set the default destroy-method setting for the document that's currently parsed.
protected void	setDefaultInitMethod(String defaultInitMethod) Set the default init-method setting for the document that's currently parsed.
protected void	setDefaultLazyInit(String defaultLazyInit) Set the default lazy-init flag for the document that's currently parsed.

Methods inherited from class java.lang.Object

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

Field Detail

BEAN_NAME_DELIMITERS

public static final String BEAN_NAME_DELIMITERS

See Also:

Constant Field Values

TRUE_VALUE

public static final String TRUE_VALUE

Value of a T/F attribute that represents true. Anything else represents false. Case seNsItive.

See Also:

Constant Field Values

DEFAULT_VALUE

public static final String DEFAULT_VALUE

See Also:

Constant Field Values

DESCRIPTION_ELEMENT

public static final String DESCRIPTION_ELEMENT

See Also:

Constant Field Values

AUTOWIRE_BY_NAME_VALUE

public static final String AUTOWIRE_BY_NAME_VALUE

See Also:

Constant Field Values

AUTOWIRE_BY_TYPE_VALUE

public static final String AUTOWIRE_BY_TYPE_VALUE

See Also:

Constant Field Values

AUTOWIRE_CONSTRUCTOR_VALUE

public static final String AUTOWIRE_CONSTRUCTOR_VALUE

See Also:

Constant Field Values

AUTOWIRE_AUTODETECT_VALUE

public static final String AUTOWIRE_AUTODETECT_VALUE

See Also:

Constant Field Values

DEPENDENCY_CHECK_ALL_ATTRIBUTE_VALUE

public static final String DEPENDENCY_CHECK_ALL_ATTRIBUTE_VALUE

See Also:

Constant Field Values

DEPENDENCY_CHECK_SIMPLE_ATTRIBUTE_VALUE

public static final String DEPENDENCY_CHECK_SIMPLE_ATTRIBUTE_VALUE

See Also:

Constant Field Values

DEPENDENCY_CHECK_OBJECTS_ATTRIBUTE_VALUE

public static final String DEPENDENCY_CHECK_OBJECTS_ATTRIBUTE_VALUE

See Also:

Constant Field Values

DEFAULT_LAZY_INIT_ATTRIBUTE

public static final String DEFAULT_LAZY_INIT_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_AUTOWIRE_ATTRIBUTE

public static final String DEFAULT_AUTOWIRE_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_DEPENDENCY_CHECK_ATTRIBUTE

public static final String DEFAULT_DEPENDENCY_CHECK_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_INIT_METHOD_ATTRIBUTE

public static final String DEFAULT_INIT_METHOD_ATTRIBUTE

See Also:

Constant Field Values

DEFAULT_DESTROY_METHOD_ATTRIBUTE

public static final String DEFAULT_DESTROY_METHOD_ATTRIBUTE

See Also:

Constant Field Values

IMPORT_ELEMENT

public static final String IMPORT_ELEMENT

See Also:

Constant Field Values

RESOURCE_ATTRIBUTE

public static final String RESOURCE_ATTRIBUTE

See Also:

Constant Field Values

ALIAS_ELEMENT

public static final String ALIAS_ELEMENT

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

See Also:

Constant Field Values

ALIAS_ATTRIBUTE

public static final String ALIAS_ATTRIBUTE

See Also:

Constant Field Values

BEAN_ELEMENT

public static final String BEAN_ELEMENT

See Also:

Constant Field Values

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

See Also:

Constant Field Values

PARENT_ATTRIBUTE

public static final String PARENT_ATTRIBUTE

See Also:

Constant Field Values

CLASS_ATTRIBUTE

public static final String CLASS_ATTRIBUTE

See Also:

Constant Field Values

ABSTRACT_ATTRIBUTE

public static final String ABSTRACT_ATTRIBUTE

See Also:

Constant Field Values

SINGLETON_ATTRIBUTE

public static final String SINGLETON_ATTRIBUTE

See Also:

Constant Field Values

LAZY_INIT_ATTRIBUTE

public static final String LAZY_INIT_ATTRIBUTE

See Also:

Constant Field Values

AUTOWIRE_ATTRIBUTE

public static final String AUTOWIRE_ATTRIBUTE

See Also:

Constant Field Values

DEPENDENCY_CHECK_ATTRIBUTE

public static final String DEPENDENCY_CHECK_ATTRIBUTE

See Also:

Constant Field Values

DEPENDS_ON_ATTRIBUTE

public static final String DEPENDS_ON_ATTRIBUTE

See Also:

Constant Field Values

INIT_METHOD_ATTRIBUTE

public static final String INIT_METHOD_ATTRIBUTE

See Also:

Constant Field Values

DESTROY_METHOD_ATTRIBUTE

public static final String DESTROY_METHOD_ATTRIBUTE

See Also:

Constant Field Values

FACTORY_METHOD_ATTRIBUTE

public static final String FACTORY_METHOD_ATTRIBUTE

See Also:

Constant Field Values

FACTORY_BEAN_ATTRIBUTE

public static final String FACTORY_BEAN_ATTRIBUTE

See Also:

Constant Field Values

CONSTRUCTOR_ARG_ELEMENT

public static final String CONSTRUCTOR_ARG_ELEMENT

See Also:

Constant Field Values

INDEX_ATTRIBUTE

public static final String INDEX_ATTRIBUTE

See Also:

Constant Field Values

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

See Also:

Constant Field Values

PROPERTY_ELEMENT

public static final String PROPERTY_ELEMENT

See Also:

Constant Field Values

REF_ATTRIBUTE

public static final String REF_ATTRIBUTE

See Also:

Constant Field Values

VALUE_ATTRIBUTE

public static final String VALUE_ATTRIBUTE

See Also:

Constant Field Values

LOOKUP_METHOD_ELEMENT

public static final String LOOKUP_METHOD_ELEMENT

See Also:

Constant Field Values

REPLACED_METHOD_ELEMENT

public static final String REPLACED_METHOD_ELEMENT

See Also:

Constant Field Values

REPLACER_ATTRIBUTE

public static final String REPLACER_ATTRIBUTE

See Also:

Constant Field Values

ARG_TYPE_ELEMENT

public static final String ARG_TYPE_ELEMENT

See Also:

Constant Field Values

ARG_TYPE_MATCH_ATTRIBUTE

public static final String ARG_TYPE_MATCH_ATTRIBUTE

See Also:

Constant Field Values

REF_ELEMENT

public static final String REF_ELEMENT

See Also:

Constant Field Values

IDREF_ELEMENT

public static final String IDREF_ELEMENT

See Also:

Constant Field Values

BEAN_REF_ATTRIBUTE

public static final String BEAN_REF_ATTRIBUTE

See Also:

Constant Field Values

LOCAL_REF_ATTRIBUTE

public static final String LOCAL_REF_ATTRIBUTE

See Also:

Constant Field Values

PARENT_REF_ATTRIBUTE

public static final String PARENT_REF_ATTRIBUTE

See Also:

Constant Field Values

VALUE_ELEMENT

public static final String VALUE_ELEMENT

See Also:

Constant Field Values

NULL_ELEMENT

public static final String NULL_ELEMENT

See Also:

Constant Field Values

LIST_ELEMENT

public static final String LIST_ELEMENT

See Also:

Constant Field Values

SET_ELEMENT

public static final String SET_ELEMENT

See Also:

Constant Field Values

MAP_ELEMENT

public static final String MAP_ELEMENT

See Also:

Constant Field Values

ENTRY_ELEMENT

public static final String ENTRY_ELEMENT

See Also:

Constant Field Values

KEY_ELEMENT

public static final String KEY_ELEMENT

See Also:

Constant Field Values

KEY_ATTRIBUTE

public static final String KEY_ATTRIBUTE

See Also:

Constant Field Values

KEY_REF_ATTRIBUTE

public static final String KEY_REF_ATTRIBUTE

See Also:

Constant Field Values

VALUE_REF_ATTRIBUTE

public static final String VALUE_REF_ATTRIBUTE

See Also:

Constant Field Values

PROPS_ELEMENT

public static final String PROPS_ELEMENT

See Also:

Constant Field Values

PROP_ELEMENT

public static final String PROP_ELEMENT

See Also:

Constant Field Values

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

DefaultXmlBeanDefinitionParser

public DefaultXmlBeanDefinitionParser()

Method Detail

registerBeanDefinitions

public int registerBeanDefinitions(BeanDefinitionReader reader,
                                   Document doc,
                                   Resource resource)
                            throws BeanDefinitionStoreException

Parses bean definitions according to the "spring-beans" DTD.

Opens a DOM Document; then initializes the default settings specified at <beans> level; then parses the contained bean definitions.

Specified by:

registerBeanDefinitions in interface XmlBeanDefinitionParser

Parameters:

reader - the bean definition reader, containing the bean factory to work on and the bean class loader to use. Can also be used to load further bean definition files referenced by the given document.

doc - the DOM document

resource - descriptor of the original XML resource (useful for displaying parse errors)

Returns:

the number of bean definitions found

Throws:

BeanDefinitionStoreException - in case of parsing errors

getBeanDefinitionReader

protected final BeanDefinitionReader getBeanDefinitionReader()

Return the BeanDefinitionReader that this parser has been called from.

getResource

protected final Resource getResource()

Return the descriptor for the XML resource that this parser works on.

initDefaults

protected void initDefaults(Element root)

Initialize the default lazy-init, autowire and dependency check settings.

See Also:

setDefaultLazyInit(java.lang.String), setDefaultAutowire(java.lang.String), setDefaultDependencyCheck(java.lang.String)

setDefaultLazyInit

protected final void setDefaultLazyInit(String defaultLazyInit)

Set the default lazy-init flag for the document that's currently parsed.

getDefaultLazyInit

protected final String getDefaultLazyInit()

Return the default lazy-init flag for the document that's currently parsed.

setDefaultAutowire

protected final void setDefaultAutowire(String defaultAutowire)

Set the default autowire setting for the document that's currently parsed.

getDefaultAutowire

protected final String getDefaultAutowire()

Return the default autowire setting for the document that's currently parsed.

setDefaultDependencyCheck

protected final void setDefaultDependencyCheck(String defaultDependencyCheck)

Set the default dependency-check setting for the document that's currently parsed.

getDefaultDependencyCheck

protected final String getDefaultDependencyCheck()

Return the default dependency-check setting for the document that's currently parsed.

setDefaultInitMethod

protected final void setDefaultInitMethod(String defaultInitMethod)

Set the default init-method setting for the document that's currently parsed.

getDefaultInitMethod

protected final String getDefaultInitMethod()

Return the default init-method setting for the document that's currently parsed.

setDefaultDestroyMethod

protected final void setDefaultDestroyMethod(String defaultDestroyMethod)

Set the default destroy-method setting for the document that's currently parsed.

getDefaultDestroyMethod

protected final String getDefaultDestroyMethod()

Return the default destroy-method setting for the document that's currently parsed.

preProcessXml

protected void preProcessXml(Element root)
                      throws BeanDefinitionStoreException

Allow the XML to be extensible by processing any custom element types first, before we start to process the bean definitions. This method is a natural extension point for any other custom pre-processing of the XML.

Default implementation is empty. Subclasses can override this method to convert custom elements into standard Spring bean definitions, for example. Implementors have access to the parser's bean definition reader and the underlying XML resource, through the corresponding accessors.

Throws:

BeanDefinitionStoreException

See Also:

getBeanDefinitionReader(), getResource()

parseBeanDefinitions

protected int parseBeanDefinitions(Element root)
                            throws BeanDefinitionStoreException

Parse the elements at the root level in the document: "import", "alias", "bean".

Parameters:

root - the DOM root element of the document

Returns:

the number of bean definitions found

Throws:

BeanDefinitionStoreException

importBeanDefinitionResource

protected void importBeanDefinitionResource(Element ele)
                                     throws BeanDefinitionStoreException

Parse an "import" element and load the bean definitions from the given resource into the bean factory.

Throws:

BeanDefinitionStoreException

postProcessXml

protected void postProcessXml(Element root)
                       throws BeanDefinitionStoreException

Allow the XML to be extensible by processing any custom element types last, after we finished processing the bean definitions. This method is a natural extension point for any other custom post-processing of the XML.

Default implementation is empty. Subclasses can override this method to convert custom elements into standard Spring bean definitions, for example. Implementors have access to the parser's bean definition reader and the underlying XML resource, through the corresponding accessors.

Throws:

BeanDefinitionStoreException

See Also:

getBeanDefinitionReader(), getResource()

parseBeanDefinitionElement

protected BeanDefinitionHolder parseBeanDefinitionElement(Element ele,
                                                          boolean isInnerBean)
                                                   throws BeanDefinitionStoreException

Parse a standard bean definition into a BeanDefinitionHolder, including bean name and aliases.

Bean elements specify their canonical name as "id" attribute and their aliases as a delimited "name" attribute.

If no "id" specified, uses the first name in the "name" attribute as canonical name, registering all others as aliases.

Callers should specify whether this element represents an inner bean definition or not by setting the isInnerBean argument appropriately

Throws:

BeanDefinitionStoreException

parseBeanDefinitionElement

protected BeanDefinition parseBeanDefinitionElement(Element ele,
                                                    String beanName)
                                             throws BeanDefinitionStoreException

Parse the BeanDefinition itself, without regard to name or aliases.

Throws:

BeanDefinitionStoreException

getDependencyCheck

protected int getDependencyCheck(String att)

getAutowireMode

protected int getAutowireMode(String att)

parseConstructorArgElements

protected ConstructorArgumentValues parseConstructorArgElements(Element beanEle,
                                                                String beanName)
                                                         throws BeanDefinitionStoreException

Parse constructor-arg sub-elements of the given bean element.

Throws:

BeanDefinitionStoreException

parsePropertyElements

protected MutablePropertyValues parsePropertyElements(Element beanEle,
                                                      String beanName)
                                               throws BeanDefinitionStoreException

Parse property sub-elements of the given bean element.

Throws:

BeanDefinitionStoreException

parseLookupOverrideSubElements

protected void parseLookupOverrideSubElements(Element beanEle,
                                              String beanName,
                                              MethodOverrides overrides)
                                       throws BeanDefinitionStoreException

Parse lookup-override sub-elements of the given bean element.

Throws:

BeanDefinitionStoreException

parseReplacedMethodSubElements

protected void parseReplacedMethodSubElements(Element beanEle,
                                              String beanName,
                                              MethodOverrides overrides)
                                       throws BeanDefinitionStoreException

Parse replaced-method sub-elements of the given bean element.

Throws:

BeanDefinitionStoreException

parseConstructorArgElement

protected void parseConstructorArgElement(Element ele,
                                          String beanName,
                                          ConstructorArgumentValues cargs)
                                   throws BeanDefinitionStoreException

Parse a constructor-arg element.

Throws:

BeanDefinitionStoreException

parsePropertyElement

protected void parsePropertyElement(Element ele,
                                    String beanName,
                                    MutablePropertyValues pvs)
                             throws BeanDefinitionStoreException

Parse a property element.

Throws:

BeanDefinitionStoreException

parsePropertyValue

protected Object parsePropertyValue(Element ele,
                                    String beanName,
                                    String propertyName)
                             throws BeanDefinitionStoreException

Get the value of a property element. May be a list etc. Also used for constructor arguments, "propertyName" being null in this case.

Throws:

BeanDefinitionStoreException

parsePropertySubElement

protected Object parsePropertySubElement(Element ele,
                                         String beanName)
                                  throws BeanDefinitionStoreException

Parse a value, ref or collection sub-element of a property or constructor-arg element.

Parameters:

ele - subelement of property element; we don't know which yet

Throws:

BeanDefinitionStoreException

parseListElement

protected List parseListElement(Element collectionEle,
                                String beanName)
                         throws BeanDefinitionStoreException

Parse a list element.

Throws:

BeanDefinitionStoreException

parseSetElement

protected Set parseSetElement(Element collectionEle,
                              String beanName)
                       throws BeanDefinitionStoreException

Parse a set element.

Throws:

BeanDefinitionStoreException

parseMapElement

protected Map parseMapElement(Element mapEle,
                              String beanName)
                       throws BeanDefinitionStoreException

Parse a map element.

Throws:

BeanDefinitionStoreException

parseKeyElement

protected Object parseKeyElement(Element keyEle,
                                 String beanName)
                          throws BeanDefinitionStoreException

Parse a key sub-element of a map element.

Throws:

BeanDefinitionStoreException

parsePropsElement

protected Properties parsePropsElement(Element propsEle,
                                       String beanName)
                                throws BeanDefinitionStoreException

Parse a props element.

Throws:

BeanDefinitionStoreException