public class UserInfo extends ClaimsSet
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:
Modifier and Type | Field and Description |
---|---|
static String |
ADDRESS_CLAIM_NAME
The address 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 |
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 and Description |
---|
UserInfo(net.minidev.json.JSONObject jsonObject)
Creates a new UserInfo claims set from the specified JSON object.
|
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.
|
Modifier and Type | Method and Description |
---|---|
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.
|
String |
getBirthdate()
Gets the date of birth.
|
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.
|
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 |
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 |
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.
|
getBooleanClaim, getClaim, getClaim, getDateClaim, getEmailClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, putAll, putAll, setClaim, setClaim, setDateClaim, setEmailClaim, setURIClaim, setURLClaim, toJSONObject, toJWTClaimsSet
public static final String SUB_CLAIM_NAME
public static final String NAME_CLAIM_NAME
public static final String GIVEN_NAME_CLAIM_NAME
public static final String FAMILY_NAME_CLAIM_NAME
public static final String MIDDLE_NAME_CLAIM_NAME
public static final String NICKNAME_CLAIM_NAME
public static final String PREFERRED_USERNAME_CLAIM_NAME
public static final String PROFILE_CLAIM_NAME
public static final String PICTURE_CLAIM_NAME
public static final String WEBSITE_CLAIM_NAME
public static final String EMAIL_CLAIM_NAME
public static final String EMAIL_VERIFIED_CLAIM_NAME
public static final String GENDER_CLAIM_NAME
public static final String BIRTHDATE_CLAIM_NAME
public static final String ZONEINFO_CLAIM_NAME
public static final String LOCALE_CLAIM_NAME
public static final String PHONE_NUMBER_CLAIM_NAME
public static final String PHONE_NUMBER_VERIFIED_CLAIM_NAME
public static final String ADDRESS_CLAIM_NAME
public static final String UPDATED_AT_CLAIM_NAME
public UserInfo(Subject sub)
sub
- The subject. Must not be null
.public UserInfo(net.minidev.json.JSONObject jsonObject)
jsonObject
- The JSON object. Must not be null
.IllegalArgumentException
- If the JSON object doesn't contain
a subject sub
string claim.public UserInfo(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
jwtClaimsSet
- The JWT claims set. Must not be null
.IllegalArgumentException
- If the JWT claims set doesn't
contain a subject sub
string claim.public static Set<String> getStandardClaimNames()
public void putAll(UserInfo other)
other
- The other UserInfo. Must have the same
subject
. Must not be null
.IllegalArgumentException
- If the other UserInfo claims set
doesn't have an identical subject.public Subject getSubject()
sub
claim.public String getName()
name
claim, with no
language tag.null
if not specified.public String getName(com.nimbusds.langtag.LangTag langTag)
name
claim, with an
optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getNameEntries()
name
claim.public void setName(String name)
name
claim, with no
language tag.name
- The full name. If null
the claim will be
removed.public void setName(String name, com.nimbusds.langtag.LangTag langTag)
name
claim, with an
optional language tag.name
- The full name. If null
the claim will be
removed.langTag
- The language tag, null
if not specified.public String getGivenName()
given_name
claim, with no language tag.null
if not specified.public String getGivenName(com.nimbusds.langtag.LangTag langTag)
given_name
claim, with an optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getGivenNameEntries()
given_name
claim.public void setGivenName(String givenName)
given_name
claim, with no language tag.givenName
- The given or first name. If null
the claim
will be removed.public void setGivenName(String givenName, com.nimbusds.langtag.LangTag langTag)
given_name
claim, with an optional language tag.givenName
- The given or first full name. If null
the
claim will be removed.langTag
- The language tag, null
if not specified.public String getFamilyName()
family_name
claim, with no language tag.null
if not specified.public String getFamilyName(com.nimbusds.langtag.LangTag langTag)
family_name
claim, with an optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getFamilyNameEntries()
public void setFamilyName(String familyName)
family_name
claim, with no language tag.familyName
- The surname or last name. If null
the
claim will be removed.public void setFamilyName(String familyName, com.nimbusds.langtag.LangTag langTag)
family_name
claim, with an optional language tag.familyName
- The surname or last name. If null
the
claim will be removed.langTag
- The language tag, null
if not specified.public String getMiddleName()
middle_name
claim,
with no language tag.null
if not specified.public String getMiddleName(com.nimbusds.langtag.LangTag langTag)
middle_name
claim,
with an optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getMiddleNameEntries()
middle_name
claim.public void setMiddleName(String middleName)
middle_name
claim,
with no language tag.middleName
- The middle name. If null
the claim will be
removed.public void setMiddleName(String middleName, com.nimbusds.langtag.LangTag langTag)
middle_name
claim,
with an optional language tag.middleName
- The middle name. If null
the claim will be
removed.langTag
- The language tag, null
if not specified.public String getNickname()
nickname
claim,
with no language tag.null
if not specified.public String getNickname(com.nimbusds.langtag.LangTag langTag)
nickname
claim,
with an optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,String> getNicknameEntries()
nickname
claim.public void setNickname(String nickname)
nickname
claim,
with no language tag.nickname
- The casual name. If null
the claim will be
removed.public void setNickname(String nickname, com.nimbusds.langtag.LangTag langTag)
nickname
claim,
with an optional language tag.nickname
- The casual name. If null
the claim will be
removed.langTag
- The language tag, null
if not specified.public String getPreferredUsername()
preferred_username
claim.null
if not specified.public void setPreferredUsername(String preferredUsername)
preferred_username
claim.preferredUsername
- The preferred username. If null
the
claim will be removed.public URI getProfile()
profile
claim.null
if not specified.public void setProfile(URI profile)
profile
claim.profile
- The profile page URI. If null
the claim will
be removed.public URI getPicture()
picture
claim.null
if not specified.public void setPicture(URI picture)
picture
claim.picture
- The picture URI. If null
the claim will be
removed.public URI getWebsite()
website
claim.null
if not specified.public void setWebsite(URI website)
website
claim.website
- The web page or blog URI. If null
the claim
will be removed.@Deprecated public javax.mail.internet.InternetAddress getEmail()
email
claim.
Use getEmailAddress()
instead.
null
if not specified.@Deprecated public void setEmail(javax.mail.internet.InternetAddress email)
email
claim.
Use setEmailAddress(String)
instead.
email
- The preferred email address. If null
the claim
will be removed.public String getEmailAddress()
email
claim.null
if not specified.public void setEmailAddress(String email)
email
claim.email
- The preferred email address. If null
the claim
will be removed.public Boolean getEmailVerified()
email_verified
claim.null
if not
specified.public void setEmailVerified(Boolean emailVerified)
email_verified
claim.emailVerified
- The email verification status. If null
the claim will be removed.public Gender getGender()
gender
claim.null
if not specified.public void setGender(Gender gender)
gender
claim.gender
- The gender. If null
the claim will be removed.public String getBirthdate()
birthdate
claim.null
if not specified.public void setBirthdate(String birthdate)
birthdate
claim.birthdate
- The date of birth. If null
the claim will
be removed.public String getZoneinfo()
zoneinfo
claim.null
if not specified.public void setZoneinfo(String zoneinfo)
zoneinfo
claim.zoneinfo
- The zoneinfo. If null
the claim will be
removed.public String getLocale()
locale
claim.null
if not specified.public void setLocale(String locale)
locale
claim.locale
- The locale. If null
the claim will be
removed.public String getPhoneNumber()
phone_number
claim.null
if not
specified.public void setPhoneNumber(String phoneNumber)
phone_number
claim.phoneNumber
- The preferred telephone number. If null
the claim will be removed.public Boolean getPhoneNumberVerified()
phone_number_verified
claim.null
if not
specified.public void setPhoneNumberVerified(Boolean phoneNumberVerified)
phone_number_verified
claim.phoneNumberVerified
- The phone number verification status. If
null
the claim will be removed.public Address getAddress()
address
claim, with no language tag.null
if not specified.public Address getAddress(com.nimbusds.langtag.LangTag langTag)
address
claim, with an optional language tag.langTag
- The language tag of the entry, null
to get
the non-tagged entry.null
if not specified.public Map<com.nimbusds.langtag.LangTag,Address> getAddressEntries()
address
claim.public void setAddress(Address address)
address
claim, with no language tag.address
- The preferred address. If null
the claim will
be removed.public void setAddress(Address address, com.nimbusds.langtag.LangTag langTag)
address
claim, with an optional language tag.address
- The preferred address. If null
the claim
will be removed.langTag
- The language tag, null
if not specified.public Date getUpdatedTime()
updated_at
claim.null
if not specified.public void setUpdatedTime(Date updatedTime)
updated_at
claim.updatedTime
- The time the end-user information was last
updated. If null
the claim will be
removed.public static UserInfo parse(String json) throws ParseException
json
- The JSON object string to parse. Must not be
null
.ParseException
- If parsing failed.Copyright © 2016 Connect2id Ltd.. All rights reserved.