org.springframework.security.oauth2.client.user.nimbus

Class NimbusOAuth2UserService

java.lang.Object

org.springframework.security.oauth2.client.user.nimbus.NimbusOAuth2UserService

All Implemented Interfaces:

OAuth2UserService

public class NimbusOAuth2UserService
extends java.lang.Object
implements OAuth2UserService

An implementation of an OAuth2UserService that uses the Nimbus OAuth 2.0 SDK internally.

This implementation may be configured with a Map of custom OAuth2User types keyed by URI, which represents the UserInfo Endpoint address.

For OAuth2User's registered at a standard OAuth 2.0 Provider, the attribute name for the "user's name" is required. This can be supplied via setUserNameAttributeNames(Map), keyed by URI, which represents the UserInfo Endpoint address.

Since:

5.0

See Also:

OAuth2AuthenticationToken, OAuth2User, OidcUser, UserInfo, Nimbus OAuth 2.0 SDK

Constructor Summary

Constructors

Constructor and Description
NimbusOAuth2UserService()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.net.URI,java.lang.Class<? extends OAuth2User>>	getCustomUserTypes()
protected java.util.Map<java.lang.String,java.lang.Object>	getUserInfo(OAuth2AuthenticationToken token)
protected java.util.Map<java.net.URI,java.lang.String>	getUserNameAttributeNames()
protected OAuth2User	loadCustomUser(OAuth2AuthenticationToken token)
protected OAuth2User	loadOAuth2User(OAuth2AuthenticationToken token)
protected OAuth2User	loadOidcUser(OAuth2AuthenticationToken token)
OAuth2User	loadUser(OAuth2AuthenticationToken token)
void	setCustomUserTypes(java.util.Map<java.net.URI,java.lang.Class<? extends OAuth2User>> customUserTypes)
void	setUserNameAttributeNames(java.util.Map<java.net.URI,java.lang.String> userNameAttributeNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

NimbusOAuth2UserService

public NimbusOAuth2UserService()

Method Detail

loadUser

public final OAuth2User loadUser(OAuth2AuthenticationToken token)
                          throws OAuth2AuthenticationException

Specified by:

loadUser in interface OAuth2UserService

Throws:

OAuth2AuthenticationException

loadOidcUser

protected OAuth2User loadOidcUser(OAuth2AuthenticationToken token)
                           throws OAuth2AuthenticationException

Throws:

OAuth2AuthenticationException

loadOAuth2User

protected OAuth2User loadOAuth2User(OAuth2AuthenticationToken token)
                             throws OAuth2AuthenticationException

Throws:

OAuth2AuthenticationException

loadCustomUser

protected OAuth2User loadCustomUser(OAuth2AuthenticationToken token)
                             throws OAuth2AuthenticationException

Throws:

OAuth2AuthenticationException

getUserInfo

protected java.util.Map<java.lang.String,java.lang.Object> getUserInfo(OAuth2AuthenticationToken token)
                                                                throws OAuth2AuthenticationException

Throws:

OAuth2AuthenticationException

getUserNameAttributeNames

protected java.util.Map<java.net.URI,java.lang.String> getUserNameAttributeNames()

setUserNameAttributeNames

public final void setUserNameAttributeNames(java.util.Map<java.net.URI,java.lang.String> userNameAttributeNames)

getCustomUserTypes

protected java.util.Map<java.net.URI,java.lang.Class<? extends OAuth2User>> getCustomUserTypes()

setCustomUserTypes

public final void setCustomUserTypes(java.util.Map<java.net.URI,java.lang.Class<? extends OAuth2User>> customUserTypes)