Module net.shibboleth.ext.spring

Package 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	Description
private org.slf4j.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	Description
BaseSpringNamespaceHandler()

Method Summary

Modifier and Type	Method	Description
BeanDefinitionHolder	decorate(Node node, BeanDefinitionHolder definition, ParserContext parserContext)	A noop decorator.
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	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 org.slf4j.Logger log

Class logger.

parsers

private Map<QName,BeanDefinitionParser> parsers

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

Constructor Detail

BaseSpringNamespaceHandler

public BaseSpringNamespaceHandler()

Method Detail

decorate

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

A noop decorator. Returns the input.

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 input 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

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