net.shibboleth.idp.saml.profile.logic

Class DefaultNameIdentifierFormatStrategy

java.lang.Object

org.opensaml.saml.common.profile.logic.MetadataNameIdentifierFormatStrategy

net.shibboleth.idp.saml.profile.logic.DefaultNameIdentifierFormatStrategy

All Implemented Interfaces:

com.google.common.base.Function<ProfileRequestContext,List<String>>

public class DefaultNameIdentifierFormatStrategy
extends MetadataNameIdentifierFormatStrategy

Function to filter a set of candidate NameIdentifier/NameID Format values derived from an entity's SAML metadata against configuration preferences.

Field Summary

Fields

Modifier and Type	Field and Description
private String	defaultFormat Default format to use if nothing else is known.
private org.slf4j.Logger	log Class logger.
private String	profileId Override the ProfileConfiguration to look for rather than whatever's populated.
private com.google.common.base.Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Constructor Summary

Constructors

Constructor and Description
DefaultNameIdentifierFormatStrategy() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	apply(ProfileRequestContext input)
void	setDefaultFormat(String format) Set the default format to return.
void	setProfileId(String id) Set the profile configuration ID to locate in the RelyingPartyConfiguration for the purposes of establishing format precedence rules.
void	setRelyingPartyContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,RelyingPartyContext> strategy) Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Methods inherited from class org.opensaml.saml.common.profile.logic.MetadataNameIdentifierFormatStrategy

setSSODescriptorLookupStrategy

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

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

relyingPartyContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

profileId

@Nullable
private String profileId

Override the ProfileConfiguration to look for rather than whatever's populated.

defaultFormat

@Nonnull
@NotEmpty
private String defaultFormat

Default format to use if nothing else is known.

Constructor Detail

DefaultNameIdentifierFormatStrategy

public DefaultNameIdentifierFormatStrategy()

Constructor.

Method Detail

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
                                        com.google.common.base.Function<ProfileRequestContext,RelyingPartyContext> strategy)

Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.

Parameters:

strategy - strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext

setProfileId

public void setProfileId(@Nullable
                String id)

Set the profile configuration ID to locate in the RelyingPartyConfiguration for the purposes of establishing format precedence rules.

By default/without one set, the strategy is to use the configuration object populated in the RelyingPartyContext.

Parameters:

id - profile ID to look for

setDefaultFormat

public void setDefaultFormat(@Nonnull@NotEmpty
                    String format)

Set the default format to return.

Parameters:

format - default format

apply

@Nullable
public List<String> apply(@Nullable
                          ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Function<ProfileRequestContext,List<String>>

Overrides:

apply in class MetadataNameIdentifierFormatStrategy