DefaultReactiveOAuth2UserService (spring-security-docs 5.7.8 API)

java.lang.Object
- org.springframework.security.oauth2.client.userinfo.DefaultReactiveOAuth2UserService

All Implemented Interfaces:

ReactiveOAuth2UserService<OAuth2UserRequest,OAuth2User>
```
public class DefaultReactiveOAuth2UserService
extends java.lang.Object
implements ReactiveOAuth2UserService<OAuth2UserRequest,OAuth2User>
```
An implementation of an ReactiveOAuth2UserService that supports standard OAuth 2.0 Provider's.
For standard OAuth 2.0 Provider's, the attribute name used to access the user's name from the UserInfo response is required and therefore must be available via UserInfoEndpoint.getUserNameAttributeName().
NOTE: Attribute names are not standardized between providers and therefore will vary. Please consult the provider's API documentation for the set of supported user attribute names.

Since:

5.1

See Also:

ReactiveOAuth2UserService, OAuth2UserRequest, OAuth2User, DefaultOAuth2User

Constructor Summary

Constructors
Constructor Description

DefaultReactiveOAuth2UserService()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`reactor.core.publisher.Mono<OAuth2User>`	`loadUser(OAuth2UserRequest userRequest)`	Returns an `OAuth2User` after obtaining the user attributes of the End-User from the UserInfo Endpoint.
`void`	`setWebClient(org.springframework.web.reactive.function.client.WebClient webClient)`	Sets the `WebClient` used for retrieving the user endpoint

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultReactiveOAuth2UserService
```
public DefaultReactiveOAuth2UserService()
```
- Method Detail
  - loadUser
```
public reactor.core.publisher.Mono<OAuth2User> loadUser(OAuth2UserRequest userRequest)
                                                 throws OAuth2AuthenticationException
```
    Description copied from interface: ReactiveOAuth2UserService
    
    Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.
    
    Specified by:
    
    loadUser in interface ReactiveOAuth2UserService<OAuth2UserRequest,OAuth2User>
    
    Parameters:
    
    userRequest - the user request
    
    Returns:
    
    an OAuth2User
    
    Throws:
    
    OAuth2AuthenticationException - if an error occurs while attempting to obtain the user attributes from the UserInfo Endpoint
  - setWebClient
```
public void setWebClient(org.springframework.web.reactive.function.client.WebClient webClient)
```
    Sets the WebClient used for retrieving the user endpoint
    
    Parameters:
    
    webClient - the client to use