Interface OAuth2UserService<R extends OAuth2UserRequest,U extends OAuth2User>
- Type Parameters:
R
- The type of OAuth 2.0 User RequestU
- The type of OAuth 2.0 User
- All Known Implementing Classes:
DefaultOAuth2UserService
,DelegatingOAuth2UserService
,OidcUserService
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface
public interface OAuth2UserService<R extends OAuth2UserRequest,U extends OAuth2User>
Implementations of this interface are responsible for obtaining the user attributes of
the End-User (Resource Owner) from the UserInfo Endpoint using the
Access Token
granted to the
Client
and returning an
AuthenticatedPrincipal
in the form of an OAuth2User
.- Since:
- 5.0
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionReturns anOAuth2User
after obtaining the user attributes of the End-User from the UserInfo Endpoint.
-
Method Details
-
loadUser
Returns anOAuth2User
after obtaining the user attributes of the End-User from the UserInfo Endpoint.- 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
-