edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector

Class RDBMSDataConnectorBeanDefinitionParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPlugInBeanDefinitionParser

edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.BaseDataConnectorBeanDefinitionParser

edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.RDBMSDataConnectorBeanDefinitionParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

public class RDBMSDataConnectorBeanDefinitionParser
extends BaseDataConnectorBeanDefinitionParser

Spring bean definition parser for reading relational database data connector.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
static QName	TYPE_NAME Schema type name.

Fields inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.dataConnector.BaseDataConnectorBeanDefinitionParser

FAILOVER_DATA_CONNECTOR_ELEMENT_NAME

Fields inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPlugInBeanDefinitionParser

DEPENDENCY_ELEMENT_NAME

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

ID_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
RDBMSDataConnectorBeanDefinitionParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected DataSource	buildApplicationManagedConnection(String pluginId, Element amc) Builds a JDBC DataSource from an ApplicationManagedConnection configuration element.
protected DataSource	buildContainerManagedConnection(String pluginId, Element cmc) Builds a JDBC DataSource from a ContainerManagedConnection configuration element.
protected Hashtable<String,String>	buildProperties(List<Element> propertyElements) Builds a hash from PropertyType elements.
protected void	doParse(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Parses the plugin configuration.
protected Class	getBeanClass(Element element)
protected void	processCacheConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Processes the cache configuration options.
protected List<RDBMSColumnDescriptor>	processColumnDescriptors(String pluginId, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder) Processes the Column descriptor configuration elements.
protected void	processConnectionManagement(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Processes the connection management configuration.
protected void	processQueryHandlingConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Processes query handling related configuration options.
protected void	processResultHandlingConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Processes the result handling configuration options.

Methods inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPlugInBeanDefinitionParser

doParse, parseDependencies, resolveId

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

doParse, getBeanClassName, getParentName, parseInternal

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

parse, postProcessComponentDefinition, registerBeanDefinition, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_NAME

public static final QName TYPE_NAME

Schema type name.

log

private final org.slf4j.Logger log

Class logger.

Constructor Detail

RDBMSDataConnectorBeanDefinitionParser

public RDBMSDataConnectorBeanDefinitionParser()

Method Detail

getBeanClass

protected Class getBeanClass(Element element)

Overrides:

getBeanClass in class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse

protected void doParse(String pluginId,
           Element pluginConfig,
           Map<QName,List<Element>> pluginConfigChildren,
           org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder,
           org.springframework.beans.factory.xml.ParserContext parserContext)

Parses the plugin configuration.

Overrides:

doParse in class BaseDataConnectorBeanDefinitionParser

Parameters:

pluginId - unique ID of the plugin

pluginConfig - root plugin configuration element

pluginConfigChildren - immediate children of the root configuration element (provided to save from having to reparse them)

pluginBuilder - bean definition builder for the plugin

parserContext - current parsing context

processConnectionManagement

protected void processConnectionManagement(String pluginId,
                               Element pluginConfig,
                               Map<QName,List<Element>> pluginConfigChildren,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder,
                               org.springframework.beans.factory.xml.ParserContext parserContext)

Processes the connection management configuration.

Parameters:

pluginId - ID of the data connector

pluginConfig - configuration element for the data connector

pluginConfigChildren - child config elements for the data connect

pluginBuilder - builder of the data connector

parserContext - current configuration parsing context

buildContainerManagedConnection

protected DataSource buildContainerManagedConnection(String pluginId,
                                         Element cmc)

Builds a JDBC DataSource from a ContainerManagedConnection configuration element.

Parameters:

pluginId - ID of this data connector

cmc - the container managed configuration element

Returns:

the built data source

buildApplicationManagedConnection

protected DataSource buildApplicationManagedConnection(String pluginId,
                                           Element amc)

Builds a JDBC DataSource from an ApplicationManagedConnection configuration element.

Parameters:

pluginId - ID of this data connector

amc - the application managed configuration element

Returns:

the built data source

processQueryHandlingConfig

protected void processQueryHandlingConfig(String pluginId,
                              Element pluginConfig,
                              Map<QName,List<Element>> pluginConfigChildren,
                              org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder,
                              org.springframework.beans.factory.xml.ParserContext parserContext)

Processes query handling related configuration options.

Parameters:

pluginId - ID of the data connector

pluginConfig - configuration element for the data connector

pluginConfigChildren - child config elements for the data connect

pluginBuilder - builder of the data connector

parserContext - current configuration parsing context

processResultHandlingConfig

protected void processResultHandlingConfig(String pluginId,
                               Element pluginConfig,
                               Map<QName,List<Element>> pluginConfigChildren,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder,
                               org.springframework.beans.factory.xml.ParserContext parserContext)

Processes the result handling configuration options.

Parameters:

pluginId - ID of the data connector

pluginConfig - configuration element for the data connector

pluginConfigChildren - child config elements for the data connect

pluginBuilder - builder of the data connector

parserContext - current configuration parsing context

processCacheConfig

protected void processCacheConfig(String pluginId,
                      Element pluginConfig,
                      Map<QName,List<Element>> pluginConfigChildren,
                      org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder,
                      org.springframework.beans.factory.xml.ParserContext parserContext)

Processes the cache configuration options.

Parameters:

pluginId - ID of the data connector

pluginConfig - configuration element for the data connector

pluginConfigChildren - child config elements for the data connect

pluginBuilder - builder of the data connector

parserContext - current configuration parsing context

processColumnDescriptors

protected List<RDBMSColumnDescriptor> processColumnDescriptors(String pluginId,
                                                   Map<QName,List<Element>> pluginConfigChildren,
                                                   org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder)

Processes the Column descriptor configuration elements.

Parameters:

pluginId - ID of this data connector

pluginConfigChildren - configuration elements

pluginBuilder - the bean definition parser

Returns:

result set column descriptors

buildProperties

protected Hashtable<String,String> buildProperties(List<Element> propertyElements)

Builds a hash from PropertyType elements.

Parameters:

propertyElements - properties elements

Returns:

properties extracted from elements, key is the property name.