net.shibboleth.idp.profile.impl

Class ResolveAttributes

java.lang.Object

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

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.profile.impl.ResolveAttributes

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, org.opensaml.profile.action.ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public final class ResolveAttributes
extends AbstractProfileAction

Action that invokes the AttributeResolver for the current request.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.UNABLE_RESOLVE_ATTRIBS

Postcondition:

If resolution is successful, an AttributeContext is created with the results.

Field Summary

Fields

Modifier and Type	Field and Description
private Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext>	attributeContextCreationStrategy Strategy used to locate or create the AttributeContext to populate.
private ReloadableService<AttributeResolver>	attributeResolverService Service used to get the resolver used to fetch attributes.
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>>	attributesLookupStrategy Strategy used to determine the attributes to resolve.
private AuthenticationContext	authenticationContext AuthenticationContext to work from (if any).
private Function<org.opensaml.profile.context.ProfileRequestContext,AuthenticationContext>	authnContextLookupStrategy Strategy used to locate an AuthenticationContext associated with a given ProfileRequestContext.
private boolean	createResolutionContext Whether to create and populate AttributeResolutionContext.
private Function<org.opensaml.profile.context.ProfileRequestContext,String>	issuerLookupStrategy Strategy used to locate the identity of the issuer associated with the attribute resolution.
private org.slf4j.Logger	log Class logger.
private boolean	maskFailures Whether to treat resolver errors as equivalent to resolving no attributes.
private Function<org.opensaml.profile.context.ProfileRequestContext,String>	principalNameLookupStrategy Strategy used to locate the principal name associated with the attribute resolution.
private Function<org.opensaml.profile.context.ProfileRequestContext,String>	recipientLookupStrategy Strategy used to locate the identity of the recipient associated with the attribute resolution.

Constructor Summary

Constructors

Constructor and Description
ResolveAttributes(ReloadableService<AttributeResolver> resolverService) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
private void	populateResolutionContext(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, AttributeResolutionContext resolutionContext) Fill in the resolution context data.
void	setAttributeContextCreationStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> strategy) Set the strategy used to locate or create the AttributeContext to populate.
void	setAttributesLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy) Set a strategy to use to obtain the names of the attributes to resolve.
void	setAttributesToResolve(Collection<String> attributeIds) Set the attribute IDs to pass into the resolver.
void	setAuthenticationContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AuthenticationContext> strategy) Set the strategy used to locate the AuthenticationContext associated with a given ProfileRequestContext.
void	setCreateResolutionContext(boolean flag) Set whether to create the AttributeResolutionContext internally.
void	setIssuerLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy) Set the strategy used to lookup the issuer for this attribute resolution.
void	setMaskFailures(boolean flag) Set whether to treat resolution failure as equivalent to resolving no attributes.
void	setPrincipalNameLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy) Set the strategy used to locate the principal name for this attribute resolution.
void	setRecipientLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy) Set the strategy used to lookup the recipient for this attribute resolution.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

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

destroy, doDestroy, doInitialize, 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.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

attributeResolverService

@Nonnull
private final ReloadableService<AttributeResolver> attributeResolverService

Service used to get the resolver used to fetch attributes.

issuerLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,String> issuerLookupStrategy

Strategy used to locate the identity of the issuer associated with the attribute resolution.

recipientLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,String> recipientLookupStrategy

Strategy used to locate the identity of the recipient associated with the attribute resolution.

principalNameLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,String> principalNameLookupStrategy

Strategy used to locate the principal name associated with the attribute resolution.

authnContextLookupStrategy

@Nullable
private Function<org.opensaml.profile.context.ProfileRequestContext,AuthenticationContext> authnContextLookupStrategy

Strategy used to locate an AuthenticationContext associated with a given ProfileRequestContext.

attributeContextCreationStrategy

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

Strategy used to locate or create the AttributeContext to populate.

attributesLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> attributesLookupStrategy

Strategy used to determine the attributes to resolve.

maskFailures

private boolean maskFailures

Whether to treat resolver errors as equivalent to resolving no attributes.

createResolutionContext

private boolean createResolutionContext

Whether to create and populate AttributeResolutionContext.

authenticationContext

@Nullable
private AuthenticationContext authenticationContext

AuthenticationContext to work from (if any).

Constructor Detail

ResolveAttributes

public ResolveAttributes(@Nonnull
                 ReloadableService<AttributeResolver> resolverService)

Constructor.

Parameters:

resolverService - resolver used to fetch attributes

Method Detail

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nullable
                           Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy)

Set the strategy used to lookup the issuer for this attribute resolution.

Parameters:

strategy - lookup strategy

setRecipientLookupStrategy

public void setRecipientLookupStrategy(@Nullable
                              Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy)

Set the strategy used to lookup the recipient for this attribute resolution.

Parameters:

strategy - lookup strategy

setPrincipalNameLookupStrategy

public void setPrincipalNameLookupStrategy(@Nullable
                                  Function<org.opensaml.profile.context.ProfileRequestContext,String> strategy)

Set the strategy used to locate the principal name for this attribute resolution.

Parameters:

strategy - lookup strategy

setAuthenticationContextLookupStrategy

public void setAuthenticationContextLookupStrategy(@Nullable
                                          Function<org.opensaml.profile.context.ProfileRequestContext,AuthenticationContext> strategy)

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

Parameters:

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

setAttributeContextCreationStrategy

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

Set the strategy used to locate or create the AttributeContext to populate.

Parameters:

strategy - lookup/creation strategy

setAttributesLookupStrategy

public void setAttributesLookupStrategy(@Nonnull
                               Function<org.opensaml.profile.context.ProfileRequestContext,Collection<String>> strategy)

Set a strategy to use to obtain the names of the attributes to resolve.

Parameters:

strategy - lookup strategy

setAttributesToResolve

public void setAttributesToResolve(@Nonnull@NonnullElements
                          Collection<String> attributeIds)

Set the attribute IDs to pass into the resolver.

Parameters:

attributeIds - attribute ID collection

setMaskFailures

public void setMaskFailures(boolean flag)

Set whether to treat resolution failure as equivalent to resolving no attributes.

This matches the behavior of V2.

Parameters:

flag - flag to set

setCreateResolutionContext

public void setCreateResolutionContext(boolean flag)

Set whether to create the AttributeResolutionContext internally.

Defaults to 'true', disable to allow external creation of the context.

Parameters:

flag - flag to set

doPreExecute

protected boolean doPreExecute(@Nonnull
                   org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction

populateResolutionContext

private void populateResolutionContext(@Nonnull
                             org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                             @Nonnull
                             AttributeResolutionContext resolutionContext)

Fill in the resolution context data.

Parameters:

profileRequestContext - current profile request context

resolutionContext - context to populate