Interface AddressStandardClaim

All Known Implementing Classes:
DefaultAddressStandardClaim
public interface AddressStandardClaim
The Address Claim represents a physical mailing address defined by the OpenID Connect Core 1.0 specification that can be returned either in the UserInfo Response or the ID Token.
Since:
5.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable String
    getCountry()
    Returns the country, or null if it does not exist.
    @Nullable String
    getFormatted()
    Returns the full mailing address, formatted for display, or null if it does not exist.
    @Nullable String
    getLocality()
    Returns the city or locality, or null if it does not exist.
    @Nullable String
    getPostalCode()
    Returns the zip code or postal code, or null if it does not exist.
    @Nullable String
    getRegion()
    Returns the state, province, prefecture, or region, or null if it does not exist.
    @Nullable String
    getStreetAddress()
    Returns the full street address, which may include house number, street name, P.O.

  • Method Details

    • getFormatted

      @Nullable String getFormatted()
      Returns the full mailing address, formatted for display, or null if it does not exist.
      Returns:
      the full mailing address, or null if it does not exist

    • getStreetAddress

      @Nullable String getStreetAddress()
      Returns the full street address, which may include house number, street name, P.O. Box, etc., or null if it does not exist.
      Returns:
      the full street address, or null if it does not exist

    • getLocality

      @Nullable String getLocality()
      Returns the city or locality, or null if it does not exist.
      Returns:
      the city or locality, or null if it does not exist

    • getRegion

      @Nullable String getRegion()
      Returns the state, province, prefecture, or region, or null if it does not exist.
      Returns:
      the state, province, prefecture, or region, or null if it does not exist

    • getPostalCode

      @Nullable String getPostalCode()
      Returns the zip code or postal code, or null if it does not exist.
      Returns:
      the zip code or postal code, or null if it does not exist

    • getCountry

      @Nullable String getCountry()
      Returns the country, or null if it does not exist.
      Returns:
      the country, or null if it does not exist