Package net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl

Class AddRequestedClaimsHandler

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler

net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl.AbstractOIDCAuthenticationRequestActionMessageHandler

net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl.AddRequestedClaimsHandler

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, MessageHandler

public class AddRequestedClaimsHandler
extends AbstractOIDCAuthenticationRequestActionMessageHandler

A message handler that adds requested claims to the under constructions authentication request.

The claims are added from a customizable strategy/hook. No additional claims are provided by default.

Also records in the request whether the upstream OP supports the claims parameter, for later inspection by downstream components that only access to the request e.g. an encoder.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.OIDCClaimsRequest>	requestedClaimsHook	A hook that creates requested claims JSON Object from the profile request object.

Constructor Summary

Constructors

Constructor	Description
AddRequestedClaimsHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInvoke(MessageContext messageContext)
void	setRequestedClaimsHook(Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.OIDCClaimsRequest> hook)	Set the hook that generates a requested claims JSON Object from the given profile request object.

Methods inherited from class net.shibboleth.idp.plugin.authn.oidc.rp.messaging.impl.AbstractOIDCAuthenticationRequestActionMessageHandler

adapt, adapt, doPreInvoke, getAuthenticationRequest, getHttpServletRequest, getHttpServletRequestSupplier, getProfileConfiguration, getProviderMetadata, lookupProfileRequestContext, setHttpServletRequestSupplier, setProviderMetadataLookupStrategy, setRelyingPartyContextLookupStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, isPreInvokeCalled, setActivationCondition

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

Class logger.

requestedClaimsHook

@Nonnull
private Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.OIDCClaimsRequest> requestedClaimsHook

A hook that creates requested claims JSON Object from the profile request object.

Constructor Details

AddRequestedClaimsHandler

public AddRequestedClaimsHandler()

Constructor.

Method Details

setRequestedClaimsHook

public void setRequestedClaimsHook(@Nullable
 Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.OIDCClaimsRequest> hook)

Set the hook that generates a requested claims JSON Object from the given profile request object.

Parameters:

hook - the hook

doInvoke

protected void doInvoke(@Nonnull
 MessageContext messageContext)
                 throws MessageHandlerException

Specified by:

doInvoke in class AbstractMessageHandler

Throws:

MessageHandlerException