net.shibboleth.idp.profile.impl

Class FilterAttributes

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.FilterAttributes

All Implemented Interfaces:

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

public class FilterAttributes
extends AbstractProfileAction

Action that invokes the AttributeFilter for the current request.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.UNABLE_FILTER_ATTRIBS

Postcondition:

If resolution is successful, the relevant RelyingPartyContext.getSubcontext(AttributeContext.class, false) != null

Field Summary

Fields

Modifier and Type	Field and Description
private AttributeContext	attributeContext AttributeContext to filter.
private com.google.common.base.Function<ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy Strategy used to locate the AttributeContext to filter.
private ReloadableService<AttributeFilter>	attributeFilterService Service used to get the engine used to filter attributes.
private AuthenticationContext	authenticationContext AuthenticationContext to work from (if any).
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext>	authnContextLookupStrategy Strategy used to locate the AuthenticationContext associated with a given ProfileRequestContext.
private com.google.common.base.Function<ProfileRequestContext,AttributeFilterContext>	filterContextCreationStrategy Strategy used to locate or create the AttributeFilterContext.
private com.google.common.base.Function<ProfileRequestContext,String>	issuerLookupStrategy Strategy used to locate the identity of the issuer associated with the attribute filtering.
private org.slf4j.Logger	log Class logger.
private boolean	maskFailures Whether to treat resolver errors as equivalent to resolving no attributes.
private com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext>	metadataContextLookupStrategy Strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.
private com.google.common.base.Function<AttributeFilterContext,SAMLMetadataContext>	metadataFromFilterLookupStrategy Strategy used to locate the SAMLMetadataContext associated with a given AttributeFilterContext.
private MetadataResolver	metadataResolver Optional supplemental metadata source.
private com.google.common.base.Function<ProfileRequestContext,String>	principalNameLookupStrategy Strategy used to locate the principal name associated with the attribute filtering.
private com.google.common.base.Function<ProfileRequestContext,ProxiedRequesterContext>	proxiedRequesterContextLookupStrategy Strategy used to locate the ProxiedRequesterContext associated with a given ProfileRequestContext.
private com.google.common.base.Function<AttributeFilterContext,ProxiedRequesterContext>	proxiesFromFilterLookupStrategy Strategy used to locate the ProxiedRequesterContext associated with a given AttributeFilterContext.
private com.google.common.base.Function<ProfileRequestContext,String>	recipientLookupStrategy Strategy used to locate the identity of the recipient associated with the attribute filtering.

Constructor Summary

Constructors

Constructor and Description
FilterAttributes(ReloadableService<AttributeFilter> filterService) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private void	populateFilterContext(ProfileRequestContext profileRequestContext, AttributeFilterContext filterContext) Fill in the filter context data.
void	setAttributeContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,AttributeContext> strategy) Set the strategy used to locate the AttributeContext associated with a given ProfileRequestContext.
void	setAuthenticationContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> strategy) Set the strategy used to locate the AuthenticationContext associated with a given ProfileRequestContext.
void	setFilterContextCreationStrategy(com.google.common.base.Function<ProfileRequestContext,AttributeFilterContext> strategy) Set the strategy used to locate or create the AttributeFilterContext to populate.
void	setIssuerLookupStrategy(com.google.common.base.Function<ProfileRequestContext,String> strategy) Set the strategy used to lookup the issuer for this attribute filtering.
void	setMaskFailures(boolean flag) Set whether to treat resolution failure as equivalent to resolving no attributes.
void	setMetadataContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> strategy) Set the strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.
void	setMetadataResolver(MetadataResolver resolver) Set a metadata source to use during filtering.
void	setPrincipalNameLookupStrategy(com.google.common.base.Function<ProfileRequestContext,String> strategy) Set the strategy used to locate the principal name for this attribute filtering.
void	setProxiedRequesterContextLookupStrategy(com.google.common.base.Function<ProfileRequestContext,ProxiedRequesterContext> strategy) Set the strategy used to locate the ProxiedRequesterContext associated with a given ProfileRequestContext.
void	setRecipientLookupStrategy(com.google.common.base.Function<ProfileRequestContext,String> strategy) Set the strategy used to lookup the recipient for this attribute filtering.

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.

attributeFilterService

@Nonnull
private final ReloadableService<AttributeFilter> attributeFilterService

Service used to get the engine used to filter attributes.

metadataResolver

@Nullable
private MetadataResolver metadataResolver

Optional supplemental metadata source.

issuerLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,String> issuerLookupStrategy

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

recipientLookupStrategy

@Nullable
private com.google.common.base.Function<ProfileRequestContext,String> recipientLookupStrategy

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

filterContextCreationStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,AttributeFilterContext> filterContextCreationStrategy

Strategy used to locate or create the AttributeFilterContext.

attributeContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,AttributeContext> attributeContextLookupStrategy

Strategy used to locate the AttributeContext to filter.

principalNameLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,String> principalNameLookupStrategy

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

authnContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,AuthenticationContext> authnContextLookupStrategy

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

metadataContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> metadataContextLookupStrategy

Strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext.

metadataFromFilterLookupStrategy

@Nonnull
private com.google.common.base.Function<AttributeFilterContext,SAMLMetadataContext> metadataFromFilterLookupStrategy

Strategy used to locate the SAMLMetadataContext associated with a given AttributeFilterContext.

proxiedRequesterContextLookupStrategy

@Nonnull
private com.google.common.base.Function<ProfileRequestContext,ProxiedRequesterContext> proxiedRequesterContextLookupStrategy

Strategy used to locate the ProxiedRequesterContext associated with a given ProfileRequestContext.

proxiesFromFilterLookupStrategy

@Nonnull
private com.google.common.base.Function<AttributeFilterContext,ProxiedRequesterContext> proxiesFromFilterLookupStrategy

Strategy used to locate the ProxiedRequesterContext associated with a given AttributeFilterContext.

maskFailures

private boolean maskFailures

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

authenticationContext

@Nullable
private AuthenticationContext authenticationContext

AuthenticationContext to work from (if any).

attributeContext

@Nullable
private AttributeContext attributeContext

AttributeContext to filter.

Constructor Detail

FilterAttributes

public FilterAttributes(@Nonnull
                ReloadableService<AttributeFilter> filterService)

Constructor.

Parameters:

filterService - engine used to filter attributes

Method Detail

setMetadataResolver

public void setMetadataResolver(@Nullable
                       MetadataResolver resolver)

Set a metadata source to use during filtering.

Parameters:

resolver - metadata resolver

Since:

3.4.0

setIssuerLookupStrategy

public void setIssuerLookupStrategy(@Nullable
                           com.google.common.base.Function<ProfileRequestContext,String> strategy)

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

Parameters:

strategy - lookup strategy

setRecipientLookupStrategy

public void setRecipientLookupStrategy(@Nullable
                              com.google.common.base.Function<ProfileRequestContext,String> strategy)

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

Parameters:

strategy - lookup strategy

setFilterContextCreationStrategy

public void setFilterContextCreationStrategy(@Nonnull
                                    com.google.common.base.Function<ProfileRequestContext,AttributeFilterContext> strategy)

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

Parameters:

strategy - lookup/creation strategy

setAttributeContextLookupStrategy

public void setAttributeContextLookupStrategy(@Nonnull
                                     com.google.common.base.Function<ProfileRequestContext,AttributeContext> strategy)

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

Parameters:

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

setPrincipalNameLookupStrategy

public void setPrincipalNameLookupStrategy(@Nonnull
                                  com.google.common.base.Function<ProfileRequestContext,String> strategy)

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

Parameters:

strategy - lookup strategy

setAuthenticationContextLookupStrategy

public void setAuthenticationContextLookupStrategy(@Nonnull
                                          com.google.common.base.Function<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

setMetadataContextLookupStrategy

public void setMetadataContextLookupStrategy(@Nonnull
                                    com.google.common.base.Function<ProfileRequestContext,SAMLMetadataContext> strategy)

Set the strategy used to locate the SAMLMetadataContext associated with a given ProfileRequestContext. Also sets the strategy to find the SAMLMetadataContext from the AttributeFilterContext.

Parameters:

strategy - lookup strategy

setProxiedRequesterContextLookupStrategy

public void setProxiedRequesterContextLookupStrategy(@Nonnull
                                            com.google.common.base.Function<ProfileRequestContext,ProxiedRequesterContext> strategy)

Set the strategy used to locate the ProxiedRequesterContext associated with a given ProfileRequestContext. Also sets the strategy to find the ProxiedRequesterContext from the AttributeFilterContext.

Parameters:

strategy - lookup strategy

Since:

3.4.0

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

doPreExecute

protected boolean doPreExecute(@Nonnull
                   ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

populateFilterContext

private void populateFilterContext(@Nonnull
                         ProfileRequestContext profileRequestContext,
                         @Nonnull
                         AttributeFilterContext filterContext)

Fill in the filter context data.

Parameters:

profileRequestContext - current profile request context

filterContext - context to populate