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

Class DefaultUserInfoRequestEncoder

java.lang.Object

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

net.shibboleth.idp.plugin.authn.oidc.rp.encoding.impl.AbstractRequestEncoderFunction

net.shibboleth.idp.plugin.authn.oidc.rp.encoding.impl.DefaultUserInfoRequestEncoder

All Implemented Interfaces:

Function<ProfileRequestContext,org.apache.http.client.methods.HttpUriRequest>, Component, DestructableComponent, InitializableComponent

public class DefaultUserInfoRequestEncoder
extends AbstractRequestEncoderFunction

Default encoder for UserInfo requests. Supports either GET or POST requests.

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,net.shibboleth.oidc.profile.oauth2.config.OAuth2AuthorizationProfileConfiguration.HttpRequestMethod>	httpMethodLookupStrategy	Strategy used to look up the HttpMethod used for this request.
private static String	HTTPS	The HTTPS scheme.
private 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
DefaultUserInfoRequestEncoder()	Constructor.

Method Summary

Modifier and Type	Method	Description
private void	addBearerTokenToGet(org.apache.http.client.methods.RequestBuilder rb, AccessTokenResponseContext responseCtx)	Add the bearer token to the Authorization header, used when issuing HTTP GET requests.
private void	addBearerTokenToPost(org.apache.http.client.methods.RequestBuilder rb, AccessTokenResponseContext responseCtx)	Add the bearer token to the 'access_token' parameter, used when issuing HTTP POST requests.
org.apache.http.client.methods.HttpUriRequest	doApply(ProfileRequestContext profileRequestContext)	Encode a HttpUriRequest from the given context.
void	setHttpMethodLookupStrategy(Function<ProfileRequestContext,net.shibboleth.oidc.profile.oauth2.config.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.idp.plugin.authn.oidc.rp.encoding.impl.AbstractRequestEncoderFunction

apply, getAuthenticationRequest, getAuthenticationResponse, getClientAuthenticationContext, getProviderMetadataContext, setOIDCClientAuthenticationContextContextLookupStrategy, setProviderMetadataLookupStrategy

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

andThen, compose

Field Detail

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,net.shibboleth.oidc.profile.oauth2.config.OAuth2AuthorizationProfileConfiguration.HttpRequestMethod> httpMethodLookupStrategy

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

Constructor Detail

DefaultUserInfoRequestEncoder

public DefaultUserInfoRequestEncoder()

Constructor.

Method Detail

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,net.shibboleth.oidc.profile.oauth2.config.OAuth2AuthorizationProfileConfiguration.HttpRequestMethod> strategy)

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

Parameters:

strategy - the strategy

doApply

public org.apache.http.client.methods.HttpUriRequest doApply(@Nonnull
                                                             ProfileRequestContext profileRequestContext)

Description copied from class: AbstractRequestEncoderFunction

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

Specified by:

doApply in class AbstractRequestEncoderFunction

Parameters:

profileRequestContext - the profile request context.

Returns:

the request to execute.

addBearerTokenToPost

private void addBearerTokenToPost(@Nonnull
                                  org.apache.http.client.methods.RequestBuilder rb,
                                  @Nonnull
                                  AccessTokenResponseContext responseCtx)
                           throws OIDCRPException

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:

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

addBearerTokenToGet

private void addBearerTokenToGet(@Nonnull
                                 org.apache.http.client.methods.RequestBuilder rb,
                                 @Nonnull
                                 AccessTokenResponseContext responseCtx)
                          throws OIDCRPException

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:

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