Class PersonClaims
- java.lang.Object
-
- com.nimbusds.openid.connect.sdk.claims.ClaimsSet
-
- com.nimbusds.openid.connect.sdk.claims.PersonClaims
-
- All Implemented Interfaces:
net.minidev.json.JSONAware
- Direct Known Subclasses:
UserInfo
public class PersonClaims extends ClaimsSet
Person-specific claims set, intended to provide common getters and setters forOpenID Connect UserInfo
andOpenID Connect Identity Assurance verified claims
.Related specifications:
- OpenID Connect Core 1.0, sections 5.1 and 5.6.
- OpenID Connect for Identity Assurance 1.0, section 4.1.
-
-
Field Summary
Fields Modifier and Type Field Description static String
ADDRESS_CLAIM_NAME
The address claim name.static String
ALSO_KNOWN_AS
The also known as claim name (OpenID Connect for Identity Assurance 1.0).static String
BIRTH_FAMILY_NAME_CLAIM_NAME
The birth family name claim name (OpenID Connect for Identity Assurance 1.0).static String
BIRTH_GIVEN_NAME_CLAIM_NAME
The birth given name claim name (OpenID Connect for Identity Assurance 1.0).static String
BIRTH_MIDDLE_NAME_CLAIM_NAME
The birth middle name claim name (OpenID Connect for Identity Assurance 1.0).static String
BIRTHDATE_CLAIM_NAME
The birth date claim name.static String
BIRTHPLACE_CLAIM_NAME
Deprecated.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
MSISDN_CLAIM_NAME
The MSISDN claim name (OpenID Connect for Identity Assurance 1.0).static String
NAME_CLAIM_NAME
The name claim name.static String
NATIONALITIES_CLAIM_NAME
The nationalities claim name (OpenID Connect for Identity Assurance 1.0).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
PLACE_OF_BIRTH_CLAIM_NAME
The place of birth claim name (OpenID Connect for Identity Assurance 1.0).static String
PREFERRED_USERNAME_CLAIM_NAME
The preferred username claim name.static String
PROFILE_CLAIM_NAME
The profile claim name.static String
SALUTATION_CLAIM_NAME
The salutation claim name (OpenID Connect for Identity Assurance 1.0).static String
TITLE_CLAIM_NAME
The title claim name (OpenID Connect for Identity Assurance 1.0).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.-
Fields inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet
AUD_CLAIM_NAME, claims, ISS_CLAIM_NAME
-
-
Constructor Summary
Constructors Constructor Description PersonClaims()
Creates a new empty person-specific claims set.PersonClaims(net.minidev.json.JSONObject jsonObject)
Creates a new person-specific claims set from the specified JSON object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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
getAlsoKnownAs()
Gets the also known as.String
getAlsoKnownAs(com.nimbusds.langtag.LangTag langTag)
Gets the also known as.Map<com.nimbusds.langtag.LangTag,String>
getAlsoKnownAsEntries()
Gets the also known as entries.String
getBirthdate()
Gets the date of birth.String
getBirthFamilyName()
Gets the birth family name.String
getBirthFamilyName(com.nimbusds.langtag.LangTag langTag)
Gets the birth family name.Map<com.nimbusds.langtag.LangTag,String>
getBirthFamilyNameEntries()
Gets the birth family name entries.String
getBirthGivenName()
Gets the birth given name.String
getBirthGivenName(com.nimbusds.langtag.LangTag langTag)
Gets the birth given name.Map<com.nimbusds.langtag.LangTag,String>
getBirthGivenNameEntries()
Gets the birth given name entries.String
getBirthMiddleName()
Gets the birth middle name.String
getBirthMiddleName(com.nimbusds.langtag.LangTag langTag)
Gets the birth middle name.Map<com.nimbusds.langtag.LangTag,String>
getBirthMiddleNameEntries()
Gets the birth middle name entries.Birthplace
getBirthplace()
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.MSISDN
getMSISDN()
Gets the mobile subscriber ISDN number.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.List<CountryCode>
getNationalities()
Gets the user's nationalities.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.Birthplace
getPlaceOfBirth()
Gets the birthplace.String
getPreferredUsername()
Gets the preferred username.URI
getProfile()
Gets the profile page.String
getSalutation()
Gets the salutation.String
getSalutation(com.nimbusds.langtag.LangTag langTag)
Gets the salutation.Map<com.nimbusds.langtag.LangTag,String>
getSalutationEntries()
Gets the salutation entries.static Set<String>
getStandardClaimNames()
Gets the names of the standard top-level UserInfo claims.String
getTitle()
Gets the title.String
getTitle(com.nimbusds.langtag.LangTag langTag)
Gets the title.Map<com.nimbusds.langtag.LangTag,String>
getTitleEntries()
Gets the title entries.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.void
setAddress(Address address)
Sets the preferred address.void
setAddress(Address address, com.nimbusds.langtag.LangTag langTag)
Sets the preferred address.void
setAlsoKnownAs(String alsoKnownAs)
Sets the also known as.void
setAlsoKnownAs(String alsoKnownAs, com.nimbusds.langtag.LangTag langTag)
Sets the also known as.void
setBirthdate(String birthdate)
Sets the date of birth.void
setBirthFamilyName(String birthFamilyName)
Sets the birth family name.void
setBirthFamilyName(String birthFamilyName, com.nimbusds.langtag.LangTag langTag)
Sets the birth family name.void
setBirthGivenName(String birthGivenName)
Sets the birth given name.void
setBirthGivenName(String birthGivenName, com.nimbusds.langtag.LangTag langTag)
Sets the birth given name.void
setBirthMiddleName(String birthMiddleName)
Sets the birth middle name.void
setBirthMiddleName(String birthMiddleName, com.nimbusds.langtag.LangTag langTag)
Sets the birth middle name.void
setBirthplace(Birthplace birthplace)
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
setMSISDN(MSISDN msisdn)
Sets the mobile subscriber ISDN number.void
setName(String name)
Sets the full name.void
setName(String name, com.nimbusds.langtag.LangTag langTag)
Sets the full name.void
setNationalities(List<CountryCode> nationalities)
Sets the user's nationalities.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
setPlaceOfBirth(Birthplace birthplace)
Sets the birthplace.void
setPreferredUsername(String preferredUsername)
Sets the preferred username.void
setProfile(URI profile)
Sets the profile page.void
setSalutation(String salutation)
Sets the salutation.void
setSalutation(String salutation, com.nimbusds.langtag.LangTag langTag)
Sets the salutation.void
setTitle(String title)
Sets the title.void
setTitle(String title, com.nimbusds.langtag.LangTag langTag)
Sets the title.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
equals, getAudience, getBooleanClaim, getClaim, getClaim, getDateClaim, getIssuer, getJSONObjectClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, hashCode, putAll, putAll, setAudience, setAudience, setClaim, setClaim, setDateClaim, setIssuer, setURIClaim, setURLClaim, toJSONObject, toJSONString, toJWTClaimsSet
-
-
-
-
Field Detail
-
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
-
BIRTHPLACE_CLAIM_NAME
@Deprecated public static final String BIRTHPLACE_CLAIM_NAME
Deprecated.The birthplace claim name (OpenID Connect for Identity Assurance 1.0). Alternative forPLACE_OF_BIRTH_CLAIM_NAME
.- See Also:
- Constant Field Values
-
PLACE_OF_BIRTH_CLAIM_NAME
public static final String PLACE_OF_BIRTH_CLAIM_NAME
The place of birth claim name (OpenID Connect for Identity Assurance 1.0). Alternative forBIRTHPLACE_CLAIM_NAME
.- See Also:
- Constant Field Values
-
NATIONALITIES_CLAIM_NAME
public static final String NATIONALITIES_CLAIM_NAME
The nationalities claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
BIRTH_FAMILY_NAME_CLAIM_NAME
public static final String BIRTH_FAMILY_NAME_CLAIM_NAME
The birth family name claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
BIRTH_GIVEN_NAME_CLAIM_NAME
public static final String BIRTH_GIVEN_NAME_CLAIM_NAME
The birth given name claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
BIRTH_MIDDLE_NAME_CLAIM_NAME
public static final String BIRTH_MIDDLE_NAME_CLAIM_NAME
The birth middle name claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
SALUTATION_CLAIM_NAME
public static final String SALUTATION_CLAIM_NAME
The salutation claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
TITLE_CLAIM_NAME
public static final String TITLE_CLAIM_NAME
The title claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
MSISDN_CLAIM_NAME
public static final String MSISDN_CLAIM_NAME
The MSISDN claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
ALSO_KNOWN_AS
public static final String ALSO_KNOWN_AS
The also known as claim name (OpenID Connect for Identity Assurance 1.0).- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PersonClaims
public PersonClaims()
Creates a new empty person-specific claims set.
-
PersonClaims
public PersonClaims(net.minidev.json.JSONObject jsonObject)
Creates a new person-specific claims set from the specified JSON object.- Parameters:
jsonObject
- The JSON object. Must not benull
.
-
-
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).
-
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.
-
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.
-
getBirthplace
@Deprecated public Birthplace getBirthplace()
Deprecated.Gets the birthplace. Corresponds to thebirthplace
claim.- Returns:
- The birthplace,
null
if not specified. - See Also:
getPlaceOfBirth()
-
setBirthplace
@Deprecated public void setBirthplace(Birthplace birthplace)
Deprecated.Sets the birthplace. Corresponds to thebirthplace
claim.- Parameters:
birthplace
- The birthplace,null
if not specified.- See Also:
setPlaceOfBirth(Birthplace)
-
getPlaceOfBirth
public Birthplace getPlaceOfBirth()
Gets the birthplace. Corresponds to theplace_of_birth
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The birthplace,
null
if not specified.
-
setPlaceOfBirth
public void setPlaceOfBirth(Birthplace birthplace)
Sets the birthplace. Corresponds to theplace_of_birth
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
birthplace
- The birthplace,null
if not specified.
-
getNationalities
public List<CountryCode> getNationalities()
Gets the user's nationalities. Corresponds to thenationalities
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The nationalities,
null
if not specified or parsing failed.
-
setNationalities
public void setNationalities(List<CountryCode> nationalities)
Sets the user's nationalities. Corresponds to thenationalities
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
nationalities
- The nationalities,null
if not specified.
-
getBirthFamilyName
public String getBirthFamilyName()
Gets the birth family name. Corresponds to thebirth_family_name
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The birth family name,
null
if not specified.
-
getBirthFamilyName
public String getBirthFamilyName(com.nimbusds.langtag.LangTag langTag)
Gets the birth family name. Corresponds to thebirth_family_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The birth family name,
null
if not specified.
-
getBirthFamilyNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getBirthFamilyNameEntries()
Gets the birth family name entries. Correspond to thebirth_family_name
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The birth family name entries, empty map if none.
-
setBirthFamilyName
public void setBirthFamilyName(String birthFamilyName)
Sets the birth family name. Corresponds to thebirth_family_name
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Parameters:
birthFamilyName
- The birth family name,null
if not specified.
-
setBirthFamilyName
public void setBirthFamilyName(String birthFamilyName, com.nimbusds.langtag.LangTag langTag)
Sets the birth family name. Corresponds to thebirth_family_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
birthFamilyName
- The birth family name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getBirthGivenName
public String getBirthGivenName()
Gets the birth given name. Corresponds to thebirth_given_name
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The birth given name,
null
if not specified.
-
getBirthGivenName
public String getBirthGivenName(com.nimbusds.langtag.LangTag langTag)
Gets the birth given name. Corresponds to thebirth_given_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The birth given name,
null
if not specified.
-
getBirthGivenNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getBirthGivenNameEntries()
Gets the birth given name entries. Correspond to thebirth_given_name
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The birth given name entries, empty map if none.
-
setBirthGivenName
public void setBirthGivenName(String birthGivenName)
Sets the birth given name. Corresponds to thebirth_given_name
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
birthGivenName
- The birth given name,null
if not specified.
-
setBirthGivenName
public void setBirthGivenName(String birthGivenName, com.nimbusds.langtag.LangTag langTag)
Sets the birth given name. Corresponds to thebirth_given_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
birthGivenName
- The birth given name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getBirthMiddleName
public String getBirthMiddleName()
Gets the birth middle name. Corresponds to thebirth_middle_name
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The birth middle name,
null
if not specified.
-
getBirthMiddleName
public String getBirthMiddleName(com.nimbusds.langtag.LangTag langTag)
Gets the birth middle name. Corresponds to thebirth_middle_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The birth middle name,
null
if not specified.
-
getBirthMiddleNameEntries
public Map<com.nimbusds.langtag.LangTag,String> getBirthMiddleNameEntries()
Gets the birth middle name entries. Correspond to thebirth_middle_name
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The birth middle name entries, empty map if none.
-
setBirthMiddleName
public void setBirthMiddleName(String birthMiddleName)
Sets the birth middle name. Corresponds to thebirth_middle_name
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
birthMiddleName
- The birth middle name,null
if not specified.
-
setBirthMiddleName
public void setBirthMiddleName(String birthMiddleName, com.nimbusds.langtag.LangTag langTag)
Sets the birth middle name. Corresponds to thebirth_middle_name
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
birthMiddleName
- The birth middle name. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getSalutation
public String getSalutation()
Gets the salutation. Corresponds to thesalutation
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The salutation,
null
if not specified.
-
getSalutation
public String getSalutation(com.nimbusds.langtag.LangTag langTag)
Gets the salutation. Corresponds to thesalutation
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The salutation,
null
if not specified.
-
getSalutationEntries
public Map<com.nimbusds.langtag.LangTag,String> getSalutationEntries()
Gets the salutation entries. Correspond to thesalutation
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The salutation entries, empty map if none.
-
setSalutation
public void setSalutation(String salutation)
Sets the salutation. Corresponds to thesalutation
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
salutation
- The salutation,null
if not specified.
-
setSalutation
public void setSalutation(String salutation, com.nimbusds.langtag.LangTag langTag)
Sets the salutation. Corresponds to thesalutation
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
salutation
- The salutation. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getTitle
public String getTitle()
Gets the title. Corresponds to thetitle
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The salutation,
null
if not specified.
-
getTitle
public String getTitle(com.nimbusds.langtag.LangTag langTag)
Gets the title. Corresponds to thetitle
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The title,
null
if not specified.
-
getTitleEntries
public Map<com.nimbusds.langtag.LangTag,String> getTitleEntries()
Gets the title entries. Correspond to thetitle
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The title entries, empty map if none.
-
setTitle
public void setTitle(String title)
Sets the title. Corresponds to thetitle
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
title
- The title,null
if not specified.
-
setTitle
public void setTitle(String title, com.nimbusds.langtag.LangTag langTag)
Sets the title. Corresponds to thetitle
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
title
- The title. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
getMSISDN
public MSISDN getMSISDN()
Gets the mobile subscriber ISDN number. Corresponds to themsisdn
claim.- Returns:
- The mobile subscriber ISDN number,
null
if not specified.
-
setMSISDN
public void setMSISDN(MSISDN msisdn)
Sets the mobile subscriber ISDN number. Corresponds to themsisdn
claim.- Parameters:
msisdn
- The mobile subscriber ISDN number. Ifnull
the claim will be removed.
-
getAlsoKnownAs
public String getAlsoKnownAs()
Gets the also known as. Corresponds to thealso_known_as
claim from OpenID Connect for Identity Assurance 1.0, with no language tag.- Returns:
- The also_known_as,
null
if not specified.
-
getAlsoKnownAs
public String getAlsoKnownAs(com.nimbusds.langtag.LangTag langTag)
Gets the also known as. Corresponds to thealso_known_as
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
langTag
- The language tag of the entry,null
to get the non-tagged entry.- Returns:
- The also known as,
null
if not specified.
-
getAlsoKnownAsEntries
public Map<com.nimbusds.langtag.LangTag,String> getAlsoKnownAsEntries()
Gets the also known as entries. Correspond to thealso_known_as
claim from OpenID Connect for Identity Assurance 1.0.- Returns:
- The also known as entries, empty map if none.
-
setAlsoKnownAs
public void setAlsoKnownAs(String alsoKnownAs)
Sets the also known as. Corresponds to thealso_known_as
claim from OpenID Connect for Identity Assurance 1.0.- Parameters:
alsoKnownAs
- The also known as,null
if not specified.
-
setAlsoKnownAs
public void setAlsoKnownAs(String alsoKnownAs, com.nimbusds.langtag.LangTag langTag)
Sets the also known as. Corresponds to thealso_known_as
claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.- Parameters:
alsoKnownAs
- The also known as. Ifnull
the claim will be removed.langTag
- The language tag,null
if not specified.
-
-