Package net.shibboleth.idp.consent.flow.ar.impl

Class PopulateAttributeReleaseContext

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.profile.interceptor.AbstractProfileInterceptorAction

net.shibboleth.idp.consent.flow.impl.AbstractConsentAction

net.shibboleth.idp.consent.flow.ar.impl.AbstractAttributeReleaseAction

net.shibboleth.idp.consent.flow.ar.impl.PopulateAttributeReleaseContext

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class PopulateAttributeReleaseContext
extends AbstractAttributeReleaseAction

Attribute consent action to populate the attribute consent context with the attributes for which consent should be obtained. A predicate is used to determine whether consent should be obtained for each IdP attribute in the attribute context.

Event:

EventIds.PROCEED_EVENT_ID

Postcondition:

See above.

Field Summary

Fields

Modifier and Type	Field	Description
private Comparator<String>	attributeIdComparator	Comparator used to sort attributes displayed to user.
private Predicate<IdPAttribute>	attributePredicate	Predicate to determine whether consent should be obtained for an attribute.
private final org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
PopulateAttributeReleaseContext()

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, ProfileInterceptorContext interceptorContext)	Performs this profile interceptor action.
protected void	doInitialize()
void	setAttributeIdComparator(Comparator<String> comparator)	Set the comparator used to sort attributes displayed to user.
void	setAttributePredicate(Predicate<IdPAttribute> predicate)	Set the predicate to determine whether consent should be obtained for an attribute.

Methods inherited from class net.shibboleth.idp.consent.flow.ar.impl.AbstractAttributeReleaseAction

doPreExecute, getAttributeContext, getAttributeReleaseContext, getAttributeReleaseFlowDescriptor, setAttributeContextLookupStrategy, setAttributeReleaseContextLookupStrategy

Methods inherited from class net.shibboleth.idp.consent.flow.impl.AbstractConsentAction

getConsentContext, getConsentFlowDescriptor, setConsentContextLookupStrategy

Methods inherited from class net.shibboleth.idp.profile.interceptor.AbstractProfileInterceptorAction

doExecute, doPreExecute, setLookupStrategy

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.

attributePredicate

@NonnullAfterInit
private Predicate<IdPAttribute> attributePredicate

Predicate to determine whether consent should be obtained for an attribute.

attributeIdComparator

@Nullable
private Comparator<String> attributeIdComparator

Comparator used to sort attributes displayed to user.

Constructor Details

PopulateAttributeReleaseContext

public PopulateAttributeReleaseContext()

Method Details

setAttributePredicate

public void setAttributePredicate(@Nonnull
 Predicate<IdPAttribute> predicate)

Set the predicate to determine whether consent should be obtained for an attribute.

Parameters:

predicate - predicate to determine whether consent should be obtained for an attribute

setAttributeIdComparator

public void setAttributeIdComparator(@Nullable
 Comparator<String> comparator)

Set the comparator used to sort attributes displayed to user.

Parameters:

comparator - comparator used to sort attributes displayed to user

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 ProfileInterceptorContext interceptorContext)

Performs this profile interceptor action. Default implementation does nothing.

Overrides:

doExecute in class AbstractProfileInterceptorAction

Parameters:

profileRequestContext - the current profile request context

interceptorContext - the current profile interceptor context