Package net.shibboleth.idp.attribute.resolver.ad.impl

Class ContextDerivedAttributeDefinition

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.attribute.resolver.AbstractResolverPlugin<IdPAttribute>

net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

net.shibboleth.idp.attribute.resolver.ad.impl.ContextDerivedAttributeDefinition

All Implemented Interfaces:

AttributeDefinition, ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, DisposableBean

public class ContextDerivedAttributeDefinition
extends AbstractAttributeDefinition

An attribute definition which returns an attribute whose values are derived from the ProfileRequestContext associated with the request via a plugged in Function.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,List<IdPAttributeValue>>	attributeValuesFunction	Function used to generate the values associated with the ProfileRequestContext The function returns null or an empty list if the context isn't relevant.
private final org.slf4j.Logger	log	Logger.
private Function<AttributeResolutionContext,ProfileRequestContext>	prcLookupStrategy	Strategy used to locate the ProfileRequestContext to use.

Constructor Summary

Constructors

Constructor	Description
ContextDerivedAttributeDefinition()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected IdPAttribute	doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext)	Creates and populates the values for the resolved attribute.
protected void	doInitialize()
void	setAttributeValuesFunction(Function<ProfileRequestContext,List<IdPAttributeValue>> function)	Sets the attribute value function.
void	setProfileRequestContextLookupStrategy(Function<AttributeResolutionContext,ProfileRequestContext> strategy)	Set the strategy used to locate the ProfileRequestContext associated with a given AttributeResolutionContext.

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

doResolve, getLogPrefix, isDependencyOnly, isPreRequested, setDependencyOnly, setPreRequested

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin

addDisplayInformation, doDestroy, equals, getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, isSuppressDisplayInformation, resolve, setActivationCondition, setAttributeDependencies, setDataConnectorDependencies, setProfileContextStrategy, setPropagateResolutionExceptions, setSuppressDisplayInformation

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, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

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

destroy, isDestroyed

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

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

getId

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

initialize, isInitialized

Methods inherited from interface net.shibboleth.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, isPropagateResolutionExceptions, resolve

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Logger.

prcLookupStrategy

@Nonnull
private Function<AttributeResolutionContext,ProfileRequestContext> prcLookupStrategy

Strategy used to locate the ProfileRequestContext to use.

attributeValuesFunction

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

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

Constructor Details

ContextDerivedAttributeDefinition

public ContextDerivedAttributeDefinition()

Constructor.

Method Details

setProfileRequestContextLookupStrategy

public void setProfileRequestContextLookupStrategy(@Nonnull
 Function<AttributeResolutionContext,ProfileRequestContext> strategy)

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

Parameters:

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

setAttributeValuesFunction

public void setAttributeValuesFunction(@Nonnull
 Function<ProfileRequestContext,List<IdPAttributeValue>> function)

Sets the attribute value function.

Parameters:

function - what to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractAttributeDefinition

Throws:

ComponentInitializationException

doAttributeDefinitionResolve

@Nullable
protected IdPAttribute doAttributeDefinitionResolve(@Nonnull
 AttributeResolutionContext resolutionContext,
 @Nonnull
 AttributeResolverWorkContext workContext)
                                             throws ResolutionException

Description copied from class: AbstractAttributeDefinition

Creates and populates the values for the resolved attribute. Implementations should not set, or otherwise manage, the resolved attribute's display name, description or encoders. Nor should the resultant attribute be recorded in the given resolution context.

Specified by:

doAttributeDefinitionResolve in class AbstractAttributeDefinition

Parameters:

resolutionContext - current attribute resolution context

workContext - current resolver work context

Returns:

resolved attribute or null if nothing to resolve.

Throws:

ResolutionException - thrown if there is a problem resolving and creating the attribute