com.nimbusds.openid.connect.sdk.claims
Class Address

java.lang.Object
  com.nimbusds.openid.connect.sdk.claims.ClaimsSet
      com.nimbusds.openid.connect.sdk.claims.Address

public class Address
extends ClaimsSet

UserInfo address claims set, serialisable to a JSON object.

Related specifications:

• OpenID Connect Messages 1.0, section 2.5.1.

Author:

Vladimir Dzhuvinov

Constructor Summary

Address()
Creates a new minimal (empty) UserInfo address claims set.

Address(net.minidev.json.JSONObject jsonObject)
Creates a new UserInfo address claims set from the specified JSON object.

Method Summary

String	getCountry() Gets the country name component.
String	getFormatted() Gets the full mailing address, formatted for display or use with a mailing label.
String	getLocality() Gets the city or locality component.
String	getPostalCode() Gets the zip code or postal code component.
String	getRegion() Gets the state, province, prefecture or region component.
static Set<String>	getStandardClaimNames() Gets the names of the standard UserInfo address claims.
String	getStreetAddress() Gets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.
void	setCountry(String country) Sets the country name component.
void	setFormatted(String formatted) Sets the full mailing address, formatted for display or use with a mailing label.
void	setLocality(String locality) Sets the city or locality component.
void	setPostalCode(String postalCode) Sets the zip code or postal code component.
void	setRegion(String region) Sets the state, province, prefecture or region component.
void	setStreetAddress(String streetAddress) Sets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information.

Methods inherited from class com.nimbusds.openid.connect.sdk.claims.ClaimsSet

getBooleanClaim, getClaim, getClaim, getDateClaim, getEmailClaim, getJSONObject, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getURLClaim, setClaim, setClaim, setDateClaim, setEmailClaim, setURLClaim

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Address

public Address()

Creates a new minimal (empty) UserInfo address claims set.

Address

public Address(net.minidev.json.JSONObject jsonObject)

Creates a new UserInfo address claims set from the specified JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Method Detail

getStandardClaimNames

public static Set<String> getStandardClaimNames()

Gets the names of the standard UserInfo address claims.

Returns:

The names of the standard UserInfo address claims (read-only set).

setFormatted

public void setFormatted(String formatted)

Sets the full mailing address, formatted for display or use with a mailing label. May contain newlines. Corresponds to the formatted claim.

Parameters:

formatted - The full mailing address. null if not specified.

getFormatted

public String getFormatted()

Gets the full mailing address, formatted for display or use with a mailing label. May contain newlines. Corresponds to the formatted claim.

Returns:

The full mailing address, null if not specified.

setStreetAddress

public void setStreetAddress(String streetAddress)

Sets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. May contain newlines. Corresponds to the street_address claim.

Parameters:

streetAddress - The full street address component. If null the claim will be removed.

getStreetAddress

public String getStreetAddress()

Gets the full street address component, which may include house number, street name, PO BOX, and multi-line extended street address information. May contain newlines. Corresponds to the street_address claim.

Returns:

The full street address component, null if not specified.

setLocality

public void setLocality(String locality)

Sets the city or locality component. Corresponds to the locality claim.

Parameters:

locality - The city or locality component. If null the claim will be removed.

getLocality

public String getLocality()

Gets the city or locality component. Corresponds to the locality claim, with no language tag.

Returns:

The city or locality component, null if not specified.

setRegion

public void setRegion(String region)

Sets the state, province, prefecture or region component. Corresponds to the region claim.

Parameters:

region - The state, province, prefecture or region component. If null the claim will be removed.

getRegion

public String getRegion()

Gets the state, province, prefecture or region component. Corresponds to the region claim.

Returns:

The state, province, prefecture or region component, null if not specified.

setPostalCode

public void setPostalCode(String postalCode)

Sets the zip code or postal code component. Corresponds to the postal_code claim.

Parameters:

postalCode - The zip code or postal code component. If null the claim will be removed.

getPostalCode

public String getPostalCode()

Gets the zip code or postal code component. Corresponds to the postal_code claim.

Returns:

The zip code or postal code component, null if not specified.

setCountry

public void setCountry(String country)

Sets the country name component. Corresponds to the country claim.

Parameters:

country - The country name component. If null the claim will be removed.

getCountry

public String getCountry()

Gets the country name component. Corresponds to the country claim.

Returns:

The country name component, null if not specified.