Package net.shibboleth.idp.plugin.oidc.op.profile.impl

Class SetConsentToResponseContext

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.plugin.oidc.op.profile.impl.AbstractOIDCResponseAction

net.shibboleth.idp.plugin.oidc.op.profile.impl.SetConsentToResponseContext

All Implemented Interfaces:

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

public class SetConsentToResponseContext
extends AbstractOIDCResponseAction

Action that checks for adds the currently existing attributes from AttributeContext for token delivery. They are assumed to be consented, if they exist in the context. The (consent) information is stored to OIDCAuthenticationResponseTokenClaimsContext that is created under OIDCAuthenticationResponseContext.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,AttributeContext>	attributeContextLookupStrategy	Strategy used to locate the AttributeContext associated with a given ProfileRequestContext.
private AttributeContext	attributeCtx	AttributeContext to use.
private Predicate<ProfileRequestContext>	consentEnabledPredicate	Predicate used to check if consent is enabled.
private Predicate<ProfileRequestContext>	encodeConsentPredicate	Predicate used to check if consent should be embedded in tokens.
private org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
SetConsentToResponseContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setAttributeContextLookupStrategy(Function<ProfileRequestContext,AttributeContext> strategy)	Set the strategy used to locate the AttributeContext associated with a given ProfileRequestContext.
void	setConsentEnabledPredicate(Predicate<ProfileRequestContext> predicate)	Set the predicate used to check if consent is enable.
void	setEncodeConsentPredicate(Predicate<ProfileRequestContext> predicate)	Set the predicate used to check if consent should be encoded.

Methods inherited from class net.shibboleth.idp.plugin.oidc.op.profile.impl.AbstractOIDCResponseAction

getMetadataContext, getOidcResponseContext

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, doInitialize, 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 org.slf4j.Logger log

Class logger.

attributeContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AttributeContext> attributeContextLookupStrategy

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

consentEnabledPredicate

@Nonnull
private Predicate<ProfileRequestContext> consentEnabledPredicate

Predicate used to check if consent is enabled.

encodeConsentPredicate

@Nonnull
private Predicate<ProfileRequestContext> encodeConsentPredicate

Predicate used to check if consent should be embedded in tokens.

attributeCtx

@Nullable
private AttributeContext attributeCtx

AttributeContext to use.

Constructor Details

SetConsentToResponseContext

public SetConsentToResponseContext()

Constructor.

Method Details

setAttributeContextLookupStrategy

public void setAttributeContextLookupStrategy(@Nonnull
 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

setConsentEnabledPredicate

public void setConsentEnabledPredicate(@Nonnull
 Predicate<ProfileRequestContext> predicate)

Set the predicate used to check if consent is enable.

Parameters:

predicate - predicate used to check if consent is enabled

setEncodeConsentPredicate

public void setEncodeConsentPredicate(@Nonnull
 Predicate<ProfileRequestContext> predicate)

Set the predicate used to check if consent should be encoded.

Parameters:

predicate - predicate used to check if consent should be encoded

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOIDCResponseAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction