Package com.authlete.common.assurance

Class IDDocument

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<String,Object>

com.authlete.common.assurance.Evidence

com.authlete.common.assurance.IDDocument

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Object>

public class IDDocument
extends Evidence

The class that represents id_document.

Since:

2.63

See Also:

OpenID Connect for Identity Assurance 1.0, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
IDDocument()	The constructor that construct evidence whose type is "id_document".

Method Summary

Modifier and Type	Method	Description
boolean	containsDocument()	Check if this object contains "document".
boolean	containsMethod()	Check if this object contains "method".
boolean	containsTime()	Check if this object contains "time".
boolean	containsVerifier()	Check if this object contains "verifier".
static IDDocument	extract(Map<?,?> map)	Create an IDDocument instance from the given object.
Document	getDocument()	Get the ID document used to perform the ID verification.
String	getMethod()	Get the method used to verify this ID document.
String	getTime()	Get the date when this ID document was verified.
Verifier	getVerifier()	Get the legal entity that performed the identity verification.
Document	removeDocument()	Remove "document" from this object.
Provider	removeMethod()	Remove "method" from this object.
String	removeTime()	Remove "time" from this object.
Verifier	removeVerifier()	Remove "verifier" from this object.
IDDocument	setDocument(Document document)	Set the ID document used to perform the ID verification.
IDDocument	setMethod(String method)	Set the method used to verify this ID document.
IDDocument	setTime(String time)	Set the date when this ID document was verified.
IDDocument	setVerifier(Verifier verifier)	Set the legal entity that performed the identity verification.

Methods inherited from class com.authlete.common.assurance.Evidence

extract, getType

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, get, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, containsKey, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, equals, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size

Constructor Detail

IDDocument

public IDDocument()

The constructor that construct evidence whose type is "id_document".

Method Detail

getMethod

public String getMethod()

Get the method used to verify this ID document.

Returns:

The method used to verify this ID document.

setMethod

public IDDocument setMethod(String method)

Set the method used to verify this ID document.

Parameters:

method - The method used to verify this ID document.

Returns:

this object.

containsMethod

public boolean containsMethod()

Check if this object contains "method".

Returns:

true if this object contains "method".

removeMethod

public Provider removeMethod()

Remove "method" from this object.

Returns:

The old value that may have existed before removal.

getVerifier

public Verifier getVerifier()

Get the legal entity that performed the identity verification.

Returns:

The legal entity that performed the identity verification.

setVerifier

public IDDocument setVerifier(Verifier verifier)

Set the legal entity that performed the identity verification.

Parameters:

verifier - The legal entity that performed the identity verification.

Returns:

this object;

containsVerifier

public boolean containsVerifier()

Check if this object contains "verifier".

Returns:

true if this object contains "verifier".

removeVerifier

public Verifier removeVerifier()

Remove "verifier" from this object.

Returns:

The old value that may have existed before removal.

getTime

public String getTime()

Get the date when this ID document was verified.

Returns:

The date when this ID document was verified.

setTime

public IDDocument setTime(String time)

Set the date when this ID document was verified.

Parameters:

time - The date when this ID document was verified.

Returns:

this object.

containsTime

public boolean containsTime()

Check if this object contains "time".

Returns:

true if this object contains "time".

removeTime

public String removeTime()

Remove "time" from this object.

Returns:

The old value that may have existed before removal.

getDocument

public Document getDocument()

Get the ID document used to perform the ID verification.

Returns:

The ID document used to perform the ID verification.

setDocument

public IDDocument setDocument(Document document)

Set the ID document used to perform the ID verification.

Parameters:

document - The ID document used to perform the ID verification.

Returns:

this object.

containsDocument

public boolean containsDocument()

Check if this object contains "document".

Returns:

true if this object contains "document".

removeDocument

public Document removeDocument()

Remove "document" from this object.

Returns:

The old value that may have existed before removal.

extract

public static IDDocument extract(Map<?,?> map)
                          throws IdentityAssuranceException

Create an IDDocument instance from the given object.

Parameters:

map - A map that represents "id_document".

Returns:

An IDDocument instance that represents "id_document".

Throws:

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