Package com.nimbusds.openid.connect.sdk.claims

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 for OpenID Connect UserInfo and OpenID 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 Details

  • Constructor Details

    • 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 be null.

  • Method Details

    • 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 the name 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 the name 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 the name claim.
      Returns:
      The full name entries, empty map if none.

    • setName

      public void setName(String name)
      Sets the full name. Corresponds to the name claim, with no language tag.
      Parameters:
      name - The full name. If null the claim will be removed.

    • setName

      public void setName(String name, com.nimbusds.langtag.LangTag langTag)
      Sets the full name. Corresponds to the name claim, with an optional language tag.
      Parameters:
      name - The full name. If null 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 the given_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 the given_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 the given_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 the given_name claim, with no language tag.
      Parameters:
      givenName - The given or first name. If null the claim will be removed.

    • setGivenName

      public void setGivenName(String givenName, com.nimbusds.langtag.LangTag langTag)
      Sets the given or first name. Corresponds to the given_name claim, with an optional language tag.
      Parameters:
      givenName - The given or first full name. If null 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 the family_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 the family_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 the family_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 the family_name claim, with no language tag.
      Parameters:
      familyName - The surname or last name. If null the claim will be removed.

    • setFamilyName

      public void setFamilyName(String familyName, com.nimbusds.langtag.LangTag langTag)
      Sets the surname or last name. Corresponds to the family_name claim, with an optional language tag.
      Parameters:
      familyName - The surname or last name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getMiddleName

      public String getMiddleName()
      Gets the middle name. Corresponds to the middle_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 the middle_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 the middle_name claim.
      Returns:
      The middle name entries, empty map if none.

    • setMiddleName

      public void setMiddleName(String middleName)
      Sets the middle name. Corresponds to the middle_name claim, with no language tag.
      Parameters:
      middleName - The middle name. If null the claim will be removed.

    • setMiddleName

      public void setMiddleName(String middleName, com.nimbusds.langtag.LangTag langTag)
      Sets the middle name. Corresponds to the middle_name claim, with an optional language tag.
      Parameters:
      middleName - The middle name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getNickname

      public String getNickname()
      Gets the casual name. Corresponds to the nickname 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 the nickname 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 the nickname claim.
      Returns:
      The casual name entries, empty map if none.

    • setNickname

      public void setNickname(String nickname)
      Sets the casual name. Corresponds to the nickname claim, with no language tag.
      Parameters:
      nickname - The casual name. If null the claim will be removed.

    • setNickname

      public void setNickname(String nickname, com.nimbusds.langtag.LangTag langTag)
      Sets the casual name. Corresponds to the nickname claim, with an optional language tag.
      Parameters:
      nickname - The casual name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getPreferredUsername

      public String getPreferredUsername()
      Gets the preferred username. Corresponds to the preferred_username claim.
      Returns:
      The preferred username, null if not specified.

    • setPreferredUsername

      public void setPreferredUsername(String preferredUsername)
      Sets the preferred username. Corresponds to the preferred_username claim.
      Parameters:
      preferredUsername - The preferred username. If null the claim will be removed.

    • getProfile

      public URI getProfile()
      Gets the profile page. Corresponds to the profile claim.
      Returns:
      The profile page URI, null if not specified.

    • setProfile

      public void setProfile(URI profile)
      Sets the profile page. Corresponds to the profile claim.
      Parameters:
      profile - The profile page URI. If null the claim will be removed.

    • getPicture

      public URI getPicture()
      Gets the picture. Corresponds to the picture claim.
      Returns:
      The picture URI, null if not specified.

    • setPicture

      public void setPicture(URI picture)
      Sets the picture. Corresponds to the picture claim.
      Parameters:
      picture - The picture URI. If null the claim will be removed.

    • getWebsite

      public URI getWebsite()
      Gets the web page or blog. Corresponds to the website 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 the website claim.
      Parameters:
      website - The web page or blog URI. If null the claim will be removed.

    • getEmailAddress

      public String getEmailAddress()
      Gets the preferred email address. Corresponds to the email claim.
      Returns:
      The preferred email address, null if not specified.

    • setEmailAddress

      public void setEmailAddress(String email)
      Sets the preferred email address. Corresponds to the email claim.
      Parameters:
      email - The preferred email address. If null the claim will be removed.

    • getEmailVerified

      public Boolean getEmailVerified()
      Gets the email verification status. Corresponds to the email_verified claim.
      Returns:
      The email verification status, null if not specified.

    • setEmailVerified

      public void setEmailVerified(Boolean emailVerified)
      Sets the email verification status. Corresponds to the email_verified claim.
      Parameters:
      emailVerified - The email verification status. If null the claim will be removed.

    • getGender

      public Gender getGender()
      Gets the gender. Corresponds to the gender claim.
      Returns:
      The gender, null if not specified.

    • setGender

      public void setGender(Gender gender)
      Sets the gender. Corresponds to the gender claim.
      Parameters:
      gender - The gender. If null the claim will be removed.

    • getBirthdate

      public String getBirthdate()
      Gets the date of birth. Corresponds to the birthdate claim.
      Returns:
      The date of birth, null if not specified.

    • setBirthdate

      public void setBirthdate(String birthdate)
      Sets the date of birth. Corresponds to the birthdate claim.
      Parameters:
      birthdate - The date of birth. If null the claim will be removed.

    • getZoneinfo

      public String getZoneinfo()
      Gets the zoneinfo. Corresponds to the zoneinfo claim.
      Returns:
      The zoneinfo, null if not specified.

    • setZoneinfo

      public void setZoneinfo(String zoneinfo)
      Sets the zoneinfo. Corresponds to the zoneinfo claim.
      Parameters:
      zoneinfo - The zoneinfo. If null the claim will be removed.

    • getLocale

      public String getLocale()
      Gets the locale. Corresponds to the locale claim.
      Returns:
      The locale, null if not specified.

    • setLocale

      public void setLocale(String locale)
      Sets the locale. Corresponds to the locale claim.
      Parameters:
      locale - The locale. If null the claim will be removed.

    • getPhoneNumber

      public String getPhoneNumber()
      Gets the preferred telephone number. Corresponds to the phone_number claim.
      Returns:
      The preferred telephone number, null if not specified.

    • setPhoneNumber

      public void setPhoneNumber(String phoneNumber)
      Sets the preferred telephone number. Corresponds to the phone_number claim.
      Parameters:
      phoneNumber - The preferred telephone number. If null the claim will be removed.

    • getPhoneNumberVerified

      public Boolean getPhoneNumberVerified()
      Gets the phone number verification status. Corresponds to the phone_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 the phone_number_verified claim.
      Parameters:
      phoneNumberVerified - The phone number verification status. If null the claim will be removed.

    • getAddress

      public Address getAddress()
      Gets the preferred address. Corresponds to the address 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 the address 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 the address claim.
      Returns:
      The preferred address entries, empty map if none.

    • setAddress

      public void setAddress(Address address)
      Sets the preferred address. Corresponds to the address claim, with no language tag.
      Parameters:
      address - The preferred address. If null the claim will be removed.

    • setAddress

      public void setAddress(Address address, com.nimbusds.langtag.LangTag langTag)
      Sets the preferred address. Corresponds to the address claim, with an optional language tag.
      Parameters:
      address - The preferred address. If null 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 the updated_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 the updated_at claim.
      Parameters:
      updatedTime - The time the end-user information was last updated. If null the claim will be removed.

    • getBirthplace

      @Deprecated public Birthplace getBirthplace()
      Deprecated.
      Gets the birthplace. Corresponds to the birthplace claim.
      Returns:
      The birthplace, null if not specified.
      See Also:

    • setBirthplace

      @Deprecated public void setBirthplace(Birthplace birthplace)
      Deprecated.
      Sets the birthplace. Corresponds to the birthplace claim.
      Parameters:
      birthplace - The birthplace, null if not specified.
      See Also:

    • getPlaceOfBirth

      public Birthplace getPlaceOfBirth()
      Gets the birthplace. Corresponds to the place_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 the place_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 the nationalities 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 the nationalities 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 the birth_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 the birth_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 the birth_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 the birth_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 the birth_family_name claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      birthFamilyName - The birth family name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getBirthGivenName

      public String getBirthGivenName()
      Gets the birth given name. Corresponds to the birth_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 the birth_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 the birth_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 the birth_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 the birth_given_name claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      birthGivenName - The birth given name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getBirthMiddleName

      public String getBirthMiddleName()
      Gets the birth middle name. Corresponds to the birth_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 the birth_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 the birth_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 the birth_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 the birth_middle_name claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      birthMiddleName - The birth middle name. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getSalutation

      public String getSalutation()
      Gets the salutation. Corresponds to the salutation 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 the salutation 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 the salutation 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 the salutation 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 the salutation claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      salutation - The salutation. If null the claim will be removed.
      langTag - The language tag, null if not specified.

    • getTitle

      public String getTitle()
      Gets the title. Corresponds to the title 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 the title 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 the title 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 the title 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 the title claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      title - The title. If null 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 the msisdn 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 the msisdn claim.
      Parameters:
      msisdn - The mobile subscriber ISDN number. If null the claim will be removed.

    • getAlsoKnownAs

      public String getAlsoKnownAs()
      Gets the also known as. Corresponds to the also_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 the also_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 the also_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 the also_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 the also_known_as claim from OpenID Connect for Identity Assurance 1.0, with an optional language tag.
      Parameters:
      alsoKnownAs - The also known as. If null the claim will be removed.
      langTag - The language tag, null if not specified.