net.shibboleth.idp.profile.spring.relyingparty.metadata.impl

Class ResourceBackedMetadataProviderParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

net.shibboleth.idp.profile.spring.relyingparty.metadata.AbstractMetadataProviderParser

net.shibboleth.idp.profile.spring.relyingparty.metadata.impl.AbstractReloadingMetadataProviderParser

net.shibboleth.idp.profile.spring.relyingparty.metadata.impl.ResourceBackedMetadataProviderParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

public class ResourceBackedMetadataProviderParser
extends AbstractReloadingMetadataProviderParser

Parser for a ResourceBackedMetadataProvider.

This is the most complicated of the parsers. We reach into the resource and find out what sort it is and them summon up an appropriate provider.

Field Summary

Fields

Modifier and Type	Field and Description
static QName	ELEMENT_NAME Element name.
private org.slf4j.Logger	log Log.
static QName	RESOURCE_REF For direct injection of a Spring bean.
static QName	RESOURCES_NAME Element name for the resource elements.

Fields inherited from class net.shibboleth.idp.profile.spring.relyingparty.metadata.AbstractMetadataProviderParser

CHAINING_PROVIDER_ELEMENT_NAME, METADATA_FILTER_ELEMENT_NAME, METADATA_NAMESPACE, RELYING_PARTY_GROUP_ELEMENT_NAME, RP_NAMESPACE, SECURITY_NAMESPACE, TRUST_ENGINE_ELEMENT_NAME

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

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
ResourceBackedMetadataProviderParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doNativeParse(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the element into the provider builder.
protected Class<? extends AbstractBatchMetadataResolver>	getNativeBeanClass(Element element) Return the real class implement by this type.
private void	parseFileBackedHTTPResource(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the provided <Resource> and populate an appropriate FileBackedHTTPMetadataResolver.
private void	parseFilesystemResource(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the provided <Resource> and populate an appropriate FilesystemMetadataResolver.
private void	parseHTTPResource(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the provided <Resource> and populate an appropriate HTTPMetadataResolver.
private void	parseResource(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the provided <Resource> and populate an appropriate ResourceBackedMetadataResolver.
private void	parseResource(String beanReference, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder) Parse the provided Attribute and populate an appropriate ResourceBackedMetadataResolver.

Methods inherited from class net.shibboleth.idp.profile.spring.relyingparty.metadata.impl.AbstractReloadingMetadataProviderParser

getParserPoolRef, getTaskTimerRef

Methods inherited from class net.shibboleth.idp.profile.spring.relyingparty.metadata.AbstractMetadataProviderParser

doParse, getBeanClass

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

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_NAME

@Nonnull
public static final QName ELEMENT_NAME

Element name.

RESOURCES_NAME

@Nonnull
public static final QName RESOURCES_NAME

Element name for the resource elements.

RESOURCE_REF

@Nonnull
public static final QName RESOURCE_REF

For direct injection of a Spring bean.

log

@Nonnull
private final org.slf4j.Logger log

Log.

Constructor Detail

ResourceBackedMetadataProviderParser

public ResourceBackedMetadataProviderParser()

Method Detail

getNativeBeanClass

protected Class<? extends AbstractBatchMetadataResolver> getNativeBeanClass(Element element)

Return the real class implement by this type. This has the same function as the more usual AbstractSingleBeanDefinitionParser.getBeanClass(Element) but it may need to be shimmed in AbstractMetadataProviderParser which may need to insert an extra bean.

Specified by:

getNativeBeanClass in class AbstractMetadataProviderParser

Parameters:

element - the Element that is being parsed

Returns:

the Class of the bean that is being defined via parsing the supplied Element, or null if none

See Also:

AbstractSingleBeanDefinitionParser.getBeanClassName(org.w3c.dom.Element)

doNativeParse

protected void doNativeParse(Element element,
                 org.springframework.beans.factory.xml.ParserContext parserContext,
                 org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the element into the provider builder. This has the same function as the more usual AbstractSingleBeanDefinitionParser.doParse(Element, ParserContext, BeanDefinitionBuilder) but it may need to be shimmed in this class which may need to insert an extra bean. We assume in setting the that we will be summoning up a class which extends AbstractReloadingMetadataResolver.

Overrides:

doNativeParse in class AbstractReloadingMetadataProviderParser

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)

parseResource

private void parseResource(@Nullable
                 String beanReference,
                 org.springframework.beans.factory.xml.ParserContext parserContext,
                 @Nonnull
                 org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the provided Attribute and populate an appropriate ResourceBackedMetadataResolver.

Parameters:

beanReference - the reference

parserContext - the parser context

builder - the builder for the ResourceBackedMetadataResolver.

parseResource

private void parseResource(Element element,
                 org.springframework.beans.factory.xml.ParserContext parserContext,
                 org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the provided <Resource> and populate an appropriate ResourceBackedMetadataResolver.

Parameters:

element - the <Resource> element

parserContext - the parser context

builder - the builder for the ResourceBackedMetadataResolver.

parseHTTPResource

private void parseHTTPResource(Element element,
                     org.springframework.beans.factory.xml.ParserContext parserContext,
                     org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the provided <Resource> and populate an appropriate HTTPMetadataResolver.
See AbstractMetadataProviderParser.doParse(Element, ParserContext, BeanDefinitionBuilder).

Parameters:

element - the <Resource> element

parserContext - the parser context

builder - the builder for the HTTPMetadataResolver.

parseFileBackedHTTPResource

private void parseFileBackedHTTPResource(Element element,
                               org.springframework.beans.factory.xml.ParserContext parserContext,
                               org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the provided <Resource> and populate an appropriate FileBackedHTTPMetadataResolver.
See AbstractMetadataProviderParser.doParse(Element, ParserContext, BeanDefinitionBuilder).

Parameters:

element - the <Resource> element

parserContext - the parser context

builder - the builder for the FileBackedHTTPMetadataResolver.

parseFilesystemResource

private void parseFilesystemResource(Element element,
                           org.springframework.beans.factory.xml.ParserContext parserContext,
                           org.springframework.beans.factory.support.BeanDefinitionBuilder builder)

Parse the provided <Resource> and populate an appropriate FilesystemMetadataResolver.
See AbstractMetadataProviderParser.doParse(Element, ParserContext, BeanDefinitionBuilder).

Parameters:

element - the <Resource> element

parserContext - the parser context

builder - the builder for the FilesystemMetadataResolver.