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

Class HTTPMetadataProviderParser

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

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

Direct Known Subclasses:

FileBackedHTTPMetadataProviderParser

public class HTTPMetadataProviderParser
extends AbstractReloadingMetadataProviderParser

Parser for a FilesystemMetadataProvider.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	DEFAULT_CACHING Default caching type.
static QName	ELEMENT_NAME Element name.
private org.slf4j.Logger	log Logger.

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
HTTPMetadataProviderParser()

Method Summary

Methods

Modifier and Type	Method and Description
private org.springframework.beans.factory.config.BeanDefinition	buildHttpClient(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, String httpClientSecurityParametersRef, org.springframework.beans.factory.config.BeanDefinition httpClientSecurityParameters) Build the definition of the HTTPClientBuilder which contains all our configuration.
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 HTTPMetadataResolver>	getNativeBeanClass(Element element) Return the real class implement by this type.

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.

DEFAULT_CACHING

@Nonnull
@NotEmpty
private static final String DEFAULT_CACHING

Default caching type.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Logger.

Constructor Detail

HTTPMetadataProviderParser

public HTTPMetadataProviderParser()

Method Detail

getNativeBeanClass

protected Class<? extends HTTPMetadataResolver> 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)

buildHttpClient

private org.springframework.beans.factory.config.BeanDefinition buildHttpClient(Element element,
                                                                      org.springframework.beans.factory.xml.ParserContext parserContext,
                                                                      @Nullable
                                                                      String httpClientSecurityParametersRef,
                                                                      @Nullable
                                                                      org.springframework.beans.factory.config.BeanDefinition httpClientSecurityParameters)

Build the definition of the HTTPClientBuilder which contains all our configuration.

Parameters:

element - the HTTPMetadataProvider parser.

parserContext - context

httpClientSecurityParametersRef - the client security parameters ref to be used

httpClientSecurityParameters - the client security parameters to be used

Returns:

the bean definition with the parameters. Either httpClientSecurityParametersRef or httpClientSecurityParameters can be present, not both.