Package net.shibboleth.idp.authn.context.impl

Class SubjectDerivedAttributeValuesFunction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.authn.context.impl.SubjectDerivedAttributeValuesFunction

All Implemented Interfaces:

Function<ProfileRequestContext,List<IdPAttributeValue>>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class SubjectDerivedAttributeValuesFunction
extends AbstractIdentifiableInitializableComponent
implements Function<ProfileRequestContext,List<IdPAttributeValue>>

A Function which returns IdPAttributeValues derived from the Principals associated with the request. The precise values are determined by an injected Function.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<Principal,List<IdPAttributeValue>>	attributeValuesFunction	Function used to generate the values associated with a Principal The Function returns null or an empty list if the Principal isn't relevant.
private boolean	forCanonicalization	Flag denoting whether plugin is being used for subject c14n or standard usage.
private final org.slf4j.Logger	log	Logger.
private Function<ProfileRequestContext,SubjectContext>	scLookupStrategy	Strategy used to locate the SubjectContext to use.
private Function<ProfileRequestContext,Subject>	subjectLookupStrategy	Strategy used to locate the Subject to use.

Constructor Summary

Constructors

Constructor	Description
SubjectDerivedAttributeValuesFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
List<IdPAttributeValue>	apply(ProfileRequestContext prc)
protected void	doInitialize()
private String	getLogPrefix()	Produce a consistent log prefix.
void	setAttributeValuesFunction(Function<Principal,List<IdPAttributeValue>> strategy)	Sets the function to extract attribute values from a Principal.
void	setForCanonicalization(boolean flag)	Sets whether the definition is being used during Subject Canonicalization, causing auto-installation of an alternate Subject lookup strategy.
void	setSubjectContextLookupStrategy(Function<ProfileRequestContext,SubjectContext> strategy)	Sets the strategy used to locate the SubjectContext associated with a given AttributeResolutionContext.
void	setSubjectLookupStrategy(Function<ProfileRequestContext,Subject> strategy)	Sets the strategy used to locate a Subject associated with a given AttributeResolutionContext.

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent

ensureId, getId, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, 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 java.util.function.Function

andThen, compose

Methods inherited from interface net.shibboleth.shared.component.IdentifiedComponent

getId

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Logger.

forCanonicalization

private boolean forCanonicalization

Flag denoting whether plugin is being used for subject c14n or standard usage.

scLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SubjectContext> scLookupStrategy

Strategy used to locate the SubjectContext to use.

attributeValuesFunction

@NonnullAfterInit
private Function<Principal,List<IdPAttributeValue>> attributeValuesFunction

Function used to generate the values associated with a Principal The Function returns null or an empty list if the Principal isn't relevant.

subjectLookupStrategy

@Nullable
private Function<ProfileRequestContext,Subject> subjectLookupStrategy

Strategy used to locate the Subject to use.

Constructor Details

SubjectDerivedAttributeValuesFunction

public SubjectDerivedAttributeValuesFunction()

Constructor.

Method Details

setForCanonicalization

public void setForCanonicalization(boolean flag)

Sets whether the definition is being used during Subject Canonicalization, causing auto-installation of an alternate Subject lookup strategy.

Parameters:

flag - flag to set

setSubjectContextLookupStrategy

public void setSubjectContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,SubjectContext> strategy)

Sets the strategy used to locate the SubjectContext associated with a given AttributeResolutionContext.

Parameters:

strategy - strategy used to locate the SubjectContext associated with a given AttributeResolutionContext

setAttributeValuesFunction

public void setAttributeValuesFunction(@Nonnull
 Function<Principal,List<IdPAttributeValue>> strategy)

Sets the function to extract attribute values from a Principal.

Parameters:

strategy - strategy function

setSubjectLookupStrategy

public void setSubjectLookupStrategy(@Nullable
 Function<ProfileRequestContext,Subject> strategy)

Sets the strategy used to locate a Subject associated with a given AttributeResolutionContext.

Parameters:

strategy - strategy used to locate a Subject associated with a given AttributeResolutionContext

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException

apply

@Nullable
@Unmodifiable
@NotLive
public List<IdPAttributeValue> apply(@Nullable
 ProfileRequestContext prc)

Specified by:

apply in interface Function<ProfileRequestContext,List<IdPAttributeValue>>

getLogPrefix

private String getLogPrefix()

Produce a consistent log prefix.

Returns:

a consistent log prefix