net.shibboleth.ext.spring.util

Class BaseSpringNamespaceHandler

java.lang.Object

net.shibboleth.ext.spring.util.BaseSpringNamespaceHandler

All Implemented Interfaces:

NamespaceHandler

public abstract class BaseSpringNamespaceHandler
extends Object
implements NamespaceHandler

A base class for NamespaceHandler implementations. This code is heavily based on Spring's NamespaceHandlerSupport. The largest difference is that bean definition parsers may be registered against either an elements name or schema type. During parser lookup the schema type is preferred.

Field Summary

Fields

Modifier and Type	Field and Description
private Map<QName,BeanDefinitionDecorator>	attributeDecorators Stores the BeanDefinitionParser implementations keyed by the local name of the Attrs they handle.
private Map<QName,BeanDefinitionDecorator>	decorators Stores the BeanDefinitionDecorator implementations keyed by the local name of the Elements they handle.
private Logger	log Class logger.
private Map<QName,BeanDefinitionParser>	parsers Stores the BeanDefinitionParser implementations keyed by the local name of the Elements they handle.

Constructor Summary

Constructors

Constructor and Description
BaseSpringNamespaceHandler()

Method Summary

Methods

Modifier and Type	Method and Description
BeanDefinitionHolder	decorate(Node node, BeanDefinitionHolder definition, ParserContext parserContext) Decorates the supplied Node by delegating to the BeanDefinitionDecorator that is registered to handle that Node.
protected BeanDefinitionDecorator	findDecoratorForNode(Node node) Locates the BeanDefinitionParser from the register implementations using the local name of the supplied Node.
protected BeanDefinitionParser	findParserForElement(Element element) Locates the BeanDefinitionParser from the register implementations using the local name of the supplied Element.
BeanDefinition	parse(Element element, ParserContext parserContext) Parses the supplied Element by delegating to the BeanDefinitionParser that is registered for that Element.
protected void	registerBeanDefinitionDecorator(QName elementNameOrType, BeanDefinitionDecorator decorator) Subclasses can call this to register the supplied BeanDefinitionDecorator to handle the specified element.
protected void	registerBeanDefinitionDecoratorForAttribute(QName attributeName, BeanDefinitionDecorator decorator) Subclasses can call this to register the supplied BeanDefinitionDecorator to handle the specified attribute.
protected void	registerBeanDefinitionParser(QName elementNameOrType, BeanDefinitionParser parser) Subclasses can call this to register the supplied BeanDefinitionParser to handle the specified element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.beans.factory.xml.NamespaceHandler

init

Field Detail

log

private final Logger log

Class logger.

parsers

private Map<QName,BeanDefinitionParser> parsers

Stores the BeanDefinitionParser implementations keyed by the local name of the Elements they handle.

decorators

private Map<QName,BeanDefinitionDecorator> decorators

Stores the BeanDefinitionDecorator implementations keyed by the local name of the Elements they handle.

attributeDecorators

private Map<QName,BeanDefinitionDecorator> attributeDecorators

Stores the BeanDefinitionParser implementations keyed by the local name of the Attrs they handle.

Constructor Detail

BaseSpringNamespaceHandler

public BaseSpringNamespaceHandler()

Method Detail

decorate

public BeanDefinitionHolder decorate(Node node,
                            BeanDefinitionHolder definition,
                            ParserContext parserContext)

Decorates the supplied Node by delegating to the BeanDefinitionDecorator that is registered to handle that Node.

Specified by:

decorate in interface NamespaceHandler

Parameters:

node - the node decorating a the given bean definition

definition - the bean being decorated

parserContext - the current parser context

Returns:

the decorated bean definition

parse

public BeanDefinition parse(Element element,
                   ParserContext parserContext)

Parses the supplied Element by delegating to the BeanDefinitionParser that is registered for that Element.

Specified by:

parse in interface NamespaceHandler

Parameters:

element - the element to be parsed into a bean definition

parserContext - the context within which the bean definition is created

Returns:

the bean definition created from the given element

findParserForElement

protected BeanDefinitionParser findParserForElement(Element element)

Locates the BeanDefinitionParser from the register implementations using the local name of the supplied Element.

Parameters:

element - the element to locate the bean definition parser for

Returns:

the parser for the given bean element

findDecoratorForNode

protected BeanDefinitionDecorator findDecoratorForNode(Node node)

Locates the BeanDefinitionParser from the register implementations using the local name of the supplied Node. Supports both Elements and Attrs.

Parameters:

node - the node to locate the decorator for

Returns:

the decorator for the given node

registerBeanDefinitionParser

protected void registerBeanDefinitionParser(QName elementNameOrType,
                                BeanDefinitionParser parser)

Subclasses can call this to register the supplied BeanDefinitionParser to handle the specified element. The element name is the local (non-namespace qualified) name.

Parameters:

elementNameOrType - the element name or schema type the parser is for

parser - the parser to register

registerBeanDefinitionDecorator

protected void registerBeanDefinitionDecorator(QName elementNameOrType,
                                   BeanDefinitionDecorator decorator)

Subclasses can call this to register the supplied BeanDefinitionDecorator to handle the specified element. The element name is the local (non-namespace qualified) name.

Parameters:

elementNameOrType - the element name or schema type the parser is for

decorator - the decorator to register

registerBeanDefinitionDecoratorForAttribute

protected void registerBeanDefinitionDecoratorForAttribute(QName attributeName,
                                               BeanDefinitionDecorator decorator)

Subclasses can call this to register the supplied BeanDefinitionDecorator to handle the specified attribute. The attribute name is the local (non-namespace qualified) name.

Parameters:

attributeName - the name of the attribute to register the decorator for

decorator - the decorator to register