Package com.authlete.common.assurance.constraint

Class BaseConstraint

java.lang.Object

com.authlete.common.assurance.constraint.BaseConstraint

All Implemented Interfaces:

Constraint

Direct Known Subclasses:

DocumentConstraint, EvidenceConstraint, IssuerConstraint, LeafConstraint, ProviderConstraint, VerificationConstraint, VerifiedClaimsConstraint, VerifiedClaimsContainerConstraint, VerifierConstraint

public class BaseConstraint
extends Object
implements Constraint

The base class for classes that represent constraints in verified_claims.

Note that EvidenceArrayConstraint and ClaimsConstraint don't inherit this class. They implement the Constraint interface by themselves.

Since:

2.63

See Also:

OpenID Connect for Identity Assurance 1.0

Constructor Summary

Constructors

Constructor	Description
BaseConstraint()

Method Summary

Modifier and Type	Method	Description
boolean	exists()	Check if the key that represents the constraint exists.
boolean	isNull()	Check if the value of the constraint is null.
void	setExists(boolean exists)	Set the existence of the constraint.
void	setNull(boolean isNull)	Set the boolean flag that indicates that the value of the constraint is null.
String	toJson()	Convert this object into JSON in the way conforming to the structure defined in 5.
String	toJson(boolean pretty)	Convert this object into JSON in the way conforming to the structure defined in 5.
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 java.lang.Object

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

Constructor Detail

BaseConstraint

public BaseConstraint()

Method Detail

exists

public boolean exists()

Description copied from interface: Constraint

Check if the key that represents the constraint exists. It does not matter whether the value of the key is null or not.

For example, exists() method of an instance that represents given_name in the JSON below will return true.

 {
   "verified_claims": {
     "claims": {
       "given_name": null
     }
   }
 }
 

Specified by:

exists in interface Constraint

Returns:

true if the key that represents the constraint exists.

setExists

public void setExists(boolean exists)

Set the existence of the constraint.

Parameters:

exists - true to indicate that the constraint exists.

isNull

public boolean isNull()

Description copied from interface: Constraint

Check if the value of the constraint is null.

For example, isNull() method of an instance that represents given_name in the JSON below will return true.

 {
   "verified_claims": {
     "claims": {
       "given_name": null
     }
   }
 }
 

But, the method returns false in the following case.

 {
   "verified_claims": {
     "claims": {
       "given_name": {
       }
     }
   }
 }
 

Specified by:

isNull in interface Constraint

Returns:

true if the value of the constraint is null.

setNull

public void setNull(boolean isNull)

Set the boolean flag that indicates that the value of the constraint is null.

Parameters:

isNull - true to indicate that the value of the constraint is null.

toMap

public Map<String,Object> toMap()

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.

Returns:

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

toJson

public String toJson()

Convert this object into JSON in the way conforming to the structure defined in 5. Requesting Verified Claims of OpenID Connect for Identity Assurance 1.0.

This method is an alias of toJson(false).

Returns:

JSON that represents this object. If toMap() returns null, this method returns "null" (a String instance which consists of 'n', 'u', 'l' and 'l').

toJson

public String toJson(boolean pretty)

Convert this object into JSON in the way conforming to the structure defined in 5. Requesting Verified Claims of OpenID Connect for Identity Assurance 1.0.

Parameters:

pretty - true to make the output more human-readable.

Returns:

JSON that represents this object. If toMap() returns null, this method returns "null" (a String instance which consists of 'n', 'u', 'l' and 'l').