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

Class UserInfoRequestEncoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

net.shibboleth.oidc.profile.encoding.impl.UserInfoRequestEncoder

All Implemented Interfaces:

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

@NotThreadSafe
public class UserInfoRequestEncoder
extends AbstractRequestEncoderFunction

Encoder responsible for constructing an HTTP request to the OpenID Connect (OIDC) UserInfo endpoint. Supports either GET or POST requests.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,OAuth2AuthorizationProfileConfiguration.HttpRequestMethod>	httpMethodLookupStrategy	Strategy used to look up the HttpMethod used for this request.
private static final String	HTTPS	The HTTPS scheme.
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,AccessTokenResponseContext>	tokenResponseContextLookupStrategy	Strategy used to look up the AccessTokenResponseContext to set the parameters for.

Constructor Summary

Constructors

Constructor	Description
UserInfoRequestEncoder()	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	addBearerTokenToGet(org.apache.hc.core5.http.io.support.ClassicRequestBuilder rb, AccessTokenResponseContext responseCtx)	Add the bearer token to the Authorization header, used when issuing HTTP GET requests.
private void	addBearerTokenToPost(org.apache.hc.core5.http.io.support.ClassicRequestBuilder rb, AccessTokenResponseContext responseCtx)	Add the bearer token to the 'access_token' parameter, used when issuing HTTP POST requests.
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	setHttpMethodLookupStrategy(Function<ProfileRequestContext,OAuth2AuthorizationProfileConfiguration.HttpRequestMethod> strategy)	Set the strategy used to lookup the HTTP method to use in this request.
void	setTokenResponseContextLookupStrategy(Function<ProfileRequestContext,AccessTokenResponseContext> strategy)	Set the strategy used to lookup the AccessTokenResponseContext.

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

HTTPS

@Nonnull
@NotEmpty
private static final String HTTPS

The HTTPS scheme.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

tokenResponseContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AccessTokenResponseContext> tokenResponseContextLookupStrategy

Strategy used to look up the AccessTokenResponseContext to set the parameters for.

httpMethodLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OAuth2AuthorizationProfileConfiguration.HttpRequestMethod> httpMethodLookupStrategy

Strategy used to look up the HttpMethod used for this request.

Constructor Details

UserInfoRequestEncoder

public UserInfoRequestEncoder()

Constructor.

Method Details

setTokenResponseContextLookupStrategy

public void setTokenResponseContextLookupStrategy(Function<ProfileRequestContext,AccessTokenResponseContext> strategy)

Set the strategy used to lookup the AccessTokenResponseContext.

Parameters:

strategy - the strategy

setHttpMethodLookupStrategy

public void setHttpMethodLookupStrategy(Function<ProfileRequestContext,OAuth2AuthorizationProfileConfiguration.HttpRequestMethod> strategy)

Set the strategy used to lookup the HTTP method to use in this request.

Parameters:

strategy - the strategy

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.

addBearerTokenToPost

private void addBearerTokenToPost(@Nonnull
 org.apache.hc.core5.http.io.support.ClassicRequestBuilder rb,
 @Nonnull
 AccessTokenResponseContext responseCtx)
                           throws MessageEncodingException

Add the bearer token to the 'access_token' parameter, used when issuing HTTP POST requests.

Parameters:

rb - the request builder to use.

responseCtx - the response context to find the access_token from.

Throws:

MessageEncodingException - if there is an issue adding the bearer token to the 'access_token' parameter.

addBearerTokenToGet

private void addBearerTokenToGet(@Nonnull
 org.apache.hc.core5.http.io.support.ClassicRequestBuilder rb,
 @Nonnull
 AccessTokenResponseContext responseCtx)
                          throws MessageEncodingException

Add the bearer token to the Authorization header, used when issuing HTTP GET requests.

Parameters:

rb - the request builder to use.

responseCtx - the response context to find the access_token from.

Throws:

MessageEncodingException - if there is an issue adding the bearer token to the Authorization header.