org.eclipse.gemini.blueprint.config.internal

Class AbstractReferenceDefinitionParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.eclipse.gemini.blueprint.config.internal.AbstractReferenceDefinitionParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

Direct Known Subclasses:

CollectionBeanDefinitionParser, ReferenceBeanDefinitionParser

public abstract class AbstractReferenceDefinitionParser
extends org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

Base class for parsing reference declarations. Contains common functionality such as adding listeners (and their custom methods), interfaces, cardinality and so on.

Note: This parser also handles the cyclic injection between an importer and its listeners by breaking the chain by creating an adapter instead of the listener. The adapter will then do dependency lookup for the listener.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	AbstractReferenceDefinitionParser.ReferenceAttributesCallback Attribute callback dealing with 'cardinality' attribute.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	AVAILABILITY
private static java.lang.String	AVAILABILITY_PROP
private static java.lang.String	CARDINALITY
private static java.lang.String	CCL_PROP
private static java.lang.String	CONTEXT_CLASSLOADER
static java.lang.String	GENERATED_REF
private static java.lang.String	INTERFACE
private static java.lang.String	INTERFACES
private static java.lang.String	INTERFACES_PROP
private static java.lang.String	LISTENER
private static java.lang.String	LISTENERS_PROP
static java.lang.String	PROMOTED_REF
private static java.lang.String	REF
private static java.lang.String	REFERENCE_LISTENER
private static java.lang.String	SERVICE_BEAN_NAME
private static java.lang.String	SERVICE_BEAN_NAME_PROP
private static java.lang.String	TARGET_BEAN_NAME_PROP
private static java.lang.String	TARGET_PROP

Fields inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
AbstractReferenceDefinitionParser()

Method Summary

Modifier and Type	Method and Description
protected void	applyDefaultCardinality(org.springframework.beans.factory.support.BeanDefinitionBuilder builder, OsgiDefaultsDefinition defaults) Apply default cardinality.
protected void	applyDefaults(org.springframework.beans.factory.xml.ParserContext parserContext, OsgiDefaultsDefinition defaults, org.springframework.beans.factory.support.BeanDefinitionBuilder builder)
private org.springframework.beans.factory.support.AbstractBeanDefinition	createBeanReferenceDefinition(java.lang.String beanName, org.springframework.beans.factory.config.BeanDefinition actualDef)
protected void	doParse(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext context, org.springframework.beans.factory.support.BeanDefinitionBuilder builder)
protected java.lang.String	generateBeanName(java.lang.String prefix, org.springframework.beans.factory.config.BeanDefinition def, org.springframework.beans.factory.xml.ParserContext parserContext)
protected abstract java.lang.Class	getBeanClass(org.w3c.dom.Element element) Indicate the bean definition class for this element.
protected java.lang.String	getListenerElementName()
protected void	handleNestedDefinition(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext context, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) If the reference is a nested bean, make it a top-level bean if it's a mandatory dependency.
private boolean	isCardinalitySpecified(org.springframework.beans.factory.support.BeanDefinitionBuilder builder)
protected void	parseAttributes(org.w3c.dom.Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder builder, AttributeCallback[] callbacks, OsgiDefaultsDefinition defaults) Allow subclasses to add their own callbacks.
protected void	parseInterfaces(org.w3c.dom.Element parent, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse interfaces.
protected org.springframework.beans.factory.support.AbstractBeanDefinition	parseInternal(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext parserContext)
protected void	parseListeners(org.w3c.dom.Element element, java.lang.String subElementName, org.springframework.beans.factory.xml.ParserContext context, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse listeners.
protected void	parseNestedElements(org.w3c.dom.Element element, org.springframework.beans.factory.xml.ParserContext context, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse nested elements.
protected java.util.Set	parsePropertySetElement(org.springframework.beans.factory.xml.ParserContext context, org.w3c.dom.Element beanDef, org.springframework.beans.factory.config.BeanDefinition beanDefinition)
protected java.lang.Object	parsePropertySubElement(org.springframework.beans.factory.xml.ParserContext context, org.w3c.dom.Element beanDef, org.springframework.beans.factory.config.BeanDefinition beanDefinition)
protected void	postProcessListenerDefinition(org.springframework.beans.factory.config.BeanDefinition wrapperDef)
protected OsgiDefaultsDefinition	resolveDefaults(org.w3c.dom.Document document, org.springframework.beans.factory.xml.ParserContext parserContext) Get OSGi defaults (in case they haven't been resolved).

Methods inherited from class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

parse, postProcessComponentDefinition, registerBeanDefinition, resolveId, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback

Methods inherited from class java.lang.Object

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

Field Detail

LISTENERS_PROP

private static final java.lang.String LISTENERS_PROP

See Also:

Constant Field Values

AVAILABILITY_PROP

private static final java.lang.String AVAILABILITY_PROP

See Also:

Constant Field Values

SERVICE_BEAN_NAME_PROP

private static final java.lang.String SERVICE_BEAN_NAME_PROP

See Also:

Constant Field Values

INTERFACES_PROP

private static final java.lang.String INTERFACES_PROP

See Also:

Constant Field Values

CCL_PROP

private static final java.lang.String CCL_PROP

See Also:

Constant Field Values

TARGET_BEAN_NAME_PROP

private static final java.lang.String TARGET_BEAN_NAME_PROP

See Also:

Constant Field Values

TARGET_PROP

private static final java.lang.String TARGET_PROP

See Also:

Constant Field Values

LISTENER

private static final java.lang.String LISTENER

See Also:

Constant Field Values

REFERENCE_LISTENER

private static final java.lang.String REFERENCE_LISTENER

See Also:

Constant Field Values

REF

private static final java.lang.String REF

See Also:

Constant Field Values

INTERFACE

private static final java.lang.String INTERFACE

See Also:

Constant Field Values

INTERFACES

private static final java.lang.String INTERFACES

See Also:

Constant Field Values

AVAILABILITY

private static final java.lang.String AVAILABILITY

See Also:

Constant Field Values

CARDINALITY

private static final java.lang.String CARDINALITY

See Also:

Constant Field Values

SERVICE_BEAN_NAME

private static final java.lang.String SERVICE_BEAN_NAME

See Also:

Constant Field Values

CONTEXT_CLASSLOADER

private static final java.lang.String CONTEXT_CLASSLOADER

See Also:

Constant Field Values

GENERATED_REF

public static final java.lang.String GENERATED_REF

See Also:

Constant Field Values

PROMOTED_REF

public static final java.lang.String PROMOTED_REF

See Also:

Constant Field Values

Constructor Detail

AbstractReferenceDefinitionParser

public AbstractReferenceDefinitionParser()

Method Detail

resolveDefaults

protected OsgiDefaultsDefinition resolveDefaults(org.w3c.dom.Document document,
                                                 org.springframework.beans.factory.xml.ParserContext parserContext)

Get OSGi defaults (in case they haven't been resolved).

Parameters:

document -

Returns:

parseInternal

protected org.springframework.beans.factory.support.AbstractBeanDefinition parseInternal(org.w3c.dom.Element element,
                                                                                         org.springframework.beans.factory.xml.ParserContext parserContext)

Specified by:

parseInternal in class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

applyDefaults

protected void applyDefaults(org.springframework.beans.factory.xml.ParserContext parserContext,
                             OsgiDefaultsDefinition defaults,
                             org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

createBeanReferenceDefinition

private org.springframework.beans.factory.support.AbstractBeanDefinition createBeanReferenceDefinition(java.lang.String beanName,
                                                                                                       org.springframework.beans.factory.config.BeanDefinition actualDef)

doParse

protected void doParse(org.w3c.dom.Element element,
                       org.springframework.beans.factory.xml.ParserContext context,
                       org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

isCardinalitySpecified

private boolean isCardinalitySpecified(org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

handleNestedDefinition

protected void handleNestedDefinition(org.w3c.dom.Element element,
                                      org.springframework.beans.factory.xml.ParserContext context,
                                      org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

If the reference is a nested bean, make it a top-level bean if it's a mandatory dependency. This is done so that the beans can be discovered at startup and the appCtx can start waiting.

Parameters:

element -

context -

builder -

parseAttributes

protected void parseAttributes(org.w3c.dom.Element element,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder builder,
                               AttributeCallback[] callbacks,
                               OsgiDefaultsDefinition defaults)

Allow subclasses to add their own callbacks.

Parameters:

element -

builder -

callbacks -

getBeanClass

protected abstract java.lang.Class getBeanClass(org.w3c.dom.Element element)

Indicate the bean definition class for this element.

Parameters:

element -

Returns:

applyDefaultCardinality

protected void applyDefaultCardinality(org.springframework.beans.factory.support.BeanDefinitionBuilder builder,
                                       OsgiDefaultsDefinition defaults)

Apply default cardinality.

Parameters:

builder -

defaults -

parseNestedElements

protected void parseNestedElements(org.w3c.dom.Element element,
                                   org.springframework.beans.factory.xml.ParserContext context,
                                   org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse nested elements. In case of a reference definition, this means using the listeners.

Parameters:

element -

context -

builder -

getListenerElementName

protected java.lang.String getListenerElementName()

parseInterfaces

protected void parseInterfaces(org.w3c.dom.Element parent,
                               org.springframework.beans.factory.xml.ParserContext parserContext,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse interfaces.

Parameters:

element -

context -

builder -

parseListeners

protected void parseListeners(org.w3c.dom.Element element,
                              java.lang.String subElementName,
                              org.springframework.beans.factory.xml.ParserContext context,
                              org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse listeners.

Parameters:

element -

context -

builder -

postProcessListenerDefinition

protected void postProcessListenerDefinition(org.springframework.beans.factory.config.BeanDefinition wrapperDef)

parsePropertySubElement

protected java.lang.Object parsePropertySubElement(org.springframework.beans.factory.xml.ParserContext context,
                                                   org.w3c.dom.Element beanDef,
                                                   org.springframework.beans.factory.config.BeanDefinition beanDefinition)

parsePropertySetElement

protected java.util.Set parsePropertySetElement(org.springframework.beans.factory.xml.ParserContext context,
                                                org.w3c.dom.Element beanDef,
                                                org.springframework.beans.factory.config.BeanDefinition beanDefinition)

generateBeanName

protected java.lang.String generateBeanName(java.lang.String prefix,
                                            org.springframework.beans.factory.config.BeanDefinition def,
                                            org.springframework.beans.factory.xml.ParserContext parserContext)