org.springframework.security.oauth2.oidc.user

Class DefaultUserInfo

java.lang.Object

org.springframework.security.oauth2.core.user.DefaultOAuth2User

org.springframework.security.oauth2.oidc.user.DefaultUserInfo

All Implemented Interfaces:

java.io.Serializable, AuthenticatedPrincipal, OAuth2User, UserInfo

public class DefaultUserInfo
extends DefaultOAuth2User
implements UserInfo

The default implementation of a UserInfo.

The key used for accessing the "name" of the Principal (user) via DefaultOAuth2User.getAttributes() is StandardClaimName.NAME or if not available will default to StandardClaimName.SUB.

Since:

5.0

See Also:

UserInfo, DefaultOAuth2User, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.security.oauth2.oidc.user.UserInfo

UserInfo.Address

Constructor Summary

Constructors

Constructor and Description
DefaultUserInfo(java.util.Map<java.lang.String,java.lang.Object> attributes)
DefaultUserInfo(java.util.Set<GrantedAuthority> authorities, java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Summary

Modifier and Type	Method and Description
UserInfo.Address	getAddress()
java.lang.String	getBirthdate()
java.lang.String	getEmail()
java.lang.Boolean	getEmailVerified()
java.lang.String	getFamilyName()
java.lang.String	getGender()
java.lang.String	getGivenName()
java.lang.String	getLocale()
java.lang.String	getMiddleName()
java.lang.String	getName() Returns the name of the authenticated Principal.
java.lang.String	getNickName()
java.lang.String	getPhoneNumber()
java.lang.Boolean	getPhoneNumberVerified()
java.lang.String	getPicture()
java.lang.String	getPreferredUsername()
java.lang.String	getProfile()
java.lang.String	getSubject()
java.time.Instant	getUpdatedAt()
java.lang.String	getWebsite()
java.lang.String	getZoneInfo()

Methods inherited from class org.springframework.security.oauth2.core.user.DefaultOAuth2User

equals, getAttributeAsBoolean, getAttributeAsInstant, getAttributeAsString, getAttributes, getAuthorities, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.security.oauth2.core.user.OAuth2User

getAttributes, getAuthorities

Constructor Detail

DefaultUserInfo

public DefaultUserInfo(java.util.Map<java.lang.String,java.lang.Object> attributes)

DefaultUserInfo

public DefaultUserInfo(java.util.Set<GrantedAuthority> authorities,
                       java.util.Map<java.lang.String,java.lang.Object> attributes)

Method Detail

getSubject

public java.lang.String getSubject()

Specified by:

getSubject in interface UserInfo

getName

public java.lang.String getName()

Description copied from interface: AuthenticatedPrincipal

Returns the name of the authenticated Principal. Never null.

Specified by:

getName in interface AuthenticatedPrincipal

Overrides:

getName in class DefaultOAuth2User

Returns:

the name of the authenticated Principal

getGivenName

public java.lang.String getGivenName()

Specified by:

getGivenName in interface UserInfo

getFamilyName

public java.lang.String getFamilyName()

Specified by:

getFamilyName in interface UserInfo

getMiddleName

public java.lang.String getMiddleName()

Specified by:

getMiddleName in interface UserInfo

getNickName

public java.lang.String getNickName()

Specified by:

getNickName in interface UserInfo

getPreferredUsername

public java.lang.String getPreferredUsername()

Specified by:

getPreferredUsername in interface UserInfo

getProfile

public java.lang.String getProfile()

Specified by:

getProfile in interface UserInfo

getPicture

public java.lang.String getPicture()

Specified by:

getPicture in interface UserInfo

getWebsite

public java.lang.String getWebsite()

Specified by:

getWebsite in interface UserInfo

getEmail

public java.lang.String getEmail()

Specified by:

getEmail in interface UserInfo

getEmailVerified

public java.lang.Boolean getEmailVerified()

Specified by:

getEmailVerified in interface UserInfo

getGender

public java.lang.String getGender()

Specified by:

getGender in interface UserInfo

getBirthdate

public java.lang.String getBirthdate()

Specified by:

getBirthdate in interface UserInfo

getZoneInfo

public java.lang.String getZoneInfo()

Specified by:

getZoneInfo in interface UserInfo

getLocale

public java.lang.String getLocale()

Specified by:

getLocale in interface UserInfo

getPhoneNumber

public java.lang.String getPhoneNumber()

Specified by:

getPhoneNumber in interface UserInfo

getPhoneNumberVerified

public java.lang.Boolean getPhoneNumberVerified()

Specified by:

getPhoneNumberVerified in interface UserInfo

getAddress

public UserInfo.Address getAddress()

Specified by:

getAddress in interface UserInfo

getUpdatedAt

public java.time.Instant getUpdatedAt()

Specified by:

getUpdatedAt in interface UserInfo