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

Class InitializeOAuth2ClientContext

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.plugin.authn.oidc.rp.impl.InitializeOAuth2ClientContext

All Implemented Interfaces:

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

public class InitializeOAuth2ClientContext
extends AbstractProfileAction

An action that resolves the client identifier and redirect URI for the chosen provider (issuer).

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.INVALID_PROFILE_CONFIG, EventIds.INVALID_PROFILE_CTX

Postcondition:

Add the clientId and redirect URI to the OAuth2ClientContext

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private OAuth2ClientContext	oauth2ClientContext	The stashed OAuth2 client context.
private Function<ProfileRequestContext,OAuth2ClientContext>	oauth2ClientContextLookupStrategy	The strategy used to lookup or create the OAuth2ClientContext for storing the client_id.
private OIDCAuthenticationRelyingPartyProfileConfiguration	profileConfiguration	Applicable stashed profile configuration.
private Function<ProfileRequestContext,URI>	redirectUriOverrideLookupStrategy	A redirect_uri lookup strategy which can pull out an override redirect_uri from the profile request context.
private Function<ProfileRequestContext,RelyingPartyContext>	relyingPartyContextLookupStrategy	Lookup function for relying party context.

Constructor Summary

Constructors

Constructor	Description
InitializeOAuth2ClientContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
void	setOAuth2ClientContextLookupStrategy(Function<ProfileRequestContext,OAuth2ClientContext> strgy)	Set the strategy to lookup the OAuth2ClientContext from the ProfileRequestContext.
void	setRedirectUriOverrideLookupStrategy(Function<ProfileRequestContext,URI> strategy)	Set the redirect_uri lookup strategy to locate an explicitly set redirect_uri.
void	setRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)	Set lookup strategy for relying party context.

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, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, 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.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

oauth2ClientContextLookupStrategy

@NonnullAfterInit
private Function<ProfileRequestContext,OAuth2ClientContext> oauth2ClientContextLookupStrategy

The strategy used to lookup or create the OAuth2ClientContext for storing the client_id.

oauth2ClientContext

@Nullable
private OAuth2ClientContext oauth2ClientContext

The stashed OAuth2 client context.

redirectUriOverrideLookupStrategy

@Nonnull
private Function<ProfileRequestContext,URI> redirectUriOverrideLookupStrategy

A redirect_uri lookup strategy which can pull out an override redirect_uri from the profile request context.

relyingPartyContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy

Lookup function for relying party context.

profileConfiguration

@Nullable
private OIDCAuthenticationRelyingPartyProfileConfiguration profileConfiguration

Applicable stashed profile configuration.

Constructor Detail

InitializeOAuth2ClientContext

public InitializeOAuth2ClientContext()

Constructor.

Method Detail

setRelyingPartyContextLookupStrategy

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

Set lookup strategy for relying party context.

Parameters:

strategy - lookup strategy

setRedirectUriOverrideLookupStrategy

public void setRedirectUriOverrideLookupStrategy(@Nonnull
                                                 Function<ProfileRequestContext,URI> strategy)

Set the redirect_uri lookup strategy to locate an explicitly set redirect_uri.

Parameters:

strategy - the strategy.

setOAuth2ClientContextLookupStrategy

public void setOAuth2ClientContextLookupStrategy(@Nonnull
                                                 Function<ProfileRequestContext,OAuth2ClientContext> strgy)

Set the strategy to lookup the OAuth2ClientContext from the ProfileRequestContext.

Parameters:

strgy - the strategy.

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction