Package com.authlete.common.assurance.constraint

Class ProviderConstraint

java.lang.Object

com.authlete.common.assurance.constraint.BaseConstraint

com.authlete.common.assurance.constraint.ProviderConstraint

All Implemented Interfaces:

Constraint

public class ProviderConstraint
extends BaseConstraint

The class that represents the constraint for utility_bill/provider.

Since:

2.63

See Also:

OpenID Connect for Identity Assurance 1.0

Constructor Summary

Constructors

Constructor	Description
ProviderConstraint()

Method Summary

Modifier and Type	Method	Description
static ProviderConstraint	extract(Map<?,?> map, String key)	Create a ProviderConstraint instance from an object in the given map.
LeafConstraint	getCountry()	Get the constraint for country.
LeafConstraint	getFormatted()	Get the constraint for formatted.
LeafConstraint	getLocality()	Get the constraint for locality.
LeafConstraint	getName()	Get the constraint for name.
LeafConstraint	getPostalCode()	Get the constraint for postal_code.
LeafConstraint	getRegion()	Get the constraint for region.
LeafConstraint	getStreetAddress()	Get the constraint for street_address.
void	setCountry(LeafConstraint constraint)	Set the constraint for country.
void	setFormatted(LeafConstraint constraint)	Set the constraint for formatted.
void	setLocality(LeafConstraint constraint)	Set the constraint for locality.
void	setName(LeafConstraint constraint)	Set the constraint for name.
void	setPostalCode(LeafConstraint constraint)	Set the constraint for postal_code.
void	setRegion(LeafConstraint constraint)	Set the constraint for region.
void	setStreetAddress(LeafConstraint constraint)	Set the constraint for street_address.
Map<String,Object>	toMap()	Create a Map instance that represents this object in the way conforming to the structure defined in 5.

Methods inherited from class com.authlete.common.assurance.constraint.BaseConstraint

exists, isNull, setExists, setNull, toJson, toJson

Methods inherited from class java.lang.Object

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

Constructor Detail

ProviderConstraint

public ProviderConstraint()

Method Detail

getName

public LeafConstraint getName()

Get the constraint for name.

Returns:

The constraint for name.

setName

public void setName(LeafConstraint constraint)

Set the constraint for name.

Parameters:

constraint - The constraint for name.

getFormatted

public LeafConstraint getFormatted()

Get the constraint for formatted.

Returns:

The constraint for formatted.

Since:

2.67

setFormatted

public void setFormatted(LeafConstraint constraint)

Set the constraint for formatted.

Parameters:

constraint - The constraint for formatted.

Since:

2.67

getStreetAddress

public LeafConstraint getStreetAddress()

Get the constraint for street_address.

Returns:

The constraint for street_address.

setStreetAddress

public void setStreetAddress(LeafConstraint constraint)

Set the constraint for street_address.

Parameters:

constraint - The constraint for street_address.

getLocality

public LeafConstraint getLocality()

Get the constraint for locality.

Returns:

The constraint for locality.

Since:

2.67

setLocality

public void setLocality(LeafConstraint constraint)

Set the constraint for locality.

Parameters:

constraint - The constraint for locality.

Since:

2.67

getRegion

public LeafConstraint getRegion()

Get the constraint for region.

Returns:

The constraint for region.

setRegion

public void setRegion(LeafConstraint constraint)

Set the constraint for region.

Parameters:

constraint - The constraint for region.

getPostalCode

public LeafConstraint getPostalCode()

Get the constraint for postal_code.

Returns:

The constraint for postal_code.

Since:

2.67

setPostalCode

public void setPostalCode(LeafConstraint constraint)

Set the constraint for postal_code.

Parameters:

constraint - The constraint for postal_code.

Since:

2.67

getCountry

public LeafConstraint getCountry()

Get the constraint for country.

Returns:

The constraint for country.

setCountry

public void setCountry(LeafConstraint constraint)

Set the constraint for country.

Parameters:

constraint - The constraint for country.

extract

public static ProviderConstraint extract(Map<?,?> map,
                                         String key)
                                  throws ConstraintException

Create a ProviderConstraint instance from an object in the given map.

Parameters:

map - A map that may contain "provider".

key - The key that identifies the object in the map. In normal cases, the key is "provider".

Returns:

A ProviderConstraint instance that represents "provider". Even if the map does not contain the given key, an instance of ProviderConstraint is returned.

Throws:

ConstraintException - The structure of the map does not conform to the specification (OpenID Connect for Identity Assurance 1.0).

toMap

public Map<String,Object> toMap()

Description copied from class: BaseConstraint

Create a Map instance that represents this object in the way conforming to the structure defined in 5. Requesting Verified Claims of OpenID Connect for Identity Assurance 1.0.

Overrides:

toMap in class BaseConstraint

Returns:

A Map instance that represents this object. If BaseConstraint.exists() returns false or BaseConstraint.isNull() returns true, this method returns null.