net.shibboleth.idp.saml.profile.config

Class AbstractMetadataDrivenConfigurationLookupStrategy<T>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.idp.saml.profile.config.AbstractMetadataDrivenConfigurationLookupStrategy<T>

Type Parameters:

T - type of property being returned

All Implemented Interfaces:

com.google.common.base.Function<BaseContext,T>, Component, DestructableComponent, InitializableComponent

Direct Known Subclasses:

AbstractCollectionConfigurationLookupStrategy, BeanConfigurationLookupStrategy, BooleanConfigurationLookupStrategy, DoubleConfigurationLookupStrategy, DurationConfigurationLookupStrategy, IntegerConfigurationLookupStrategy, LongConfigurationLookupStrategy, StringConfigurationLookupStrategy

public abstract class AbstractMetadataDrivenConfigurationLookupStrategy<T>
extends AbstractInitializableComponent
implements com.google.common.base.Function<BaseContext,T>

A strategy function that examines SAML metadata associated with a relying party and derives configuration settings based on EntityAttribute extension tags.

The function is tailored with properties that determine what tag it looks for, with subclasses handling the specific type conversion logic.

If a specific property is unavailable, then null is returned.

Since:

3.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMetadataDrivenConfigurationLookupStrategy.CachedConfigurationContext A child context that caches derived configuration properties.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.google.common.base.Function<MessageContext,EntityDescriptor>	DEFAULT_MC_METADATA_LOOKUP Default metadata lookup for MC-based usage.
private static com.google.common.base.Function<MessageContext,String>	DEFAULT_MC_PROFILE_ID_LOOKUP Default profile ID lookup for MC-based usage.
private static com.google.common.base.Function<ProfileRequestContext,EntityDescriptor>	DEFAULT_PRC_METADATA_LOOKUP Default metadata lookup for PRC-based usage.
private static com.google.common.base.Function<ProfileRequestContext,String>	DEFAULT_PRC_PROFILE_ID_LOOKUP Default profile ID lookup for PRC-based usage.
private boolean	enableCaching Cache the lookup in the context tree.
private org.slf4j.Logger	log Class logger.
private com.google.common.base.Function<BaseContext,EntityDescriptor>	metadataLookupStrategy Strategy for obtaining metadata to check.
private com.google.common.base.Function<BaseContext,String>	profileIdLookupStrategy Strategy for obtaining profile ID for property naming.
private Collection<String>	propertyAliases Alternative "full" property identifiers to support.
private String	propertyName Base name of property to produce.
private boolean	strictNameFormat Require use of URI attribute name format.

Constructor Summary

Constructors

Constructor and Description
AbstractMetadataDrivenConfigurationLookupStrategy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
T	apply(BaseContext input)
protected void	doInitialize()
protected abstract T	doTranslate(Attribute tag) Translate the value(s) into a setting of the appropriate type.
private Attribute	findMatchingTag(EntityAttributes entityAttributes, String name) Find a matching entity attribute in the input metadata.
private Attribute	findMatchingTag(EntityDescriptor entity, String name) Find a matching entity attribute in the input metadata.
void	setEnableCaching(boolean flag) Set whether property lookup should be cached in the profile context tree.
void	setMetadataLookupStrategy(com.google.common.base.Function<BaseContext,EntityDescriptor> strategy) Set lookup strategy for metadata to examine.
void	setProfileAliases(Collection<String> aliases) Set profile ID aliases to include when checking for metadata tags (the property name is suffixed to the aliases).
void	setProfileIdLookupStrategy(com.google.common.base.Function<BaseContext,String> strategy) Set lookup strategy for profile ID to base property names on.
void	setPropertyName(String name) Set the "base" name of the property/setting to derive.
void	setStrictNameFormat(boolean flag) Set whether tag matching should examine and require an Attribute NameFormat of the URI type.
private T	translate(Attribute tag) Translate the value(s) into a setting of the appropriate type.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.base.Function

equals

Field Detail

DEFAULT_PRC_METADATA_LOOKUP

@Nonnull
private static final com.google.common.base.Function<ProfileRequestContext,EntityDescriptor> DEFAULT_PRC_METADATA_LOOKUP

Default metadata lookup for PRC-based usage.

DEFAULT_PRC_PROFILE_ID_LOOKUP

@Nonnull
private static final com.google.common.base.Function<ProfileRequestContext,String> DEFAULT_PRC_PROFILE_ID_LOOKUP

Default profile ID lookup for PRC-based usage.

DEFAULT_MC_METADATA_LOOKUP

@Nonnull
private static final com.google.common.base.Function<MessageContext,EntityDescriptor> DEFAULT_MC_METADATA_LOOKUP

Default metadata lookup for MC-based usage.

DEFAULT_MC_PROFILE_ID_LOOKUP

@Nonnull
private static final com.google.common.base.Function<MessageContext,String> DEFAULT_MC_PROFILE_ID_LOOKUP

Default profile ID lookup for MC-based usage.

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

strictNameFormat

private boolean strictNameFormat

Require use of URI attribute name format.

enableCaching

private boolean enableCaching

Cache the lookup in the context tree.

propertyName

@NonnullAfterInit
@NotEmpty
private String propertyName

Base name of property to produce.

propertyAliases

@NonnullAfterInit
@NonnullElements
private Collection<String> propertyAliases

Alternative "full" property identifiers to support.

metadataLookupStrategy

@Nullable
private com.google.common.base.Function<BaseContext,EntityDescriptor> metadataLookupStrategy

Strategy for obtaining metadata to check.

profileIdLookupStrategy

@Nullable
@NotEmpty
private com.google.common.base.Function<BaseContext,String> profileIdLookupStrategy

Strategy for obtaining profile ID for property naming.

Constructor Detail

AbstractMetadataDrivenConfigurationLookupStrategy

public AbstractMetadataDrivenConfigurationLookupStrategy()

Constructor.

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setStrictNameFormat

public void setStrictNameFormat(boolean flag)

Set whether tag matching should examine and require an Attribute NameFormat of the URI type.

Default is false.

Parameters:

flag - flag to set

setEnableCaching

public void setEnableCaching(boolean flag)

Set whether property lookup should be cached in the profile context tree.

Default is true.

Parameters:

flag - flag to set

setPropertyName

public void setPropertyName(@Nonnull@NotEmpty
                   String name)

Set the "base" name of the property/setting to derive.

Parameters:

name - base property name

setProfileAliases

public void setProfileAliases(@Nonnull@NonnullElements
                     Collection<String> aliases)

Set profile ID aliases to include when checking for metadata tags (the property name is suffixed to the aliases).

This allows alternative tag names to be checked.

Parameters:

aliases - alternative profile IDs

setMetadataLookupStrategy

public void setMetadataLookupStrategy(@Nonnull
                             com.google.common.base.Function<BaseContext,EntityDescriptor> strategy)

Set lookup strategy for metadata to examine.

Parameters:

strategy - lookup strategy

setProfileIdLookupStrategy

public void setProfileIdLookupStrategy(@Nonnull
                              com.google.common.base.Function<BaseContext,String> strategy)

Set lookup strategy for profile ID to base property names on.

Parameters:

strategy - lookup strategy

apply

@Nullable
public T apply(@Nullable
               BaseContext input)

Specified by:

apply in interface com.google.common.base.Function<BaseContext,T>

translate

@Nullable
private T translate(@Nonnull
                   Attribute tag)

Translate the value(s) into a setting of the appropriate type.

Parameters:

tag - tag to translate

Returns:

the setting derived from the tag's value(s)

doTranslate

@Nullable
protected abstract T doTranslate(@Nonnull
                     Attribute tag)

Translate the value(s) into a setting of the appropriate type.

Overrides of this function can assume a non-zero collection of values.

Parameters:

tag - tag to translate

Returns:

the setting derived from the tag's value(s)

findMatchingTag

@Nullable
private Attribute findMatchingTag(@Nonnull
                                 EntityDescriptor entity,
                                 @Nonnull@NotEmpty
                                 String name)

Find a matching entity attribute in the input metadata.

Parameters:

entity - the metadata to examine

name - the tag name to search for

Returns:

matching attribute or null

findMatchingTag

@Nullable
private Attribute findMatchingTag(@Nonnull
                                 EntityAttributes entityAttributes,
                                 @Nonnull@NotEmpty
                                 String name)

Find a matching entity attribute in the input metadata.

Parameters:

entityAttributes - the metadata to examine

name - the tag name to search for

Returns:

matching attribute or null