com.nimbusds.openid.connect.sdk.assurance.evidences.IdentityEvidence Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing client and server applications.
There is a newer version: 11.20.1
/*
 * oauth2-oidc-sdk
 *
 * Copyright 2012-2016, Connect2id Ltd and contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
 * this file except in compliance with the License. You may obtain a copy of the
 * License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed
 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */

package com.nimbusds.openid.connect.sdk.assurance.evidences;


import java.util.LinkedList;
import java.util.List;

import net.minidev.json.JSONAware;
import net.minidev.json.JSONObject;

import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.util.CollectionUtils;
import com.nimbusds.oauth2.sdk.util.JSONObjectUtils;
import com.nimbusds.openid.connect.sdk.assurance.evidences.attachment.Attachment;


/**
 * The base abstract class for identity evidences.
 *
 * Related specifications:
 *
 * 

 *     OpenID Connect for Identity Assurance 1.0, section 5.1.1.
 * 
 */
public abstract class IdentityEvidence implements JSONAware {
	
	
	/**
	 * The evidence type.
	 */
	private final IdentityEvidenceType evidenceType;
	
	
	/**
	 * The optional attachments.
	 */
	private final List attachments;
	
	
	/**
	 * Creates a new evidence with the specified type.
	 *
	 * @param evidenceType The evidence type. Must not be {@code null}.
	 * @param attachments  The optional attachments, {@code null} if not
	 *                     specified.
	 */
	protected IdentityEvidence(final IdentityEvidenceType evidenceType,
				   final List attachments) {
		if (evidenceType == null) {
			throw new IllegalArgumentException("The evidence type must not be null");
		}
		this.evidenceType = evidenceType;
		
		this.attachments = attachments;
	}
	
	
	/**
	 * Returns the evidence type.
	 *
	 * @return The evidence type.
	 */
	public IdentityEvidenceType getEvidenceType() {
		return evidenceType;
	}
	
	
	/**
	 * Returns the optional attachments.
	 *
	 * @return The attachments, {@code null} if not specified.
	 */
	public List getAttachments() {
		return attachments;
	}
	
	
	/**
	 * Casts this identity evidence to a document evidence.
	 *
	 * @return The document evidence.
	 */
	public DocumentEvidence toDocumentEvidence() {
		
		return (DocumentEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to an ID document evidence.
	 *
	 * @return The ID document evidence.
	 */
	public IDDocumentEvidence toIDDocumentEvidence() {
		
		return (IDDocumentEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to an electronic record evidence.
	 *
	 * @return The electronic record evidence.
	 */
	public ElectronicRecordEvidence toElectronicRecordEvidence() {
		
		return (ElectronicRecordEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to a vouch evidence.
	 *
	 * @return The vouch evidence.
	 */
	public VouchEvidence toVouchEvidence() {
		
		return (VouchEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to a utility bill evidence.
	 *
	 * @return The utility bill evidence.
	 */
	public UtilityBillEvidence toUtilityBillEvidence() {
		
		return (UtilityBillEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to an electronic signature evidence.
	 *
	 * @return The electronic signature evidence.
	 */
	public ElectronicSignatureEvidence toElectronicSignatureEvidence() {
		
		return (ElectronicSignatureEvidence)this;
	}
	
	
	/**
	 * Casts this identity evidence to a QES evidence.
	 *
	 * @return The QES evidence.
	 */
	public QESEvidence toQESEvidence() {
		
		return (QESEvidence)this;
	}
	
	
	/**
	 * Returns a JSON object representation of this evidence.
	 *
	 * @return The JSON object.
	 */
	public JSONObject toJSONObject() {
	
		JSONObject o = new JSONObject();
		
		o.put("type", getEvidenceType().getValue());
		
		if (CollectionUtils.isNotEmpty(getAttachments())) {
			List