org.springframework.security.oauth2.client.user

Class DefaultOAuth2UserService

java.lang.Object

org.springframework.security.oauth2.client.user.DefaultOAuth2UserService

All Implemented Interfaces:

OAuth2UserService

public class DefaultOAuth2UserService
extends java.lang.Object
implements OAuth2UserService

An implementation of an OAuth2UserService that supports standard OAuth 2.0 Provider's.

For standard OAuth 2.0 Provider's, the attribute name (from the UserInfo Response) for the "user's name" is required and therefore must be supplied via ClientRegistration.ProviderDetails.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.

This implementation uses a UserInfoRetriever to obtain the user attributes of the End-User (resource owner) from the UserInfo Endpoint.

Since:

5.0

See Also:

OAuth2UserService, DefaultOAuth2User, UserInfoRetriever

Constructor Summary

Constructors

Constructor and Description
DefaultOAuth2UserService()

Method Summary

Modifier and Type	Method and Description
protected UserInfoRetriever	getUserInfoRetriever()
OAuth2User	loadUser(OAuth2ClientAuthenticationToken clientAuthentication)
void	setUserInfoRetriever(UserInfoRetriever userInfoRetriever)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultOAuth2UserService

public DefaultOAuth2UserService()

Method Detail

loadUser

public OAuth2User loadUser(OAuth2ClientAuthenticationToken clientAuthentication)
                    throws OAuth2AuthenticationException

Specified by:

loadUser in interface OAuth2UserService

Throws:

OAuth2AuthenticationException

getUserInfoRetriever

protected UserInfoRetriever getUserInfoRetriever()

setUserInfoRetriever

public final void setUserInfoRetriever(UserInfoRetriever userInfoRetriever)