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

Class AddTokenDeliveryAttributesToClaimsSet

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

All Implemented Interfaces:

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

public class AddTokenDeliveryAttributesToClaimsSet
extends AbstractOIDCResponseAction

Action that adds claims to a ClaimsSet. Claims are added from OIDCAuthenticationResponseTokenClaimsContext. The main use cases are adding token delivery attributes to id token in token endpoint response or to user info response.

Field Summary

Fields

Modifier and Type	Field	Description
private com.nimbusds.openid.connect.sdk.claims.ClaimsSet	claimsSet	Claims Set to use.
private org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.claims.ClaimsSet>	responseClaimsSetLookupStrategy	Strategy used to locate the response ClaimsSet associated with a given ProfileRequestContext.
private boolean	targetIDToken	Whether we are adding claims to ID Token.
private Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext>	tokenClaimsContextLookupStrategy	Strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext.
private OIDCAuthenticationResponseTokenClaimsContext	tokenClaimsCtx	delivery claims to copy to claims set.

Constructor Summary

Constructors

Constructor	Description
AddTokenDeliveryAttributesToClaimsSet()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy(Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> strategy)	Set the strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext associated with a given ProfileRequestContext.
void	setResponseClaimsSetLookupStrategy(Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.claims.ClaimsSet> strategy)	Set the strategy used to locate the response ClaimsSet associated with a given ProfileRequestContext.
void	setTargetIDToken(boolean flag)	Set whether target is id token claims set.

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.

responseClaimsSetLookupStrategy

@Nonnull
private Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.claims.ClaimsSet> responseClaimsSetLookupStrategy

Strategy used to locate the response ClaimsSet associated with a given ProfileRequestContext.

tokenClaimsContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> tokenClaimsContextLookupStrategy

Strategy used to locate the OIDCAuthenticationResponseTokenClaimsContext.

claimsSet

@Nullable
private com.nimbusds.openid.connect.sdk.claims.ClaimsSet claimsSet

Claims Set to use.

targetIDToken

private boolean targetIDToken

Whether we are adding claims to ID Token.

tokenClaimsCtx

@Nullable
private OIDCAuthenticationResponseTokenClaimsContext tokenClaimsCtx

delivery claims to copy to claims set.

Constructor Details

AddTokenDeliveryAttributesToClaimsSet

AddTokenDeliveryAttributesToClaimsSet()

Constructor.

Method Details

setTargetIDToken

public void setTargetIDToken(boolean flag)

Set whether target is id token claims set.

Parameters:

flag - whether target is id token claims set

setResponseClaimsSetLookupStrategy

public void setResponseClaimsSetLookupStrategy(@Nonnull
 Function<ProfileRequestContext,com.nimbusds.openid.connect.sdk.claims.ClaimsSet> strategy)

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

Parameters:

strategy - strategy used to locate the response ClaimsSet associated with a given ProfileRequestContext

setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy

public void setOIDCAuthenticationResponseTokenClaimsContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCAuthenticationResponseTokenClaimsContext> strategy)

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

Parameters:

strategy - lookup strategy

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractOIDCResponseAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction