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

Class SetRequestedClaimsToResponseContext

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

All Implemented Interfaces:

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

public class SetRequestedClaimsToResponseContext
extends AbstractOIDCResponseAction

Action that sets requested claims to response context. For instance attribute filtering may use this information.

This also executes a reverse mapping of the requested claims to map them back into RequestedIdPAttributes so the filtering mechanism is freed from that role.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,OIDCClaimsRequest>	requestedClaimsLookupStrategy	Strategy used to obtain the requested claims of request.
private ReloadableService<AttributeTranscoderRegistry>	transcoderRegistry	Transcoder registry service object.

Constructor Summary

Constructors

Constructor	Description
SetRequestedClaimsToResponseContext()

Method Summary

Modifier and Type	Method	Description
private void	decodeAttribute(ProfileRequestContext profileRequestContext, Collection<TranscodingRule> rules, JSONObject input, Multimap<String,IdPAttribute> results)	Access the registry of transcoding rules to decode the input object.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doInitialize()
void	setRequestedClaimsLookupStrategy(Function<ProfileRequestContext,OIDCClaimsRequest> strategy)	Set the strategy used to locate the requested claims of request.
void	setTranscoderRegistry(ReloadableService<AttributeTranscoderRegistry> registry)	Sets the registry of transcoding rules to apply to encode attributes.

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

doPreExecute, 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, 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.

requestedClaimsLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,OIDCClaimsRequest> requestedClaimsLookupStrategy

Strategy used to obtain the requested claims of request.

transcoderRegistry

@NonnullAfterInit
private ReloadableService<AttributeTranscoderRegistry> transcoderRegistry

Transcoder registry service object.

Constructor Details

SetRequestedClaimsToResponseContext

public SetRequestedClaimsToResponseContext()

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

setRequestedClaimsLookupStrategy

public void setRequestedClaimsLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCClaimsRequest> strategy)

Set the strategy used to locate the requested claims of request.

Parameters:

strategy - lookup strategy

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

decodeAttribute

private void decodeAttribute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull @NonnullElements
 Collection<TranscodingRule> rules,
 @Nonnull
 JSONObject input,
 @Nonnull @NonnullElements @Live
 Multimap<String,IdPAttribute> results)

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

Parameters:

profileRequestContext - profile request context

rules - transcoding rules

input - input object

results - collection to add results to