Class UserInfo
- java.lang.Object
-
- com.nimbusds.openid.connect.sdk.claims.ClaimsSet
-
- com.nimbusds.openid.connect.sdk.claims.UserInfo
-
public class UserInfo extends ClaimsSet
UserInfo claims set, serialisable to a JSON object.Supports normal, aggregated and distributed claims.
Example UserInfo claims set:
{ "sub" : "248289761001", "name" : "Jane Doe", "given_name" : "Jane", "family_name" : "Doe", "preferred_username" : "j.doe", "email" : "[email protected]", "picture" : "http://example.com/janedoe/me.jpg" }
Related specifications:
- OpenID Connect Core 1.0, sections 5.1 and 5.6.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ADDRESS_CLAIM_NAME
The address claim name.static String
AUD_CLAIM_NAME
The audience claim name.static String
BIRTHDATE_CLAIM_NAME
The birth date claim name.static String
EMAIL_CLAIM_NAME
The email claim name.static String
EMAIL_VERIFIED_CLAIM_NAME
The email verified claim name.static String
FAMILY_NAME_CLAIM_NAME
The family name claim name.static String
GENDER_CLAIM_NAME
The gender claim name.static String
GIVEN_NAME_CLAIM_NAME
The given name claim name.static String
ISS_CLAIM_NAME
The issuer claim name.static String
LOCALE_CLAIM_NAME
The locale claim name.static String
MIDDLE_NAME_CLAIM_NAME
The middle name claim name.static String
NAME_CLAIM_NAME
The name claim name.static String
NICKNAME_CLAIM_NAME
The nickname claim name.static String
PHONE_NUMBER_CLAIM_NAME
The phone number claim name.static String
PHONE_NUMBER_VERIFIED_CLAIM_NAME
The phone number verified claim name.static String
PICTURE_CLAIM_NAME
The picture claim name.static String
PREFERRED_USERNAME_CLAIM_NAME
The preferred username claim name.static String
PROFILE_CLAIM_NAME
The profile claim name.static String
SUB_CLAIM_NAME
The subject claim name.static String
UPDATED_AT_CLAIM_NAME
The updated at claim name.static String
WEBSITE_CLAIM_NAME
The website claim name.static String
ZONEINFO_CLAIM_NAME
The zoneinfo claim name.
-
Constructor Summary
Constructors Constructor Description UserInfo(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
Creates a new UserInfo claims set from the specified JSON Web Token (JWT) claims set.UserInfo(Subject sub)
Creates a new minimal UserInfo claims set.UserInfo(net.minidev.json.JSONObject jsonObject)
Creates a new UserInfo claims set from the specified JSON object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addAggregatedClaims(AggregatedClaims aggregatedClaims)
Adds the specified aggregated claims provided by an external claims source.void
addDistributedClaims(DistributedClaims distributedClaims)
Adds the specified distributed claims from an external claims source.Address
getAddress()
Gets the preferred address.Address
getAddress(com.nimbusds.langtag.LangTag langTag)
Gets the preferred address.Map<com.nimbusds.langtag.LangTag,Address>
getAddressEntries()
Gets the preferred address entries.Set<AggregatedClaims>
getAggregatedClaims()
Gets the included aggregated claims provided by each external claims source.List<Audience>
getAudience()
Gets the audience.String
getBirthdate()
Gets the date of birth.Set<DistributedClaims>
getDistributedClaims()
Gets the included distributed claims provided by each external claims source.javax.mail.internet.InternetAddress
getEmail()
Deprecated.String
getEmailAddress()
Gets the preferred email address.Boolean
getEmailVerified()
Gets the email verification status.String
getFamilyName()
Gets the surname or last name.String
getFamilyName(com.nimbusds.langtag.LangTag langTag)
Gets the surname or last name.Map<com.nimbusds.langtag.LangTag,String>
getFamilyNameEntries()
Gets the surname or last name entries.Gender
getGender()
Gets the gender.String
getGivenName()
Gets the given or first name.String
getGivenName(com.nimbusds.langtag.LangTag langTag)
Gets the given or first name.Map<com.nimbusds.langtag.LangTag,String>
getGivenNameEntries()
Gets the given or first name entries.Issuer
getIssuer()
Gets the issuer.String
getLocale()
Gets the locale.String
getMiddleName()
Gets the middle name.String
getMiddleName(com.nimbusds.langtag.LangTag langTag)
Gets the middle name.Map<com.nimbusds.langtag.LangTag,String>
getMiddleNameEntries()
Gets the middle name entries.String
getName()
Gets the full name.String
getName(com.nimbusds.langtag.LangTag langTag)
Gets the full name.Map<com.nimbusds.langtag.LangTag,String>
getNameEntries()
Gets the full name entries.String
getNickname()
Gets the casual name.String
getNickname(com.nimbusds.langtag.LangTag langTag)
Gets the casual name.Map<com.nimbusds.langtag.LangTag,String>
getNicknameEntries()
Gets the casual name entries.String
getPhoneNumber()
Gets the preferred telephone number.Boolean
getPhoneNumberVerified()
Gets the phone number verification status.URI
getPicture()
Gets the picture.String
getPreferredUsername()
Gets the preferred username.URI
getProfile()
Gets the profile page.static Set<String>
getStandardClaimNames()
Gets the names of the standard top-level UserInfo claims.Subject
getSubject()
Gets the UserInfo subject.Date
getUpdatedTime()
Gets the time the end-user information was last updated.URI
getWebsite()
Gets the web page or blog.String
getZoneinfo()
Gets the zoneinfo.static UserInfo
parse(String json)
Parses a UserInfo claims set from the specified JSON object string.void
putAll(UserInfo other)
Puts all claims from the specified other UserInfo claims set.void
setAddress(Address address)
Sets the preferred address.void
setAddress(Address address, com.nimbusds.langtag.LangTag langTag)
Sets the preferred address.void
setAudience(Audience aud)
Sets the audience.void
setAudience(List<Audience> audList)
Sets the audience list.void
setBirthdate(String birthdate)
Sets the date of birth.void
setEmail(javax.mail.internet.InternetAddress email)
Deprecated.void
setEmailAddress(String email)
Sets the preferred email address.void
setEmailVerified(Boolean emailVerified)
Sets the email verification status.void
setFamilyName(String familyName)
Sets the surname or last name.void
setFamilyName(String familyName, com.nimbusds.langtag.LangTag langTag)
Sets the surname or last name.void
setGender(Gender gender)
Sets the gender.void
setGivenName(String givenName)
Sets the given or first name.void
setGivenName(String givenName, com.nimbusds.langtag.LangTag langTag)
Sets the given or first name.void
setIssuer(Issuer iss)
Sets the issuer.void
setLocale(String locale)
Sets the locale.void
setMiddleName(String middleName)
Sets the middle name.void
setMiddleName(String middleName, com.nimbusds.langtag.LangTag langTag)
Sets the middle name.void
setName(String name)
Sets the full name.void
setName(String name, com.nimbusds.langtag.LangTag langTag)
Sets the full name.void
setNickname(String nickname)
Sets the casual name.void
setNickname(String nickname, com.nimbusds.langtag.LangTag langTag)
Sets the casual name.void
setPhoneNumber(String phoneNumber)
Sets the preferred telephone number.void
setPhoneNumberVerified(Boolean phoneNumberVerified)
Sets the email verification status.void
setPicture(URI picture)
Sets the picture.void
setPreferredUsername(String preferredUsername)
Sets the preferred username.void
setProfile(URI profile)
Sets the profile page.void
setUpdatedTime(Date updatedTime)
Sets the time the end-user information was last updated.void
setWebsite(URI website)
Sets the web page or blog.void
setZoneinfo(String zoneinfo)
Sets the zoneinfo.-
Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet
getBooleanClaim, getClaim, getClaim, getDateClaim, getEmailClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, putAll, putAll, setClaim, setClaim, setDateClaim, setEmailClaim, setURIClaim, setURLClaim, toJSONObject, toJWTClaimsSet
-
-
-
-
Field Detail
-
SUB_CLAIM_NAME
public static final String SUB_CLAIM_NAME
The subject claim name.- See Also:
- Constant Field Values
-
ISS_CLAIM_NAME
public static final String ISS_CLAIM_NAME
The issuer claim name.- See Also:
- Constant Field Values
-
AUD_CLAIM_NAME
public static final String AUD_CLAIM_NAME
The audience claim name.- See Also:
- Constant Field Values
-
NAME_CLAIM_NAME
public static final String NAME_CLAIM_NAME
The name claim name.- See Also:
- Constant Field Values
-
GIVEN_NAME_CLAIM_NAME
public static final String GIVEN_NAME_CLAIM_NAME
The given name claim name.- See Also:
- Constant Field Values
-
FAMILY_NAME_CLAIM_NAME
public static final String FAMILY_NAME_CLAIM_NAME
The family name claim name.- See Also:
- Constant Field Values
-
MIDDLE_NAME_CLAIM_NAME
public static final String MIDDLE_NAME_CLAIM_NAME
The middle name claim name.- See Also:
- Constant Field Values
-
NICKNAME_CLAIM_NAME
public static final String NICKNAME_CLAIM_NAME
The nickname claim name.- See Also:
- Constant Field Values
-
PREFERRED_USERNAME_CLAIM_NAME
public static final String PREFERRED_USERNAME_CLAIM_NAME
The preferred username claim name.- See Also:
- Constant Field Values
-
PROFILE_CLAIM_NAME
public static final String PROFILE_CLAIM_NAME
The profile claim name.- See Also:
- Constant Field Values
-
PICTURE_CLAIM_NAME
public static final String PICTURE_CLAIM_NAME
The picture claim name.- See Also:
- Constant Field Values
-
WEBSITE_CLAIM_NAME
public static final String WEBSITE_CLAIM_NAME
The website claim name.- See Also:
- Constant Field Values
-
EMAIL_CLAIM_NAME
public static final String EMAIL_CLAIM_NAME
The email claim name.- See Also:
- Constant Field Values
-
EMAIL_VERIFIED_CLAIM_NAME
public static final String EMAIL_VERIFIED_CLAIM_NAME
The email verified claim name.- See Also:
- Constant Field Values
-
GENDER_CLAIM_NAME
public static final String GENDER_CLAIM_NAME
The gender claim name.- See Also:
- Constant Field Values
-
BIRTHDATE_CLAIM_NAME
public static final String BIRTHDATE_CLAIM_NAME
The birth date claim name.- See Also:
- Constant Field Values
-
ZONEINFO_CLAIM_NAME
public static final String ZONEINFO_CLAIM_NAME
The zoneinfo claim name.- See Also:
- Constant Field Values
-
LOCALE_CLAIM_NAME
public static final String LOCALE_CLAIM_NAME
The locale claim name.- See Also:
- Constant Field Values
-
PHONE_NUMBER_CLAIM_NAME
public static final String PHONE_NUMBER_CLAIM_NAME
The phone number claim name.- See Also:
- Constant Field Values
-
PHONE_NUMBER_VERIFIED_CLAIM_NAME
public static final String PHONE_NUMBER_VERIFIED_CLAIM_NAME
The phone number verified claim name.- See Also:
- Constant Field Values
-
ADDRESS_CLAIM_NAME
public static final String ADDRESS_CLAIM_NAME
The address claim name.- See Also:
- Constant Field Values
-
UPDATED_AT_CLAIM_NAME
public static final String UPDATED_AT_CLAIM_NAME
The updated at claim name.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UserInfo
public UserInfo(Subject sub)
Creates a new minimal UserInfo claims set.- Parameters:
sub
- The subject. Must not benull
.
-
UserInfo
public UserInfo(net.minidev.json.JSONObject jsonObject)
Creates a new UserInfo claims set from the specified JSON object.- Parameters:
jsonObject
- The JSON object. Must not benull
.- Throws:
IllegalArgumentException
- If the JSON object doesn't contain a subjectsub
string claim.
-
UserInfo
public UserInfo(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
Creates a new UserInfo claims set from the specified JSON Web Token (JWT) claims set.- Parameters:
jwtClaimsSet
- The JWT claims set. Must not benull
.- Throws:
IllegalArgumentException
- If the JWT claims set doesn't contain a subjectsub
string claim.
-
-
Method Detail
-
getStandardClaimNames
public static Set<String> getStandardClaimNames()
Gets the names of the standard top-level UserInfo claims.- Returns:
- The names of the standard top-level UserInfo claims (read-only set).
-
putAll
public void putAll(UserInfo other)
Puts all claims from the specified other UserInfo claims set. Aggregated and distributed claims are properly merged.- Parameters:
other
- The other UserInfo. Must have the samesubject
. Must not benull
.- Throws:
IllegalArgumentException
- If the other UserInfo claims set doesn't have an identical subject, or if the external claims source ID of the other UserInfo matches an existing source ID.
-
getSubject
public Subject getSubject()
Gets the UserInfo subject. Corresponds to thesub
claim.- Returns:
- The subject.
-
getIssuer
public Issuer getIssuer()
Gets the issuer. Corresponds to theiss
claim.- Returns:
- The issuer,
null
if not specified.
-
setIssuer
public void setIssuer(Issuer iss)
Sets the issuer. Corresponds to theiss
claim.- Parameters:
iss
- The issuer,null
if not specified.
-
getAudience
public List<Audience> getAudience()
Gets the audience. Corresponds to theaud
claim.- Returns:
- The audience list,
null
if not specified.
-
setAudience
public void setAudience(Audience aud)
Sets the audience. Corresponds to theaud
claim.- Parameters:
aud
- The audience,null
if not specified.
-
setAudience
public void setAudience(List<Audience> audList)
Sets the audience list. Corresponds to theaud
claim.- Parameters:
audList
- The audience list,null
if not specified.
-
getName
public String getName()
Gets the full name. Corresponds to thename
claim, with no language tag.- Returns:
- The full name,
null
if not specified.
-
getName
public String getName(com.nimbusds.langtag.LangTag langTag)
Gets the full name. Corresponds to thename
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The full name,
null
if not specified.
-
getNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getNameEntries()
Gets the full name entries. Correspond to thename
claim.- Returns:
- The full name entries, empty map if none.
-
setName
public void setName(String name)
Sets the full name. Corresponds to thename
claim, with no language tag.- Parameters:
name
- The full name. Ifnull
the claim will be removed.
-
setName
public void setName(String name, com.nimbusds.langtag.LangTag langTag)
Sets the full name. Corresponds to thename
claim, with an optional language tag.- Parameters:
name
- The full name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getGivenName
public String getGivenName()
Gets the given or first name. Corresponds to thegiven_name
claim, with no language tag.- Returns:
- The given or first name,
null
if not specified.
-
getGivenName
public String getGivenName(com.nimbusds.langtag.LangTag langTag)
Gets the given or first name. Corresponds to thegiven_name
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The given or first name,
null
if not specified.
-
getGivenNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getGivenNameEntries()
Gets the given or first name entries. Correspond to thegiven_name
claim.- Returns:
- The given or first name entries, empty map if none.
-
setGivenName
public void setGivenName(String givenName)
Sets the given or first name. Corresponds to thegiven_name
claim, with no language tag.- Parameters:
givenName
- The given or first name. Ifnull
the claim will be removed.
-
setGivenName
public void setGivenName(String givenName, com.nimbusds.langtag.LangTag langTag)
Sets the given or first name. Corresponds to thegiven_name
claim, with an optional language tag.- Parameters:
givenName
- The given or first full name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getFamilyName
public String getFamilyName()
Gets the surname or last name. Corresponds to thefamily_name
claim, with no language tag.- Returns:
- The surname or last name,
null
if not specified.
-
getFamilyName
public String getFamilyName(com.nimbusds.langtag.LangTag langTag)
Gets the surname or last name. Corresponds to thefamily_name
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The surname or last name,
null
if not specified.
-
getFamilyNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getFamilyNameEntries()
Gets the surname or last name entries. Correspond to thefamily_name
claim.- Returns:
- The surname or last name entries, empty map if none.
-
setFamilyName
public void setFamilyName(String familyName)
Sets the surname or last name. Corresponds to thefamily_name
claim, with no language tag.- Parameters:
familyName
- The surname or last name. Ifnull
the claim will be removed.
-
setFamilyName
public void setFamilyName(String familyName, com.nimbusds.langtag.LangTag langTag)
Sets the surname or last name. Corresponds to thefamily_name
claim, with an optional language tag.- Parameters:
familyName
- The surname or last name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getMiddleName
public String getMiddleName()
Gets the middle name. Corresponds to themiddle_name
claim, with no language tag.- Returns:
- The middle name,
null
if not specified.
-
getMiddleName
public String getMiddleName(com.nimbusds.langtag.LangTag langTag)
Gets the middle name. Corresponds to themiddle_name
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The middle name,
null
if not specified.
-
getMiddleNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getMiddleNameEntries()
Gets the middle name entries. Correspond to themiddle_name
claim.- Returns:
- The middle name entries, empty map if none.
-
setMiddleName
public void setMiddleName(String middleName)
Sets the middle name. Corresponds to themiddle_name
claim, with no language tag.- Parameters:
middleName
- The middle name. Ifnull
the claim will be removed.
-
setMiddleName
public void setMiddleName(String middleName, com.nimbusds.langtag.LangTag langTag)
Sets the middle name. Corresponds to themiddle_name
claim, with an optional language tag.- Parameters:
middleName
- The middle name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getNickname
public String getNickname()
Gets the casual name. Corresponds to thenickname
claim, with no language tag.- Returns:
- The casual name,
null
if not specified.
-
getNickname
public String getNickname(com.nimbusds.langtag.LangTag langTag)
Gets the casual name. Corresponds to thenickname
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The casual name,
null
if not specified.
-
getNicknameEntries
public Map<com.nimbusds.langtag.LangTag,String> getNicknameEntries()
Gets the casual name entries. Correspond to thenickname
claim.- Returns:
- The casual name entries, empty map if none.
-
setNickname
public void setNickname(String nickname)
Sets the casual name. Corresponds to thenickname
claim, with no language tag.- Parameters:
nickname
- The casual name. Ifnull
the claim will be removed.
-
setNickname
public void setNickname(String nickname, com.nimbusds.langtag.LangTag langTag)
Sets the casual name. Corresponds to thenickname
claim, with an optional language tag.- Parameters:
nickname
- The casual name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getPreferredUsername
public String getPreferredUsername()
Gets the preferred username. Corresponds to thepreferred_username
claim.- Returns:
- The preferred username,
null
if not specified.
-
setPreferredUsername
public void setPreferredUsername(String preferredUsername)
Sets the preferred username. Corresponds to thepreferred_username
claim.- Parameters:
preferredUsername
- The preferred username. Ifnull
the claim will be removed.
-
getProfile
public URI getProfile()
Gets the profile page. Corresponds to theprofile
claim.- Returns:
- The profile page URI,
null
if not specified.
-
setProfile
public void setProfile(URI profile)
Sets the profile page. Corresponds to theprofile
claim.- Parameters:
profile
- The profile page URI. Ifnull
the claim will be removed.
-
getPicture
public URI getPicture()
Gets the picture. Corresponds to thepicture
claim.- Returns:
- The picture URI,
null
if not specified.
-
setPicture
public void setPicture(URI picture)
Sets the picture. Corresponds to thepicture
claim.- Parameters:
picture
- The picture URI. Ifnull
the claim will be removed.
-
getWebsite
public URI getWebsite()
Gets the web page or blog. Corresponds to thewebsite
claim.- Returns:
- The web page or blog URI,
null
if not specified.
-
setWebsite
public void setWebsite(URI website)
Sets the web page or blog. Corresponds to thewebsite
claim.- Parameters:
website
- The web page or blog URI. Ifnull
the claim will be removed.
-
getEmail
@Deprecated public javax.mail.internet.InternetAddress getEmail()
Deprecated.Gets the preferred email address. Corresponds to theemail
claim.Use
getEmailAddress()
instead.- Returns:
- The preferred email address,
null
if not specified.
-
setEmail
@Deprecated public void setEmail(javax.mail.internet.InternetAddress email)
Deprecated.Sets the preferred email address. Corresponds to theemail
claim.Use
setEmailAddress(String)
instead.- Parameters:
email
- The preferred email address. Ifnull
the claim will be removed.
-
getEmailAddress
public String getEmailAddress()
Gets the preferred email address. Corresponds to theemail
claim.- Returns:
- The preferred email address,
null
if not specified.
-
setEmailAddress
public void setEmailAddress(String email)
Sets the preferred email address. Corresponds to theemail
claim.- Parameters:
email
- The preferred email address. Ifnull
the claim will be removed.
-
getEmailVerified
public Boolean getEmailVerified()
Gets the email verification status. Corresponds to theemail_verified
claim.- Returns:
- The email verification status,
null
if not specified.
-
setEmailVerified
public void setEmailVerified(Boolean emailVerified)
Sets the email verification status. Corresponds to theemail_verified
claim.- Parameters:
emailVerified
- The email verification status. Ifnull
the claim will be removed.
-
getGender
public Gender getGender()
Gets the gender. Corresponds to thegender
claim.- Returns:
- The gender,
null
if not specified.
-
setGender
public void setGender(Gender gender)
Sets the gender. Corresponds to thegender
claim.- Parameters:
gender
- The gender. Ifnull
the claim will be removed.
-
getBirthdate
public String getBirthdate()
Gets the date of birth. Corresponds to thebirthdate
claim.- Returns:
- The date of birth,
null
if not specified.
-
setBirthdate
public void setBirthdate(String birthdate)
Sets the date of birth. Corresponds to thebirthdate
claim.- Parameters:
birthdate
- The date of birth. Ifnull
the claim will be removed.
-
getZoneinfo
public String getZoneinfo()
Gets the zoneinfo. Corresponds to thezoneinfo
claim.- Returns:
- The zoneinfo,
null
if not specified.
-
setZoneinfo
public void setZoneinfo(String zoneinfo)
Sets the zoneinfo. Corresponds to thezoneinfo
claim.- Parameters:
zoneinfo
- The zoneinfo. Ifnull
the claim will be removed.
-
getLocale
public String getLocale()
Gets the locale. Corresponds to thelocale
claim.- Returns:
- The locale,
null
if not specified.
-
setLocale
public void setLocale(String locale)
Sets the locale. Corresponds to thelocale
claim.- Parameters:
locale
- The locale. Ifnull
the claim will be removed.
-
getPhoneNumber
public String getPhoneNumber()
Gets the preferred telephone number. Corresponds to thephone_number
claim.- Returns:
- The preferred telephone number,
null
if not specified.
-
setPhoneNumber
public void setPhoneNumber(String phoneNumber)
Sets the preferred telephone number. Corresponds to thephone_number
claim.- Parameters:
phoneNumber
- The preferred telephone number. Ifnull
the claim will be removed.
-
getPhoneNumberVerified
public Boolean getPhoneNumberVerified()
Gets the phone number verification status. Corresponds to thephone_number_verified
claim.- Returns:
- The phone number verification status,
null
if not specified.
-
setPhoneNumberVerified
public void setPhoneNumberVerified(Boolean phoneNumberVerified)
Sets the email verification status. Corresponds to thephone_number_verified
claim.- Parameters:
phoneNumberVerified
- The phone number verification status. Ifnull
the claim will be removed.
-
getAddress
public Address getAddress()
Gets the preferred address. Corresponds to theaddress
claim, with no language tag.- Returns:
- The preferred address,
null
if not specified.
-
getAddress
public Address getAddress(com.nimbusds.langtag.LangTag langTag)
Gets the preferred address. Corresponds to theaddress
claim, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The preferred address,
null
if not specified.
-
getAddressEntries
public Map<com.nimbusds.langtag.LangTag,Address> getAddressEntries()
Gets the preferred address entries. Correspond to theaddress
claim.- Returns:
- The preferred address entries, empty map if none.
-
setAddress
public void setAddress(Address address)
Sets the preferred address. Corresponds to theaddress
claim, with no language tag.- Parameters:
address
- The preferred address. Ifnull
the claim will be removed.
-
setAddress
public void setAddress(Address address, com.nimbusds.langtag.LangTag langTag)
Sets the preferred address. Corresponds to theaddress
claim, with an optional language tag.- Parameters:
address
- The preferred address. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getUpdatedTime
public Date getUpdatedTime()
Gets the time the end-user information was last updated. Corresponds to theupdated_at
claim.- Returns:
- The time the end-user information was last updated,
null
if not specified.
-
setUpdatedTime
public void setUpdatedTime(Date updatedTime)
Sets the time the end-user information was last updated. Corresponds to theupdated_at
claim.- Parameters:
updatedTime
- The time the end-user information was last updated. Ifnull
the claim will be removed.
-
addAggregatedClaims
public void addAggregatedClaims(AggregatedClaims aggregatedClaims)
Adds the specified aggregated claims provided by an external claims source.- Parameters:
aggregatedClaims
- The aggregated claims instance, ifnull
nothing will be added.
-
getAggregatedClaims
public Set<AggregatedClaims> getAggregatedClaims()
Gets the included aggregated claims provided by each external claims source.- Returns:
- The aggregated claims,
null
if none are found.
-
addDistributedClaims
public void addDistributedClaims(DistributedClaims distributedClaims)
Adds the specified distributed claims from an external claims source.- Parameters:
distributedClaims
- The distributed claims instance, ifnull
nothing will be added.
-
getDistributedClaims
public Set<DistributedClaims> getDistributedClaims()
Gets the included distributed claims provided by each external claims source.- Returns:
- The distributed claims,
null
if none are found.
-
parse
public static UserInfo parse(String json) throws ParseException
Parses a UserInfo claims set from the specified JSON object string.- Parameters:
json
- The JSON object string to parse. Must not benull
.- Returns:
- The UserInfo claims set.
- Throws:
ParseException
- If parsing failed.
-
-