net.shibboleth.idp.saml.nameid.impl

Class PersistentSAML2NameIDGenerator

java.lang.Object

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

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

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

org.opensaml.saml.common.profile.AbstractNameIdentifierGenerator<org.opensaml.saml.saml2.core.NameID>

org.opensaml.saml.saml2.profile.AbstractSAML2NameIDGenerator

net.shibboleth.idp.saml.nameid.impl.PersistentSAML2NameIDGenerator

All Implemented Interfaces:

Predicate<org.opensaml.profile.context.ProfileRequestContext>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, org.opensaml.saml.common.profile.FormatSpecificNameIdentifierGenerator<org.opensaml.saml.saml2.core.NameID>, org.opensaml.saml.common.profile.NameIdentifierGenerator<org.opensaml.saml.saml2.core.NameID>, org.opensaml.saml.saml2.profile.SAML2NameIDGenerator

@ThreadSafeAfterInit
public class PersistentSAML2NameIDGenerator
extends org.opensaml.saml.saml2.profile.AbstractSAML2NameIDGenerator

Generator for "persistent" Format NameID objects that provides a source/seed ID based on IdPAttribute data.

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy Strategy function to lookup AttributeContext.
private List<String>	attributeSourceIds Attribute(s) to use as an identifier source.
private org.slf4j.Logger	log Class logger.
private PersistentIdGenerationStrategy	persistentIdStrategy Generation strategy for IDs.
private Function<org.opensaml.profile.context.ProfileRequestContext,SubjectContext>	subjectContextLookupStrategy Strategy function to lookup SubjectContext.
private boolean	useUnfilteredAttributes Predicate to select whether to look at filtered or unfiltered attributes.

Constructor Summary

Constructors

Constructor and Description
PersistentSAML2NameIDGenerator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected String	getIdentifier(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setAttributeContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> strategy) Set the lookup strategy to use to locate the AttributeContext.
void	setAttributeSourceIds(List<String> ids) Set the attribute sources to pull from.
void	setPersistentIdGenerator(PersistentIdGenerationStrategy strategy) Set the generation strategy for the persistent ID.
void	setSubjectContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,SubjectContext> strategy) Set the lookup strategy to use to locate the SubjectContext.
void	setUseUnfilteredAttributes(boolean flag) Set whether to source the input attributes from the unfiltered set.

Methods inherited from class org.opensaml.saml.saml2.profile.AbstractSAML2NameIDGenerator

doGenerate, getEffectiveSPNameQualifier, setRequestLookupStrategy

Methods inherited from class org.opensaml.saml.common.profile.AbstractNameIdentifierGenerator

apply, getDefaultIdPNameQualifierLookupStrategy, getDefaultSPNameQualifierLookupStrategy, getEffectiveIdPNameQualifier, getFormat, getIdPNameQualifier, getSPNameQualifier, getSPProvidedID, isOmitQualifiers, setActivationCondition, setDefaultIdPNameQualifierLookupStrategy, setDefaultSPNameQualifierLookupStrategy, setFormat, setIdPNameQualifier, setOmitQualifiers, setSPNameQualifier, setSPProvidedId

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

setId

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

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 com.google.common.base.Predicate

equals

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

subjectContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,SubjectContext> subjectContextLookupStrategy

Strategy function to lookup SubjectContext.

attributeContextLookupStrategy

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

Strategy function to lookup AttributeContext.

attributeSourceIds

@Nonnull
@NonnullElements
private List<String> attributeSourceIds

Attribute(s) to use as an identifier source.

persistentIdStrategy

@NonnullAfterInit
private PersistentIdGenerationStrategy persistentIdStrategy

Generation strategy for IDs.

useUnfilteredAttributes

private boolean useUnfilteredAttributes

Predicate to select whether to look at filtered or unfiltered attributes.

Constructor Detail

PersistentSAML2NameIDGenerator

public PersistentSAML2NameIDGenerator()

Constructor.

Method Detail

setSubjectContextLookupStrategy

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

Set the lookup strategy to use to locate the SubjectContext.

Parameters:

strategy - lookup function to use

setAttributeContextLookupStrategy

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

Set the lookup strategy to use to locate the AttributeContext.

Parameters:

strategy - lookup function to use

setAttributeSourceIds

public void setAttributeSourceIds(@Nonnull@NonnullElements
                         List<String> ids)

Set the attribute sources to pull from.

Parameters:

ids - attribute IDs to pull from

setPersistentIdGenerator

public void setPersistentIdGenerator(@Nonnull
                            PersistentIdGenerationStrategy strategy)

Set the generation strategy for the persistent ID.

Parameters:

strategy - generation strategy

setUseUnfilteredAttributes

public void setUseUnfilteredAttributes(boolean flag)

Set whether to source the input attributes from the unfiltered set.

Defaults to true, since the input is not directly exposed.

Parameters:

flag - flag to set

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class org.opensaml.saml.common.profile.AbstractNameIdentifierGenerator<org.opensaml.saml.saml2.core.NameID>

Throws:

ComponentInitializationException

getIdentifier

@Nullable
protected String getIdentifier(@Nonnull
                            org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
                        throws org.opensaml.saml.common.SAMLException

Overrides:

getIdentifier in class org.opensaml.saml.common.profile.AbstractNameIdentifierGenerator<org.opensaml.saml.saml2.core.NameID>

Throws:

org.opensaml.saml.common.SAMLException