eu.europa.esig.dss.enumerations.CertificateQualification Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dss-enumerations Show documentation
DSS Enumerations contains all shared enumerations
There is a newer version: 6.1
/**
 * DSS - Digital Signature Services
 * Copyright (C) 2015 European Commission, provided under the CEF programme
 * 
 * This file is part of the "DSS - Digital Signature Services" project.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package eu.europa.esig.dss.enumerations;

import java.util.HashMap;
import java.util.Map;

/**
 * Available certificate qualification types
 */
public enum CertificateQualification {

	/**
	 * Qualified Certificate for Electronic Signatures with private key on QSCD
	 */
	QCERT_FOR_ESIG_QSCD("QC for eSig with QSCD",
			"Qualified Certificate for Electronic Signatures with private key on QSCD",
			CertificateQualifiedStatus.QC, CertificateType.ESIGN, QSCDStatus.QSCD),

	/**
	 * Qualified Certificate for Electronic Seals with private key on QSCD
	 */
	QCERT_FOR_ESEAL_QSCD("QC for eSeal with QSCD",
			"Qualified Certificate for Electronic Seals with private key on QSCD",
			CertificateQualifiedStatus.QC, CertificateType.ESEAL, QSCDStatus.QSCD),

	// QCERT_FOR_WSA_QSCD non sense

	/**
	 * Qualified Certificate for unidentified type with private key in a QSCD
	 */
	QCERT_FOR_UNKNOWN_QSCD("QC for unknown type with QSCD",
			"Qualified Certificate for unknown type with its private key residing in a QSCD",
			CertificateQualifiedStatus.QC, CertificateType.UNKNOWN, QSCDStatus.QSCD),

	// --------------------------------------------------------

	/**
	 * Qualified Certificate for Electronic Signatures
	 */
	QCERT_FOR_ESIG("QC for eSig", "Qualified Certificate for Electronic Signatures",
			CertificateQualifiedStatus.QC, CertificateType.ESIGN, QSCDStatus.NOT_QSCD),

	/**
	 * Qualified Certificate for Electronic Seals
	 */
	QCERT_FOR_ESEAL("QC for eSeal", "Qualified Certificate for Electronic Seals",
			CertificateQualifiedStatus.QC, CertificateType.ESEAL, QSCDStatus.NOT_QSCD),

	/**
	 * Qualified Certificate for Web Site Authentications
	 */
	QCERT_FOR_WSA("QC for WSA", "Qualified Certificate for Web Site Authentications",
			CertificateQualifiedStatus.QC, CertificateType.WSA, QSCDStatus.NOT_QSCD),

	/**
	 * Qualified Certificate for unidentified type
	 */
	QCERT_FOR_UNKNOWN("QC for unknown type", "Qualified Certificate for unknown type",
			CertificateQualifiedStatus.QC, CertificateType.UNKNOWN, QSCDStatus.NOT_QSCD),

	// --------------------------------------------------------

	/**
	 * Certificate for Electronic Signatures
	 */
	CERT_FOR_ESIG("Cert for eSig", "Certificate for Electronic Signatures",
			CertificateQualifiedStatus.NOT_QC, CertificateType.ESIGN, QSCDStatus.NOT_QSCD),

	/**
	 * Certificate for Electronic Seals
	 */
	CERT_FOR_ESEAL("Cert for eSeal", "Certificate for Electronic Seals",
			CertificateQualifiedStatus.NOT_QC, CertificateType.ESEAL, QSCDStatus.NOT_QSCD),

	/**
	 * Certificate for Web Site Authentications
	 */
	CERT_FOR_WSA("Cert for WSA", "Certificate for Web Site Authentications",
			CertificateQualifiedStatus.NOT_QC, CertificateType.WSA, QSCDStatus.NOT_QSCD),

	/**
	 * Certificate for unidentified type
	 */
	CERT_FOR_UNKNOWN("Cert for unknown type", "Certificate for unknown type",
			CertificateQualifiedStatus.NOT_QC, CertificateType.UNKNOWN, QSCDStatus.NOT_QSCD),

	/**
	 * Not Applicable
	 */
	NA("N/A", "Not applicable",
			CertificateQualifiedStatus.NOT_QC, CertificateType.UNKNOWN, QSCDStatus.NOT_QSCD);

	private static class Registry {

		private static final Map QUALIFS_BY_READABLE = registerByReadable();

		private static Map registerByReadable() {
			final Map map = new HashMap<>();
			for (final CertificateQualification qualification : values()) {
				map.put(qualification.readable, qualification);
			}
			return map;
		}
	}

	private final String readable;
	private final String label;
	private final CertificateQualifiedStatus qualifiedStatus;
	private final CertificateType type;
	private final QSCDStatus qscdStatus;

	CertificateQualification(String readable, String label, CertificateQualifiedStatus qualifiedStatus,
							 CertificateType type, QSCDStatus qscdStatus) {
		this.readable = readable;
		this.label = label;
		this.qualifiedStatus = qualifiedStatus;
		this.type = type;
		this.qscdStatus = qscdStatus;
	}

	/**
	 * Returns a short string defining the qualification type
	 *
	 * @return {@link String}
	 */
	public String getReadable() {
		return readable;
	}

	/**
	 * Returns a complete name of the qualification type
	 *
	 * @return {@link String}
	 */
	public String getLabel() {
		return label;
	}

	/**
	 * CertificateQualification can be null
	 * 
	 * @param value
	 *            the qualification name to be converted to the enum
	 * @return the linked CertificateQualification or null
	 */
	public static CertificateQualification forName(String value) {
		if ((value != null) && !value.isEmpty()) {
			return CertificateQualification.valueOf(value);
		}
		return null;
	}

	/**
	 * CertificateQualification can be null
	 * 
	 * @param readable
	 *            the readable description of the qualification to be converted to the enum
	 * @return the linked CertificateQualification or null
	 */
	public static CertificateQualification fromReadable(String readable) {
		if ((readable != null) && !readable.isEmpty()) {
			return Registry.QUALIFS_BY_READABLE.get(readable);
		}
		return null;
	}

	/**
	 * Returns if the certificate is qualified
	 *
	 * @return TRUE if it is a qualified certificate, FALSE otherwise
	 */
	public boolean isQc() {
		return CertificateQualifiedStatus.isQC(qualifiedStatus);
	}

	/**
	 * Returns the type of an electronic signature the certificate can be used for
	 *
	 * @return {@link CertificateType}
	 */
	public CertificateType getType() {
		return type;
	}

	/**
	 * Returns if the certificate can be used for an electronic signature
	 *
	 * @return TRUE if it is an eSig certificate, FALSE otherwise
	 */
	public boolean isForEsig() {
		return CertificateType.ESIGN.equals(type);
	}

	/**
	 * Returns if the certificate can be used for an electronic seal
	 *
	 * @return TRUE if it is an eSeal certificate, FALSE otherwise
	 */
	public boolean isForEseal() {
		return CertificateType.ESEAL.equals(type);
	}

	/**
	 * Returns if the certificate is used on a Qualified Signature Creation Device
	 *
	 * @return TRUE if the certificate os QSCD, FALSE otherwise
	 */
	public boolean isQscd() {
		return QSCDStatus.isQSCD(qscdStatus);
	}

}