Class CustomUserTypesOAuth2UserService
java.lang.Object
org.springframework.security.oauth2.client.userinfo.CustomUserTypesOAuth2UserService
- All Implemented Interfaces:
OAuth2UserService<OAuth2UserRequest,
OAuth2User>
@Deprecated
public class CustomUserTypesOAuth2UserService
extends Object
implements OAuth2UserService<OAuth2UserRequest,OAuth2User>
Deprecated.
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:
-
Constructor Summary
ConstructorDescriptionCustomUserTypesOAuth2UserService
(Map<String, Class<? extends OAuth2User>> customUserTypes) Deprecated.Constructs aCustomUserTypesOAuth2UserService
using the provided parameters. -
Method Summary
Modifier and TypeMethodDescriptionloadUser
(OAuth2UserRequest userRequest) Deprecated.Returns anOAuth2User
after obtaining the user attributes of the End-User from the UserInfo Endpoint.final void
setRequestEntityConverter
(org.springframework.core.convert.converter.Converter<OAuth2UserRequest, org.springframework.http.RequestEntity<?>> requestEntityConverter) Deprecated.Sets theConverter
used for converting theOAuth2UserRequest
to aRequestEntity
representation of the UserInfo Request.final void
setRestOperations
(org.springframework.web.client.RestOperations restOperations) Deprecated.Sets theRestOperations
used when requesting the UserInfo resource.
-
Constructor Details
-
CustomUserTypesOAuth2UserService
Deprecated.Constructs aCustomUserTypesOAuth2UserService
using the provided parameters.- Parameters:
customUserTypes
- aMap
ofOAuth2User
type(s) keyed byRegistration Id
-
-
Method Details
-
loadUser
Deprecated.Description copied from interface:OAuth2UserService
Returns anOAuth2User
after obtaining the user attributes of the End-User from the UserInfo Endpoint.- Specified by:
loadUser
in interfaceOAuth2UserService<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
-
setRequestEntityConverter
public final void setRequestEntityConverter(org.springframework.core.convert.converter.Converter<OAuth2UserRequest, org.springframework.http.RequestEntity<?>> requestEntityConverter) Deprecated.Sets theConverter
used for converting theOAuth2UserRequest
to aRequestEntity
representation of the UserInfo Request.- Parameters:
requestEntityConverter
- theConverter
used for converting to aRequestEntity
representation of the UserInfo Request- Since:
- 5.1
-
setRestOperations
public final void setRestOperations(org.springframework.web.client.RestOperations restOperations) Deprecated.Sets theRestOperations
used when requesting the UserInfo resource.NOTE: At a minimum, the supplied
restOperations
must be configured with the following:ResponseErrorHandler
-OAuth2ErrorResponseErrorHandler
- Parameters:
restOperations
- theRestOperations
used when requesting the UserInfo resource- Since:
- 5.1
-
OAuth2UserService
to support customOAuth2User
types, as it provides much greater flexibility compared to this implementation. See the reference manual for details on how to implement.