Package net.shibboleth.oidc.profile.encoding.impl

Class AuthCodeTokenRequestEncoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

net.shibboleth.oidc.profile.encoding.impl.AbstractRequestEncoderFunction

net.shibboleth.oidc.profile.encoding.impl.AuthCodeTokenRequestEncoder

All Implemented Interfaces:

Function<ProfileRequestContext,org.apache.hc.core5.http.ClassicHttpRequest>, Component, DestructableComponent, InitializableComponent

public class AuthCodeTokenRequestEncoder
extends AbstractRequestEncoderFunction

A token request encoder that builds an OAuth2.0 Access Token Request for an authorization_code grant and returns an HttpUriRequest.

Field Summary

Fields

Modifier and Type	Field	Description
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,String>	pkceCodeVerifierLookupStrategy	The lookup strategy to pull out the PKCE code_verifier to send in the token request.
private Function<ProfileRequestContext,URI>	redirectUriLookupStrategy	The strategy used to look up the redirect URI to use in the token request.

Constructor Summary

Constructors

Constructor	Description
AuthCodeTokenRequestEncoder()

Method Summary

Modifier and Type	Method	Description
private org.apache.hc.core5.http.ClassicHttpRequest	convertHttpRequest(com.nimbusds.oauth2.sdk.http.HTTPRequest request)	Convert the internally used HTTPRequest to the externally presented HttpUriRequest.
org.apache.hc.core5.http.ClassicHttpRequest	doApply(ProfileRequestContext profileRequestContext, com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)	Encode a ClassicHttpRequest from the given context.
void	setPkceCodeVerifierLookupStrategy(Function<ProfileRequestContext,String> strategy)	Set the strategy used to look up the PKCE code_verifier to send in the token request.
void	setRedirectUriLookupStrategy(Function<ProfileRequestContext,URI> strategy)	Set the strategy used to look up the redirect URI to use in the token request.

Methods inherited from class net.shibboleth.oidc.profile.encoding.impl.AbstractRequestEncoderFunction

apply, getAuthenticationResponse, getClientAuthenticationContext, getProviderMetadataContext, setOAuth2ClientAuthenticationContextLookupStrategy, setProviderMetadataLookupStrategy

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 java.util.function.Function

andThen, compose

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

pkceCodeVerifierLookupStrategy

@Nonnull
private Function<ProfileRequestContext,String> pkceCodeVerifierLookupStrategy

The lookup strategy to pull out the PKCE code_verifier to send in the token request.

redirectUriLookupStrategy

@Nonnull
private Function<ProfileRequestContext,URI> redirectUriLookupStrategy

The strategy used to look up the redirect URI to use in the token request. This will typically be the same URI used in the authorization request, but may be overridden if necessary. If not set, no redirect URI will be included in the token request which may result in an error on the OpenID Provider.

Constructor Details

AuthCodeTokenRequestEncoder

public AuthCodeTokenRequestEncoder()

Method Details

setRedirectUriLookupStrategy

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

Set the strategy used to look up the redirect URI to use in the token request. This will typically be the same URI used in the authorization request, but may be overridden if necessary. If not set, no redirect URI will be included in the token request which may result in an error at the OpenID Provider.

Parameters:

strategy - The RedirectUriLookupStrategy to set.

setPkceCodeVerifierLookupStrategy

public void setPkceCodeVerifierLookupStrategy(@Nonnull
 Function<ProfileRequestContext,String> strategy)

Set the strategy used to look up the PKCE code_verifier to send in the token request.

Parameters:

strategy - The PKCE lookup strategy to set.

doApply

@Nullable
public org.apache.hc.core5.http.ClassicHttpRequest doApply(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)

Description copied from class: AbstractRequestEncoderFunction

Encode a ClassicHttpRequest from the given context. Implementations should override this method.

Specified by:

doApply in class AbstractRequestEncoderFunction

Parameters:

profileRequestContext - the profile request context.

providerMetadata - the provider metadata.

Returns:

the request to execute.

convertHttpRequest

@Nullable
private org.apache.hc.core5.http.ClassicHttpRequest convertHttpRequest(@Nonnull
 com.nimbusds.oauth2.sdk.http.HTTPRequest request)

Convert the internally used HTTPRequest to the externally presented HttpUriRequest.

Parameters:

request - the HTTP request to convert

Returns:

the convert HTTP request