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

Class AbstractRequestEncoderFunction

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AuthCodeTokenRequestEncoder, UserInfoRequestEncoder

public abstract class AbstractRequestEncoderFunction
extends AbstractInitializableComponent
implements Function<ProfileRequestContext,org.apache.hc.core5.http.ClassicHttpRequest>

Abstract request encoder function that pulls out various contexts and request/response messages.

Field Summary

Fields

Modifier and Type	Field	Description
private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse	authnResponse	OIDC authentication response from upstream OP.
private OAuth2ClientAuthenticationContext	clientAuthnContext	The context used to store client authentication information for communication with a upstream OP.
private final org.slf4j.Logger	log	Class logger.
private Function<ProfileRequestContext,OAuth2ClientAuthenticationContext>	oauth2ClientAuthenticationContextLookupStrategy	The strategy used to lookup or create the OAuth2ClientAuthenticationContext.
private OIDCProviderMetadataContext	providerMetadataContext	OIDC Metadata context.
private Function<ProfileRequestContext,OIDCProviderMetadataContext>	providerMetadataLookupStrategy	Lookup strategy to locate the OP metadata to use.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractRequestEncoderFunction()	Constructor.

Method Summary

Modifier and Type	Method	Description
org.apache.hc.core5.http.ClassicHttpRequest	apply(ProfileRequestContext profileRequestContext)
protected abstract org.apache.hc.core5.http.ClassicHttpRequest	doApply(ProfileRequestContext profileRequestContext, com.nimbusds.openid.connect.sdk.op.OIDCProviderMetadata providerMetadata)	Encode a ClassicHttpRequest from the given context.
protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse	getAuthenticationResponse()	Returns the authentication response from the upstream OP.
protected OAuth2ClientAuthenticationContext	getClientAuthenticationContext()	Get the client authentication context.
protected OIDCProviderMetadataContext	getProviderMetadataContext()	Returns the OIDC provider metadata context.
void	setOAuth2ClientAuthenticationContextLookupStrategy(Function<ProfileRequestContext,OAuth2ClientAuthenticationContext> strgy)	Set the strategy to lookup the OAuth2ClientAuthenticationContext.
void	setProviderMetadataLookupStrategy(Function<ProfileRequestContext,OIDCProviderMetadataContext> strategy)	Set the lookup strategy to locate the OpenID providers metadata.

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.

providerMetadataLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OIDCProviderMetadataContext> providerMetadataLookupStrategy

Lookup strategy to locate the OP metadata to use.

oauth2ClientAuthenticationContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,OAuth2ClientAuthenticationContext> oauth2ClientAuthenticationContextLookupStrategy

The strategy used to lookup or create the OAuth2ClientAuthenticationContext.

authnResponse

@Nullable
private com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse authnResponse

OIDC authentication response from upstream OP.

providerMetadataContext

@Nullable
private OIDCProviderMetadataContext providerMetadataContext

OIDC Metadata context.

clientAuthnContext

@Nullable
private OAuth2ClientAuthenticationContext clientAuthnContext

The context used to store client authentication information for communication with a upstream OP.

Constructor Details

AbstractRequestEncoderFunction

protected AbstractRequestEncoderFunction()

Constructor.

Method Details

setOAuth2ClientAuthenticationContextLookupStrategy

public void setOAuth2ClientAuthenticationContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OAuth2ClientAuthenticationContext> strgy)

Set the strategy to lookup the OAuth2ClientAuthenticationContext.

Parameters:

strgy - the strategy.

setProviderMetadataLookupStrategy

public void setProviderMetadataLookupStrategy(@Nonnull
 Function<ProfileRequestContext,OIDCProviderMetadataContext> strategy)

Set the lookup strategy to locate the OpenID providers metadata.

Parameters:

strategy - the strategy.

getAuthenticationResponse

@Nullable
protected com.nimbusds.openid.connect.sdk.AuthenticationSuccessResponse getAuthenticationResponse()

Returns the authentication response from the upstream OP.

Returns:

the authentication response.

getClientAuthenticationContext

@Nullable
protected OAuth2ClientAuthenticationContext getClientAuthenticationContext()

Get the client authentication context.

Returns:

the client context.

getProviderMetadataContext

@Nullable
protected OIDCProviderMetadataContext getProviderMetadataContext()

Returns the OIDC provider metadata context.

Returns:

The provider metadata context.

apply

@Nullable
public org.apache.hc.core5.http.ClassicHttpRequest apply(@Nullable
 ProfileRequestContext profileRequestContext)

Creates the HTTP request. Any error in creating the request should return null to indicate failure.

Specified by:

apply in interface Function<ProfileRequestContext,org.apache.hc.core5.http.ClassicHttpRequest>

doApply

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

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

Parameters:

profileRequestContext - the profile request context.

providerMetadata - the provider metadata.

Returns:

the request to execute.