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

Class LdapDataConnectorBeanDefinitionParser

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.LdapDataConnectorBeanDefinitionParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

public class LdapDataConnectorBeanDefinitionParser
extends BaseDataConnectorBeanDefinitionParser

Spring bean definition parser for configuring an LDAP data connector.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Class logger.
static QName	TYPE_NAME LDAP data connector 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
LdapDataConnectorBeanDefinitionParser()

Method Summary

Methods

Modifier and Type	Method and Description
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	processBasicConnectionConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Process the basic LDAP connection configuration for the LDAP data connector.
protected void	processCacheConfig(String pluginId, Element pluginConfig, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder) Processes the cache configuration directives.
protected org.springframework.beans.factory.config.RuntimeBeanReference	processCredential(List<Element> credentials, org.springframework.beans.factory.xml.ParserContext parserContext) Processes a credential element.
protected Map<String,String>	processLDAPProperties(List<Element> propertyElems) Processes the LDAP properties provided in the configuration.
protected void	processPoolingConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Process the pooling configuration for the LDAP data connector.
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) Process the LDAP result handling configuration for the LDAP data connector.
protected void	processSecurityConfig(String pluginId, Element pluginConfig, Map<QName,List<Element>> pluginConfigChildren, org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder, org.springframework.beans.factory.xml.ParserContext parserContext) Process the LDAP connection security configuration for the LDAP data connector.

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

LDAP data connector type name.

log

private final org.slf4j.Logger log

Class logger.

Constructor Detail

LdapDataConnectorBeanDefinitionParser

public LdapDataConnectorBeanDefinitionParser()

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

processBasicConnectionConfig

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

Process the basic LDAP connection configuration for the LDAP data connector.

Parameters:

pluginId - ID of the LDAP plugin

pluginConfig - LDAP plugin configuration element

pluginConfigChildren - child elements of the plugin

pluginBuilder - plugin builder

parserContext - current parsing context

processSecurityConfig

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

Process the LDAP connection security configuration for the LDAP data connector.

Parameters:

pluginId - ID of the LDAP plugin

pluginConfig - LDAP plugin configuration element

pluginConfigChildren - child elements of the plugin

pluginBuilder - plugin builder

parserContext - current 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)

Process the LDAP result handling configuration for the LDAP data connector.

Parameters:

pluginId - ID of the LDAP plugin

pluginConfig - LDAP plugin configuration element

pluginConfigChildren - child elements of the plugin

pluginBuilder - plugin builder

parserContext - current parsing context

processPoolingConfig

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

Process the pooling configuration for the LDAP data connector.

Parameters:

pluginId - ID of the LDAP plugin

pluginConfig - LDAP plugin configuration element

pluginConfigChildren - child elements of the plugin

pluginBuilder - plugin builder

parserContext - current parsing context

processCacheConfig

protected void processCacheConfig(String pluginId,
                      Element pluginConfig,
                      org.springframework.beans.factory.support.BeanDefinitionBuilder pluginBuilder)

Processes the cache configuration directives.

Parameters:

pluginId - ID of the plugin

pluginConfig - configuration element for the plugin

pluginBuilder - builder for the plugin

processLDAPProperties

protected Map<String,String> processLDAPProperties(List<Element> propertyElems)

Processes the LDAP properties provided in the configuration.

Parameters:

propertyElems - LDAP properties provided in the configuration

Returns:

LDAP properties provided in the configuration

processCredential

protected org.springframework.beans.factory.config.RuntimeBeanReference processCredential(List<Element> credentials,
                                                                              org.springframework.beans.factory.xml.ParserContext parserContext)

Processes a credential element.

Parameters:

credentials - list containing the element to process.

parserContext - current parser context

Returns:

the bean definition for the credential