Package com.nimbusds.openid.connect.sdk.assurance.evidences

Class IdentityEvidence

java.lang.Object

com.nimbusds.openid.connect.sdk.assurance.evidences.IdentityEvidence

All Implemented Interfaces:

net.minidev.json.JSONAware

Direct Known Subclasses:

DocumentEvidence, ElectronicRecordEvidence, ElectronicSignatureEvidence, IDDocumentEvidence, QESEvidence, UtilityBillEvidence, VouchEvidence

public abstract class IdentityEvidence
extends Object
implements net.minidev.json.JSONAware

The base abstract class for identity evidences.

Related specifications:

• OpenID Connect for Identity Assurance 1.0, section 5.1.1.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	IdentityEvidence(IdentityEvidenceType evidenceType, List<Attachment> attachments)	Creates a new evidence with the specified type.

Method Summary

Modifier and Type	Method	Description
protected static void	ensureType(IdentityEvidenceType expectedType, net.minidev.json.JSONObject jsonObject)	Ensures the type member of the specified JSON object matches the expected.
List<Attachment>	getAttachments()	Returns the optional attachments.
IdentityEvidenceType	getEvidenceType()	Returns the evidence type.
static IdentityEvidence	parse(net.minidev.json.JSONObject jsonObject)	Parses an identity evidence from the specified JSON object.
DocumentEvidence	toDocumentEvidence()	Casts this identity evidence to a document evidence.
ElectronicRecordEvidence	toElectronicRecordEvidence()	Casts this identity evidence to an electronic record evidence.
ElectronicSignatureEvidence	toElectronicSignatureEvidence()	Casts this identity evidence to an electronic signature evidence.
IDDocumentEvidence	toIDDocumentEvidence()	Casts this identity evidence to an ID document evidence.
net.minidev.json.JSONObject	toJSONObject()	Returns a JSON object representation of this evidence.
String	toJSONString()
QESEvidence	toQESEvidence()	Casts this identity evidence to a QES evidence.
UtilityBillEvidence	toUtilityBillEvidence()	Casts this identity evidence to a utility bill evidence.
VouchEvidence	toVouchEvidence()	Casts this identity evidence to a vouch evidence.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityEvidence

protected IdentityEvidence(IdentityEvidenceType evidenceType,
                           List<Attachment> attachments)

Creates a new evidence with the specified type.

Parameters:

evidenceType - The evidence type. Must not be null.

attachments - The optional attachments, null if not specified.

Method Detail

getEvidenceType

public IdentityEvidenceType getEvidenceType()

Returns the evidence type.

Returns:

The evidence type.

getAttachments

public List<Attachment> getAttachments()

Returns the optional attachments.

Returns:

The attachments, null if not specified.

toDocumentEvidence

public DocumentEvidence toDocumentEvidence()

Casts this identity evidence to a document evidence.

Returns:

The document evidence.

toIDDocumentEvidence

public IDDocumentEvidence toIDDocumentEvidence()

Casts this identity evidence to an ID document evidence.

Returns:

The ID document evidence.

toElectronicRecordEvidence

public ElectronicRecordEvidence toElectronicRecordEvidence()

Casts this identity evidence to an electronic record evidence.

Returns:

The electronic record evidence.

toVouchEvidence

public VouchEvidence toVouchEvidence()

Casts this identity evidence to a vouch evidence.

Returns:

The vouch evidence.

toUtilityBillEvidence

public UtilityBillEvidence toUtilityBillEvidence()

Casts this identity evidence to a utility bill evidence.

Returns:

The utility bill evidence.

toElectronicSignatureEvidence

public ElectronicSignatureEvidence toElectronicSignatureEvidence()

Casts this identity evidence to an electronic signature evidence.

Returns:

The electronic signature evidence.

toQESEvidence

public QESEvidence toQESEvidence()

Casts this identity evidence to a QES evidence.

Returns:

The QES evidence.

toJSONObject

public net.minidev.json.JSONObject toJSONObject()

Returns a JSON object representation of this evidence.

Returns:

The JSON object.

toJSONString

public String toJSONString()

Specified by:

toJSONString in interface net.minidev.json.JSONAware

parse

public static IdentityEvidence parse(net.minidev.json.JSONObject jsonObject)
                              throws ParseException

Parses an identity evidence from the specified JSON object.

Parameters:

jsonObject - The JSON object. Must not be null.

Returns:

A DocumentEvidence, IDDocumentEvidence, ElectronicRecordEvidence, VouchEvidence, QESEvidence, ElectronicSignatureEvidence, or UtilityBillEvidence instance.

Throws:

ParseException - If parsing failed or the evidence type isn't supported.

ensureType

protected static void ensureType(IdentityEvidenceType expectedType,
                                 net.minidev.json.JSONObject jsonObject)
                          throws ParseException

Ensures the type member of the specified JSON object matches the expected.

Parameters:

expectedType - The expected type. Must not be null.

jsonObject - The JSON object. Must not be null.

Throws:

ParseException - If parsing failed or mismatch.