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

Class RequestAttributePrincipalResolver

java.lang.Object

org.springframework.security.oauth2.client.web.client.RequestAttributePrincipalResolver

All Implemented Interfaces:

OAuth2ClientHttpRequestInterceptor.PrincipalResolver

public class RequestAttributePrincipalResolver
extends Object
implements OAuth2ClientHttpRequestInterceptor.PrincipalResolver

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

Since:

6.4

Constructor Summary

Constructors

Constructor	Description
RequestAttributePrincipalResolver()

Method Summary

Modifier and Type	Method	Description
static Consumer<Map<String,Object>>	principal(String principalName)	Modifies the attributes to include the principal to be used to look up the OAuth2AuthorizedClient.
static Consumer<Map<String,Object>>	principal(org.springframework.security.core.Authentication principal)	Modifies the attributes to include the principal to be used to look up the OAuth2AuthorizedClient.
org.springframework.security.core.Authentication	resolve(org.springframework.http.HttpRequest request)	Resolve the principal 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

RequestAttributePrincipalResolver

public RequestAttributePrincipalResolver()

Method Details

resolve

public org.springframework.security.core.Authentication resolve(org.springframework.http.HttpRequest request)

Description copied from interface: OAuth2ClientHttpRequestInterceptor.PrincipalResolver

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

Specified by:

resolve in interface OAuth2ClientHttpRequestInterceptor.PrincipalResolver

Parameters:

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

Returns:

the principal to be used for resolving an OAuth2AuthorizedClient.

principal

public static Consumer<Map<String,Object>> principal(org.springframework.security.core.Authentication principal)

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

Parameters:

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

Returns:

the Consumer to populate the attributes

principal

public static Consumer<Map<String,Object>> principal(String principalName)

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

Parameters:

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

Returns:

the Consumer to populate the attributes