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

Class HTTPMetadataProvidersParserSupport

java.lang.Object

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

public final class HTTPMetadataProvidersParserSupport
extends Object

Helper class for Spring configuration of HTTP metadata providers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASIC_AUTH_PASSWORD BASIC auth password.
static String	BASIC_AUTH_USER BASIC auth username.
private static org.slf4j.Logger	LOG Class logger.
static String	METADATA_URL The URL for the metadata.
static QName	TLS_TRUST_ENGINE_ELEMENT_NAME TLSTrustEngine element name.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	HTTPMetadataProvidersParserSupport() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected static org.springframework.beans.factory.config.BeanDefinition	buildBasicCredentials(Element element, org.springframework.beans.factory.xml.ParserContext parserContext) Build the BeanDefinition for the POJO with the username and password.
protected static org.springframework.beans.factory.support.BeanDefinitionBuilder	buildCommonClientBuilder(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, String defaultCaching, String httpClientSecurityParametersRef, org.springframework.beans.factory.config.BeanDefinition httpClientSecurityParameters) Build a BeanDefinitionBuilder for a HttpClientFactoryBean and populate it from the "standard" attributes which are shared between the Dynamic and Static providers.
protected static org.springframework.beans.factory.config.BeanDefinition	buildTLSSocketFactory(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 static org.springframework.beans.factory.config.BeanDefinition	parseTLSTrustEngine(String tlsTrustEngineRef, Element tlsTrustEngine, org.springframework.beans.factory.xml.ParserContext parserContext) Build the BeanDefinition of the HttpClientSecurityParameters which contains the TLS trust engine provided.

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_AUTH_USER

@Nonnull
@NotEmpty
public static final String BASIC_AUTH_USER

BASIC auth username.

See Also:

Constant Field Values

BASIC_AUTH_PASSWORD

@Nonnull
@NotEmpty
public static final String BASIC_AUTH_PASSWORD

BASIC auth password.

See Also:

Constant Field Values

METADATA_URL

@Nonnull
@NotEmpty
public static final String METADATA_URL

The URL for the metadata.

See Also:

Constant Field Values

TLS_TRUST_ENGINE_ELEMENT_NAME

@Nonnull
public static final QName TLS_TRUST_ENGINE_ELEMENT_NAME

TLSTrustEngine element name.

LOG

@Nonnull
private static final org.slf4j.Logger LOG

Class logger.

Constructor Detail

HTTPMetadataProvidersParserSupport

private HTTPMetadataProvidersParserSupport()

Constructor.

Method Detail

buildTLSSocketFactory

protected static org.springframework.beans.factory.config.BeanDefinition buildTLSSocketFactory(@Nonnull
                                                                            Element element,
                                                                            @Nonnull
                                                                            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 - a reference,

httpClientSecurityParameters - a bean definition

Returns:

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

buildBasicCredentials

@Nonnull
protected static org.springframework.beans.factory.config.BeanDefinition buildBasicCredentials(Element element,
                                                                                    @Nonnull
                                                                                    org.springframework.beans.factory.xml.ParserContext parserContext)

Build the BeanDefinition for the POJO with the username and password.

Parameters:

element - the HTTPMetadataProvider element

parserContext - parser context

Returns:

the bean definition with the username and password.

parseTLSTrustEngine

@Nullable
protected static org.springframework.beans.factory.config.BeanDefinition parseTLSTrustEngine(@Nullable
                                                                                   String tlsTrustEngineRef,
                                                                                   @Nullable
                                                                                   Element tlsTrustEngine,
                                                                                   @Nonnull
                                                                                   org.springframework.beans.factory.xml.ParserContext parserContext)

Build the BeanDefinition of the HttpClientSecurityParameters which contains the TLS trust engine provided.

One of the first two parameters must be non-null.

Parameters:

tlsTrustEngineRef - if present, the reference

tlsTrustEngine - if present, the TLSTrustEngine element

parserContext - context

Returns:

the bean definition

buildCommonClientBuilder

@Nonnull
protected static org.springframework.beans.factory.support.BeanDefinitionBuilder buildCommonClientBuilder(@Nonnull
                                                                                               Element element,
                                                                                               @Nonnull
                                                                                               org.springframework.beans.factory.xml.ParserContext parserContext,
                                                                                               @Nonnull
                                                                                               String defaultCaching,
                                                                                               @Nullable
                                                                                               String httpClientSecurityParametersRef,
                                                                                               @Nullable
                                                                                               org.springframework.beans.factory.config.BeanDefinition httpClientSecurityParameters)

Build a BeanDefinitionBuilder for a HttpClientFactoryBean and populate it from the "standard" attributes which are shared between the Dynamic and Static providers. non standard defaults are applied by the caller.

Parameters:

element - the configuration

parserContext - context

defaultCaching - what to use if caching not supplied.

httpClientSecurityParametersRef - the client security parameters ref to be used

httpClientSecurityParameters - the client security parameters to be used

Returns:

an appropriate builder