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

Class BaseSAMLProfileConfigurationParser

java.lang.Object

org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

net.shibboleth.idp.profile.spring.relyingparty.saml.impl.BaseSAMLProfileConfigurationParser

All Implemented Interfaces:

org.springframework.beans.factory.xml.BeanDefinitionParser

Direct Known Subclasses:

BaseSAML2ProfileConfigurationParser, SAML1ArtifactResolutionProfileParser, SAML1AttributeQueryProfileParser, ShibbolethSSOProfileParser

public abstract class BaseSAMLProfileConfigurationParser
extends org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

Parser for all classes which extend AbstractSAMLProfileConfiguration and for elements which inherit from saml:SAMLProfileConfigutationType.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	artifactAware Flag controlling whether to parse artifact configuration.
private org.slf4j.Logger	log Class logger.

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

ID_ATTRIBUTE, NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
BaseSAMLProfileConfigurationParser()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doParse(Element element, org.springframework.beans.factory.xml.ParserContext parserContext, org.springframework.beans.factory.support.BeanDefinitionBuilder builder)
protected org.springframework.beans.factory.config.BeanDefinition	getArtifactConfiguration(Element element) Construct the builder for the artifact configuration.
protected List<String>	getAudiences(Element element) Get the list of audiences from the <Audience> sub-elements.
protected abstract String	getProfileBeanNamePrefix() Get the prefix for the default beans.
private org.springframework.beans.factory.config.BeanDefinition	predicateFor(String value, Class<? extends com.google.common.base.Predicate> claz) Return the definition describing the predicate associated with the provided value, using the default if none specified.
protected org.springframework.beans.factory.config.BeanDefinition	predicateForEncryption(String value) Return the definition of the predicate for encryption derived from the provided string.
protected org.springframework.beans.factory.config.BeanDefinition	predicateForSigning(String value) Return the definition of the predicate for signing derived from the provided string.
protected void	setArtifactAware(boolean flag) Set whether to parse artifact configuration.
private void	setSecurityConfiguration(Element element, org.springframework.beans.factory.support.BeanDefinitionBuilder builder, org.springframework.beans.factory.xml.ParserContext parserContext) Setup the SecurityConfiguration for this profile.
protected boolean	shouldGenerateId()

Methods inherited from class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

doParse, getBeanClass, getBeanClassName, getParentName, parseInternal

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

parse, postProcessComponentDefinition, registerBeanDefinition, resolveId, shouldFireEvents, shouldGenerateIdAsFallback, shouldParseNameAsAliases

Methods inherited from class java.lang.Object

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

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

artifactAware

private boolean artifactAware

Flag controlling whether to parse artifact configuration.

Constructor Detail

BaseSAMLProfileConfigurationParser

public BaseSAMLProfileConfigurationParser()

Method Detail

setArtifactAware

protected void setArtifactAware(boolean flag)

Set whether to parse artifact configuration.

Parameters:

flag - flag to set

getArtifactConfiguration

@Nullable
protected org.springframework.beans.factory.config.BeanDefinition getArtifactConfiguration(Element element)

Construct the builder for the artifact configuration.

Parameters:

element - The element under consideration

Returns:

the builder.

predicateFor

@Nonnull
private org.springframework.beans.factory.config.BeanDefinition predicateFor(@Nullable
                                                                           String value,
                                                                           Class<? extends com.google.common.base.Predicate> claz)

Return the definition describing the predicate associated with the provided value, using the default if none specified.

Parameters:

value - the value as a string should be "always", "conditional", "never"

claz - the predicate type to summon up (one of LegacySigningRequirementPredicate or LegacyEncryptionRequirementPredicate

Returns:

the bean for the appropriate predicate.

predicateForSigning

@Nonnull
protected org.springframework.beans.factory.config.BeanDefinition predicateForSigning(@Nullable
                                                                                  String value)

Return the definition of the predicate for signing derived from the provided string.

Parameters:

value - the value

Returns:

the definition of an appropriate LegacySigningRequirementPredicate

predicateForEncryption

@Nonnull
protected org.springframework.beans.factory.config.BeanDefinition predicateForEncryption(@Nullable
                                                                                     String value)

Return the definition of the predicate for encryption derived from the provided string.

Parameters:

value - the value

Returns:

the definition of an appropriate LegacyEncryptionRequirementPredicate

getAudiences

protected List<String> getAudiences(Element element)

Get the list of audiences from the <Audience> sub-elements.

Parameters:

element - the element under discussion

Returns:

the list of elements (which are subject to property replacement)

setSecurityConfiguration

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

Setup the SecurityConfiguration for this profile. We look first at the embedded beans for a bean of the correct type. Failing that we look for a defaultSigningCredential.

Parameters:

element - the element with the profile in it

builder - the builder for the profile

parserContext - the parser context

doParse

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

Overrides:

doParse in class org.springframework.beans.factory.xml.AbstractSingleBeanDefinitionParser

shouldGenerateId

protected boolean shouldGenerateId()

Overrides:

shouldGenerateId in class org.springframework.beans.factory.xml.AbstractBeanDefinitionParser

getProfileBeanNamePrefix

protected abstract String getProfileBeanNamePrefix()

Get the prefix for the default beans. This prefix will have one of servlet hard-wired default property names appended as a bean name.

Returns:

the prefix