org.springframework.security.oauth2.client.userinfo

Class CustomUserTypesOAuth2UserService

java.lang.Object

org.springframework.security.oauth2.client.userinfo.CustomUserTypesOAuth2UserService

All Implemented Interfaces:

OAuth2UserService<OAuth2UserRequest,org.springframework.security.oauth2.core.user.OAuth2User>

public class CustomUserTypesOAuth2UserService
extends java.lang.Object
implements OAuth2UserService<OAuth2UserRequest,org.springframework.security.oauth2.core.user.OAuth2User>

An implementation of an OAuth2UserService that supports custom OAuth2User types.

The custom user type(s) is supplied via the constructor, using a Map of OAuth2User type(s) keyed by String, which represents the Registration Id of the Client.

Since:

5.0

See Also:

OAuth2UserService, OAuth2UserRequest, OAuth2User, ClientRegistration

Constructor Summary

Constructors

Constructor and Description
CustomUserTypesOAuth2UserService(java.util.Map<java.lang.String,java.lang.Class<? extends org.springframework.security.oauth2.core.user.OAuth2User>> customUserTypes) Constructs a CustomUserTypesOAuth2UserService using the provided parameters.

Method Summary

Modifier and Type	Method and Description
org.springframework.security.oauth2.core.user.OAuth2User	loadUser(OAuth2UserRequest userRequest) Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomUserTypesOAuth2UserService

public CustomUserTypesOAuth2UserService(java.util.Map<java.lang.String,java.lang.Class<? extends org.springframework.security.oauth2.core.user.OAuth2User>> customUserTypes)

Constructs a CustomUserTypesOAuth2UserService using the provided parameters.

Parameters:

customUserTypes - a Map of OAuth2User type(s) keyed by Registration Id

Method Detail

loadUser

public org.springframework.security.oauth2.core.user.OAuth2User loadUser(OAuth2UserRequest userRequest)
                                                                  throws org.springframework.security.oauth2.core.OAuth2AuthenticationException

Description copied from interface: OAuth2UserService

Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.

Specified by:

loadUser in interface OAuth2UserService<OAuth2UserRequest,org.springframework.security.oauth2.core.user.OAuth2User>

Parameters:

userRequest - the user request

Returns:

an OAuth2User

Throws:

org.springframework.security.oauth2.core.OAuth2AuthenticationException - if an error occurs while attempting to obtain the user attributes from the UserInfo Endpoint