net.shibboleth.idp.saml.nameid.impl

Class LegacyNameIdentifierGenerator<NameIdType extends org.opensaml.saml.common.SAMLObject>

java.lang.Object

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

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.saml.nameid.impl.LegacyNameIdentifierGenerator<NameIdType>

Type Parameters:

NameIdType - type of identifier object

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, org.opensaml.saml.common.profile.NameIdentifierGenerator<NameIdType>

Direct Known Subclasses:

LegacySAML1NameIdentifierGenerator, LegacySAML2NameIDGenerator

public class LegacyNameIdentifierGenerator<NameIdType extends org.opensaml.saml.common.SAMLObject>
extends AbstractIdentifiableInitializableComponent
implements org.opensaml.saml.common.profile.NameIdentifierGenerator<NameIdType>

Legacy generator of name identifier objects that relies on resolved attributes having NameIdentifierAttributeEncoders attached.

Provided for compatibility with V2 configurations.

While in principle this generator could be configured in the V3 manner by mapping Format(s) to instances of the class, this would require extra configuration to guarantee compatibility, so by design it works by relying on the Format value supplied at generation time to decide which attribute encoders use, in the manner the V2 IdP does.

Field Summary

Fields

Modifier and Type	Field and Description
private Predicate<org.opensaml.profile.context.ProfileRequestContext>	activationCondition A predicate indicating whether the component applies to a request.
private Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy Lookup strategy for AttributeContext.
private Class<? extends NameIdentifierAttributeEncoder>	encoderType Type of encoder to check for when looping.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LegacyNameIdentifierGenerator(Class<? extends NameIdentifierAttributeEncoder> clazz) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
NameIdType	generate(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, String format)
void	setActivationCondition(Predicate<org.opensaml.profile.context.ProfileRequestContext> condition) Set an activation condition that determines whether to run or not.
void	setAttributeContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> strategy) Set the lookup strategy to locate the AttributeContext to pull from.

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

setId

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

doInitialize, getId

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 net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

activationCondition

@Nonnull
private Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition

A predicate indicating whether the component applies to a request.

attributeContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> attributeContextLookupStrategy

Lookup strategy for AttributeContext.

encoderType

@Nonnull
private Class<? extends NameIdentifierAttributeEncoder> encoderType

Type of encoder to check for when looping.

Constructor Detail

LegacyNameIdentifierGenerator

protected LegacyNameIdentifierGenerator(@Nonnull
                             Class<? extends NameIdentifierAttributeEncoder> clazz)

Constructor.

Parameters:

clazz - encoder class type

Method Detail

setActivationCondition

public void setActivationCondition(@Nonnull
                          Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)

Set an activation condition that determines whether to run or not.

Parameters:

condition - an activation condition

setAttributeContextLookupStrategy

public void setAttributeContextLookupStrategy(@Nonnull
                                     Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> strategy)

Set the lookup strategy to locate the AttributeContext to pull from.

Parameters:

strategy - lookup strategy

generate

@Nullable
public NameIdType generate(@Nonnull
                           org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                           @Nonnull@NotEmpty
                           String format)
                                                                throws org.opensaml.saml.common.SAMLException

Specified by:

generate in interface org.opensaml.saml.common.profile.NameIdentifierGenerator<NameIdType extends org.opensaml.saml.common.SAMLObject>

Throws:

org.opensaml.saml.common.SAMLException