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

Class GenerateClientID

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

public class GenerateClientID
extends AbstractProfileAction

Creates the client ID for the registration.

If an access token was used, it may contain the client_id to use. Otherwise uses the IdentifierGenerationStrategy attached to the profile configuration. The client ID is included to the OIDCClientRegistrationResponseContext.

Field Summary

Fields

Modifier and Type	Field	Description
private IdentifierGenerationStrategy	idGenerator	The client ID generator to use.
private Function<ProfileRequestContext,IdentifierGenerationStrategy>	idGeneratorLookupStrategy	Strategy used to locate the IdentifierGenerationStrategy to use.
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,OIDCClientRegistrationResponseContext>	oidcResponseContextLookupStrategy	Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given request.
private OIDCClientRegistrationResponseContext	oidcResponseCtx	The OIDCClientRegistrationResponseContext to create the client ID to.
private Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext>	registrationTokenContextLookupStrategy	Strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with the request.
private OIDCClientRegistrationTokenClaimsContext	registrationTokenCtx	The OIDCClientRegistrationTokenClaimsContext from which to optionally obtain client ID.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
private RelyingPartyContext	rpCtx	The RelyingPartyContext to operate on.
private boolean	xmlSafeIdentifier	The xmlSafe-flag passed to the identifier generator.

Constructor Summary

Constructors

Constructor	Description
GenerateClientID()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setIdentifierGeneratorLookupStrategy(Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)	Set the strategy used to locate the IdentifierGenerationStrategy to use.
void	setOidcResponseContextLookupStrategy(Function<ProfileRequestContext,OIDCClientRegistrationResponseContext> strategy)	Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.
void	setRegistrationTokenContextLookupStrategy(Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> strategy)	Set the strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with a given request.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set the strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext.
void	setXmlSafeIdentifier(boolean flag)	Set the xmlSafe-flag passed to the identifier generator

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

Class logger.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

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

oidcResponseContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCClientRegistrationResponseContext> oidcResponseContextLookupStrategy

Strategy used to locate the OIDCClientRegistrationResponseContext associated with a given request.

registrationTokenContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> registrationTokenContextLookupStrategy

Strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with the request.

idGeneratorLookupStrategy

@Nonnull
private Function<ProfileRequestContext,IdentifierGenerationStrategy> idGeneratorLookupStrategy

Strategy used to locate the IdentifierGenerationStrategy to use.

rpCtx

@Nullable
private RelyingPartyContext rpCtx

The RelyingPartyContext to operate on.

oidcResponseCtx

@Nullable
private OIDCClientRegistrationResponseContext oidcResponseCtx

The OIDCClientRegistrationResponseContext to create the client ID to.

registrationTokenCtx

@Nullable
private OIDCClientRegistrationTokenClaimsContext registrationTokenCtx

The OIDCClientRegistrationTokenClaimsContext from which to optionally obtain client ID.

idGenerator

@Nullable
private IdentifierGenerationStrategy idGenerator

The client ID generator to use.

xmlSafeIdentifier

private boolean xmlSafeIdentifier

The xmlSafe-flag passed to the identifier generator.

Constructor Details

GenerateClientID

public GenerateClientID()

Constructor.

Method Details

setRelyingPartyContextLookupStrategy

public void setRelyingPartyContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,RelyingPartyContext> strategy)

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

Parameters:

strategy - strategy used to locate the RelyingPartyContext associated with a given ProfileRequestContext

setOidcResponseContextLookupStrategy

public void setOidcResponseContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCClientRegistrationResponseContext> strategy)

Set the strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext.

Parameters:

strategy - strategy used to locate the OIDCClientRegistrationResponseContext associated with a given MessageContext

setRegistrationTokenContextLookupStrategy

public void setRegistrationTokenContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCClientRegistrationTokenClaimsContext> strategy)

Set the strategy used to locate the OIDCClientRegistrationTokenClaimsContext associated with a given request.

Parameters:

strategy - lookup strategy

setIdentifierGeneratorLookupStrategy

public void setIdentifierGeneratorLookupStrategy(@Nonnull
 Function<ProfileRequestContext,IdentifierGenerationStrategy> strategy)

Set the strategy used to locate the IdentifierGenerationStrategy to use.

Parameters:

strategy - What to set.

setXmlSafeIdentifier

public void setXmlSafeIdentifier(boolean flag)

Set the xmlSafe-flag passed to the identifier generator

Parameters:

flag - xmlSafe-flag

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction