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:
- Address Claim, UserInfo Response, ID Token
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getCountry()
Returns the country.java.lang.String
getFormatted()
Returns the full mailing address, formatted for display.java.lang.String
getLocality()
Returns the city or locality.java.lang.String
getPostalCode()
Returns the zip code or postal code.java.lang.String
getRegion()
Returns the state, province, prefecture, or region.java.lang.String
getStreetAddress()
Returns the full street address, which may include house number, street name, P.O.
-
-
-
Method Detail
-
getFormatted
java.lang.String getFormatted()
Returns the full mailing address, formatted for display.- Returns:
- the full mailing address
-
getStreetAddress
java.lang.String getStreetAddress()
Returns the full street address, which may include house number, street name, P.O. Box, etc.- Returns:
- the full street address
-
getLocality
java.lang.String getLocality()
Returns the city or locality.- Returns:
- the city or locality
-
getRegion
java.lang.String getRegion()
Returns the state, province, prefecture, or region.- Returns:
- the state, province, prefecture, or region
-
getPostalCode
java.lang.String getPostalCode()
Returns the zip code or postal code.- Returns:
- the zip code or postal code
-
getCountry
java.lang.String getCountry()
Returns the country.- Returns:
- the country
-
-