Package com.authlete.common.assurance.constraint

Class DocumentConstraint

java.lang.Object

com.authlete.common.assurance.constraint.BaseConstraint

com.authlete.common.assurance.constraint.DocumentConstraint

All Implemented Interfaces:

Constraint

public class DocumentConstraint
extends BaseConstraint

The class that represents the constraint for id_document/document.

Since:

2.63

See Also:

OpenID Connect for Identity Assurance 1.0

Constructor Summary

Constructors

Constructor	Description
DocumentConstraint()

Method Summary

Modifier and Type	Method	Description
static DocumentConstraint	extract(Map<?,?> map, String key)	Create a DocumentConstraint instance from an object in the given map.
LeafConstraint	getDateOfExpiry()	Get the constraint for date_of_expiry.
LeafConstraint	getDateOfIssuance()	Get the constraint for date_of_issuance.
IssuerConstraint	getIssuer()	Get the constraint for issuer.
LeafConstraint	getNumber()	Get the constraint for number.
LeafConstraint	getType()	Get the constraint for type.
void	setDateOfExpiry(LeafConstraint constraint)	Set the constraint for date_of_expiry.
void	setDateOfIssuance(LeafConstraint constraint)	Set the constraint for date_of_issuance.
void	setIssuer(IssuerConstraint constraint)	Set the constraint for issuer.
void	setNumber(LeafConstraint constraint)	Set the constraint for number.
void	setType(LeafConstraint constraint)	Set the constraint for type.
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

DocumentConstraint

public DocumentConstraint()

Method Detail

getType

public LeafConstraint getType()

Get the constraint for type.

Returns:

The constraint for type.

setType

public void setType(LeafConstraint constraint)

Set the constraint for type.

Parameters:

constraint - The constraint for type.

getNumber

public LeafConstraint getNumber()

Get the constraint for number.

Returns:

The constraint for number.

setNumber

public void setNumber(LeafConstraint constraint)

Set the constraint for number.

Parameters:

constraint - The constraint for number.

getIssuer

public IssuerConstraint getIssuer()

Get the constraint for issuer.

Returns:

The constraint for issuer.

setIssuer

public void setIssuer(IssuerConstraint constraint)

Set the constraint for issuer.

Parameters:

constraint - The constraint for issuer.

getDateOfIssuance

public LeafConstraint getDateOfIssuance()

Get the constraint for date_of_issuance.

Returns:

The constraint for date_of_issuance.

setDateOfIssuance

public void setDateOfIssuance(LeafConstraint constraint)

Set the constraint for date_of_issuance.

Parameters:

constraint - The constraint for date_of_issuance.

getDateOfExpiry

public LeafConstraint getDateOfExpiry()

Get the constraint for date_of_expiry.

Returns:

The constraint for date_of_expiry.

setDateOfExpiry

public void setDateOfExpiry(LeafConstraint constraint)

Set the constraint for date_of_expiry.

Parameters:

constraint - The constraint for date_of_expiry.

extract

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

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

Parameters:

map - A map that may contain "document".

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

Returns:

A DocumentConstraint instance that represents "document". Even if the map does not contain the given key, an instance of DocumentConstraint 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.