Package net.shibboleth.idp.attribute.resolver.spring.dc

Class AbstractDataConnectorParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

net.shibboleth.ext.spring.util.AbstractCustomBeanDefinitionParser

net.shibboleth.idp.attribute.resolver.spring.BaseResolverPluginParser

net.shibboleth.idp.attribute.resolver.spring.dc.AbstractDataConnectorParser

All Implemented Interfaces:

BeanDefinitionParser

Direct Known Subclasses:

HTTPDataConnectorParser, LDAPDataConnectorParser, PairwiseIdDataConnectorParser, RDBMSDataConnectorParser, ScriptDataConnectorParser, StaticDataConnectorParser, StorageServiceDataConnectorParser, SubjectDataConnectorParser

public abstract class AbstractDataConnectorParser
extends BaseResolverPluginParser

Base spring bean definition parser for data connectors. DataConnector implementations should provide a custom BeanDefinitionParser by extending this class and overriding the doParse(Element, ParserContext, BeanDefinitionBuilder) method to parse any additional attributes or elements it requires. Standard attributes and elements defined by the ResolutionPlugIn and DataConnector schemas will automatically attempt to be parsed.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_EXPORT_ALL	Whether to export all attributes.
static final String	ATTR_EXPORT_NAMES	Which attributes to export.
static final String	ATTR_FACTORY_POSTPROCESSORS_REF	A bean name for a List< BeanFactoryPostProcessor>.
static final String	ATTR_FAIL_FAST	Failfast LDAP, Realtional, Stored.
static final String	ATTR_NORETRYDELAY	Delay in retrying failed connector.
static final String	ATTR_POSTPROCESSORS_REF	A bean name for a List< BeanPostProcessor>.
static final String	ATTR_SPRING_RESOURCE	semi colon separated resources to indicate external config.
static final String	ATTR_SPRING_RESOURCE_REF	A bean name for a Collection< Resource>.
static final QName	ELEMENT_NAME	Element name.
static final QName	FAILOVER_DATA_CONNECTOR_ELEMENT_NAME	Failover data connector attribute name.
private final org.slf4j.Logger	log	Log4j logger.

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

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor	Description
AbstractDataConnectorParser()

Method Summary

Modifier and Type	Method	Description
protected void	doParse(Element config, ParserContext parserContext, BeanDefinitionBuilder builder)
protected abstract void	doV2Parse(Element element, ParserContext parserContext, BeanDefinitionBuilder builder)	Parse the supplied Element as a legacy format and populate the supplied BeanDefinitionBuilder as required.
protected final Class<?>	getBeanClass(Element element)
protected String	getLogPrefix()	Return a string which is to be prepended to all log messages.
protected abstract Class<? extends AbstractDataConnector>	getNativeBeanClass()	Per parser indication of what we are building.
protected boolean	isNative(Element config)	Returns whether the element configuration is native spring or custom.

Methods inherited from class net.shibboleth.idp.attribute.resolver.spring.BaseResolverPluginParser

failOnDependencies, getActivationCondition, getDefinitionId, warnOnDependencies

Methods inherited from class net.shibboleth.ext.spring.util.AbstractCustomBeanDefinitionParser

registerBeanDefinition

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, resolveId, shouldFireEvents, shouldGenerateId, shouldGenerateIdAsFallback, shouldParseNameAsAliases

Methods inherited from class java.lang.Object

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

Field Details

ELEMENT_NAME

@Nonnull
public static final QName ELEMENT_NAME

Element name.

ATTR_NORETRYDELAY

@Nonnull
@NotEmpty
public static final String ATTR_NORETRYDELAY

Delay in retrying failed connector.

See Also:

• Constant Field Values

ATTR_SPRING_RESOURCE

@Nonnull
@NotEmpty
public static final String ATTR_SPRING_RESOURCE

semi colon separated resources to indicate external config.

See Also:

• Constant Field Values

ATTR_SPRING_RESOURCE_REF

@Nonnull
@NotEmpty
public static final String ATTR_SPRING_RESOURCE_REF

A bean name for a Collection< Resource>.

See Also:

• Constant Field Values

ATTR_FACTORY_POSTPROCESSORS_REF

@Nonnull
@NotEmpty
public static final String ATTR_FACTORY_POSTPROCESSORS_REF

A bean name for a List< BeanFactoryPostProcessor>.

See Also:

• Constant Field Values

ATTR_POSTPROCESSORS_REF

@Nonnull
@NotEmpty
public static final String ATTR_POSTPROCESSORS_REF

A bean name for a List< BeanPostProcessor>.

See Also:

• Constant Field Values

ATTR_EXPORT_ALL

@Nonnull
@NotEmpty
public static final String ATTR_EXPORT_ALL

Whether to export all attributes.

See Also:

• Constant Field Values

ATTR_EXPORT_NAMES

@Nonnull
@NotEmpty
public static final String ATTR_EXPORT_NAMES

Which attributes to export.

See Also:

• Constant Field Values

ATTR_FAIL_FAST

@Nonnull
@NotEmpty
public static final String ATTR_FAIL_FAST

Failfast LDAP, Realtional, Stored.

See Also:

• Constant Field Values

FAILOVER_DATA_CONNECTOR_ELEMENT_NAME

@Nonnull
public static final QName FAILOVER_DATA_CONNECTOR_ELEMENT_NAME

Failover data connector attribute name.

log

@Nonnull
private final org.slf4j.Logger log

Log4j logger.

Constructor Details

AbstractDataConnectorParser

public AbstractDataConnectorParser()

Method Details

isNative

protected boolean isNative(@Nonnull
 Element config)

Returns whether the element configuration is native spring or custom.

Parameters:

config - the element under consideration.

Returns:

whether this is native spring

getBeanClass

protected final Class<?> getBeanClass(Element element)

Overrides:

getBeanClass in class AbstractSingleBeanDefinitionParser

getNativeBeanClass

protected abstract Class<? extends AbstractDataConnector> getNativeBeanClass()

Per parser indication of what we are building.

Returns:

the class

doParse

protected void doParse(@Nonnull
 Element config,
 @Nonnull
 ParserContext parserContext,
 @Nonnull
 BeanDefinitionBuilder builder)

Overrides:

doParse in class BaseResolverPluginParser

doV2Parse

protected abstract void doV2Parse(Element element,
 ParserContext parserContext,
 BeanDefinitionBuilder builder)

Parse the supplied Element as a legacy format and populate the supplied BeanDefinitionBuilder as required.

Parameters:

element - the XML element being parsed

parserContext - the object encapsulating the current state of the parsing process

builder - used to define the BeanDefinition

See Also:

• AbstractSingleBeanDefinitionParser.doParse(Element, BeanDefinitionBuilder)

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

Return a string which is to be prepended to all log messages.

Overrides:

getLogPrefix in class BaseResolverPluginParser

Returns:

"Data Connector: '<definitionID>' :"