net.shibboleth.idp.saml.saml2.profile.impl

Class FilterByQueriedAttributes

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.saml.saml2.profile.impl.FilterByQueriedAttributes

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 class FilterByQueriedAttributes
extends AbstractProfileAction

Action that filters a set of attributes against the Attribute objects in an AttributeQuery.

Event:

EventIds.PROCEED_EVENT_ID

Field Summary

Fields

Modifier and Type	Field and Description
private AttributeContext	attributeContext AttributeContext to filter.
private Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy Strategy used to locate the AttributeContext to filter.
private org.slf4j.Logger	log Class logger.
private SAML2AttributesMapperService	mapperService Service used to get the engine used to filter attributes.
private org.opensaml.saml.saml2.core.AttributeQuery	query Query to filter against.
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.saml2.core.AttributeQuery>	queryLookupStrategy Strategy used to locate the AttributeQuery to filter against.

Constructor Summary

Constructors

Constructor and Description
FilterByQueriedAttributes(SAML2AttributesMapperService mapper) 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 int	filterRequestedValues(IdPAttribute attribute, Collection<IdPAttribute> requestedAttributes) Adjust an input attribute's values based on any values requested.
void	setAttributeContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,AttributeContext> strategy) Set the strategy used to locate the AttributeContext associated with a given ProfileRequestContext.
void	setQueryLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.saml2.core.AttributeQuery> strategy) Set the strategy used to locate the AttributeQuery associated with a given ProfileRequestContext.

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.

mapperService

@Nonnull
private final SAML2AttributesMapperService mapperService

Service used to get the engine used to filter attributes.

queryLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.saml2.core.AttributeQuery> queryLookupStrategy

Strategy used to locate the AttributeQuery to filter against.

attributeContextLookupStrategy

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

Strategy used to locate the AttributeContext to filter.

query

@Nullable
private org.opensaml.saml.saml2.core.AttributeQuery query

Query to filter against.

attributeContext

@Nullable
private AttributeContext attributeContext

AttributeContext to filter.

Constructor Detail

FilterByQueriedAttributes

public FilterByQueriedAttributes(@Nonnull
                         SAML2AttributesMapperService mapper)

Constructor.

Parameters:

mapper - mapper used to consume designators

Method Detail

setQueryLookupStrategy

public void setQueryLookupStrategy(@Nonnull
                          Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.saml2.core.AttributeQuery> strategy)

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

Parameters:

strategy - lookup strategy

setAttributeContextLookupStrategy

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

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

Parameters:

strategy - lookup strategy

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

filterRequestedValues

private int filterRequestedValues(@Nonnull
                        IdPAttribute attribute,
                        @Nonnull@NonnullElements
                        Collection<IdPAttribute> requestedAttributes)

Adjust an input attribute's values based on any values requested.

Parameters:

attribute - attribute to filter

requestedAttributes - the attributes (and possibly values) requested

Returns:

the number of values left in the input attribute