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

Class FilterByQueriedAttributes

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, 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	Description
private AttributeContext	attributeContext	AttributeContext to filter.
private Function<ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy	Strategy used to locate the AttributeContext to filter.
private final org.slf4j.Logger	log	Class logger.
private AttributeQuery	query	Query to filter against.
private Function<ProfileRequestContext,AttributeQuery>	queryLookupStrategy	Strategy used to locate the AttributeQuery to filter against.
private ReloadableService<AttributeTranscoderRegistry>	transcoderRegistry	Transcoder registry service object.

Constructor Summary

Constructors

Constructor	Description
FilterByQueriedAttributes()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	decodeAttribute(AttributeTranscoderRegistry registry, ProfileRequestContext profileRequestContext, Attribute input, Multimap<String,IdPAttribute> results)	Access the registry of transcoding rules to decode the input Attribute.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private int	filterRequestedValues(IdPAttribute attribute, Collection<IdPAttribute> requestedAttributes)	Adjust an input attribute's values based on any values requested.
void	setAttributeContextLookupStrategy(Function<ProfileRequestContext,AttributeContext> strategy)	Set the strategy used to locate the AttributeContext associated with a given ProfileRequestContext.
void	setQueryLookupStrategy(Function<ProfileRequestContext,AttributeQuery> strategy)	Set the strategy used to locate the AttributeQuery associated with a given ProfileRequestContext.
void	setTranscoderRegistry(ReloadableService<AttributeTranscoderRegistry> registry)	Sets the registry of transcoding rules to apply to encode attributes.

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

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

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

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

transcoderRegistry

@NonnullAfterInit
private ReloadableService<AttributeTranscoderRegistry> transcoderRegistry

Transcoder registry service object.

queryLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AttributeQuery> queryLookupStrategy

Strategy used to locate the AttributeQuery to filter against.

attributeContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AttributeContext> attributeContextLookupStrategy

Strategy used to locate the AttributeContext to filter.

query

@NonnullBeforeExec
private AttributeQuery query

Query to filter against.

attributeContext

@NonnullBeforeExec
private AttributeContext attributeContext

AttributeContext to filter.

Constructor Details

FilterByQueriedAttributes

public FilterByQueriedAttributes()

Constructor.

Method Details

setTranscoderRegistry

public void setTranscoderRegistry(@Nonnull
 ReloadableService<AttributeTranscoderRegistry> registry)

Sets the registry of transcoding rules to apply to encode attributes.

Parameters:

registry - registry service interface

setQueryLookupStrategy

public void setQueryLookupStrategy(@Nonnull
 Function<ProfileRequestContext,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<ProfileRequestContext,AttributeContext> strategy)

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

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

decodeAttribute

protected void decodeAttribute(@Nonnull
 AttributeTranscoderRegistry registry,
 @Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 Attribute input,
 @Nonnull @Live
 Multimap<String,IdPAttribute> results)
                        throws AttributeDecodingException

Access the registry of transcoding rules to decode the input Attribute.

Parameters:

registry - registry of transcoding rules

profileRequestContext - current profile request context

input - input object

results - collection to add results to

Throws:

AttributeDecodingException - if an error occurs or no results were obtained

filterRequestedValues

private int filterRequestedValues(@Nonnull
 IdPAttribute attribute,
 @Nonnull
 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