Package org.springframework.security.oauth2.client.web.client

Class RequestAttributeClientRegistrationIdResolver

java.lang.Object

org.springframework.security.oauth2.client.web.client.RequestAttributeClientRegistrationIdResolver

All Implemented Interfaces:

OAuth2ClientHttpRequestInterceptor.ClientRegistrationIdResolver

public final class RequestAttributeClientRegistrationIdResolver
extends Object
implements OAuth2ClientHttpRequestInterceptor.ClientRegistrationIdResolver

A strategy for resolving a clientRegistrationId from an intercepted request using attributes.

Since:

6.4

See Also:

• OAuth2ClientHttpRequestInterceptor

Constructor Summary

Constructors

Constructor	Description
RequestAttributeClientRegistrationIdResolver()

Method Summary

Modifier and Type	Method	Description
static Consumer<Map<String,Object>>	clientRegistrationId(String clientRegistrationId)	Modifies the attributes to include the clientRegistrationId to be used to look up the OAuth2AuthorizedClient.
String	resolve(org.springframework.http.HttpRequest request)	Resolve the clientRegistrationId from the current request, which is used to obtain an OAuth2AuthorizedClient.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RequestAttributeClientRegistrationIdResolver

public RequestAttributeClientRegistrationIdResolver()

Method Details

resolve

public String resolve(org.springframework.http.HttpRequest request)

Description copied from interface: OAuth2ClientHttpRequestInterceptor.ClientRegistrationIdResolver

Resolve the clientRegistrationId from the current request, which is used to obtain an OAuth2AuthorizedClient.

Specified by:

resolve in interface OAuth2ClientHttpRequestInterceptor.ClientRegistrationIdResolver

Parameters:

request - the intercepted request, containing HTTP method, URI, headers, and request attributes

Returns:

the clientRegistrationId to be used for resolving an OAuth2AuthorizedClient.

clientRegistrationId

public static Consumer<Map<String,Object>> clientRegistrationId(String clientRegistrationId)

Modifies the attributes to include the clientRegistrationId to be used to look up the OAuth2AuthorizedClient.

Parameters:

clientRegistrationId - the clientRegistrationId to be used to look up the OAuth2AuthorizedClient

Returns:

the Consumer to populate the attributes