Package org.springframework.security.oauth2.client.userinfo

Interface OAuth2UserService<R extends OAuth2UserRequest,​U extends org.springframework.security.oauth2.core.user.OAuth2User>

  • Type Parameters:
    R - The type of OAuth 2.0 User Request
    U - The type of OAuth 2.0 User
    All Known Implementing Classes:
    CustomUserTypesOAuth2UserService, 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 org.springframework.security.oauth2.core.user.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:
    OAuth2UserRequest, OAuth2User, AuthenticatedPrincipal

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      U loadUser​(R userRequest)
      Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.

    • Method Detail

      • loadUser

        U loadUser​(R userRequest)
    throws org.springframework.security.oauth2.core.OAuth2AuthenticationException
        Returns an OAuth2User after obtaining the user attributes of the End-User from the UserInfo Endpoint.
        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