/*************************************************************************
 *                                                                       *
 *  EJBCA: The OpenSource Certificate Authority                          *
 *                                                                       *
 *  This software 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 any later version.                    *
 *                                                                       *
 *  See terms of license at gnu.org.                                     *
 *                                                                       *
 *************************************************************************/
package org.cesecore.certificates.crl;

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

/**
 * An enum for revocation reasons, with a numerical database value and a String value for CLI applications.
 * 
 * Based on RFC 5280 Section 5.3.1
 * 
 * @version $Id: RevocationReasons.java 28485 2018-03-14 12:59:48Z anatom $
 */
public enum RevocationReasons {
    NOT_REVOKED(-1, "NOT_REVOKED", "The Certificate Is Not Revoked"),
    UNSPECIFIED(0, "UNSPECIFIED", "Unspecified"),
    KEYCOMPROMISE(1, "KEY_COMPROMISE", "Key Compromise"),
    CACOMPROMISE(2, "CA_COMPROMISE", "CA Compromise"),
    AFFILIATIONCHANGED(3, "AFFILIATION_CHANGED", "Affiliation Changed"),
    SUPERSEDED(4, "SUPERSEDED", "Superseded"),
    CESSATIONOFOPERATION(5, "CESSATION_OF_OPERATION", "Cessation of Operation"),
    CERTIFICATEHOLD(6, "CERTIFICATE_HOLD", "Certificate Hold"),
    REMOVEFROMCRL(8, "REMOVE_FROM_CRL", "Remove from CRL"),
    PRIVILEGESWITHDRAWN(9, "PRIVILEGES_WITHDRAWN", "Privileges Withdrawn"),
    AACOMPROMISE(10, "AA_COMPROMISE", "AA Compromise");
    
    private final int databaseValue;
    private final String stringValue;
    private final String humanReadable;

    private static final Map<Integer, RevocationReasons> databaseLookupMap = new HashMap<Integer, RevocationReasons>();
    private static final Map<String, RevocationReasons> cliLookupMap = new HashMap<String, RevocationReasons>();

    
    static {
        for(RevocationReasons reason : RevocationReasons.values()) {
            databaseLookupMap.put(reason.getDatabaseValue(), reason);
            cliLookupMap.put(reason.getStringValue(), reason);
        }
    }

    private RevocationReasons(final int databaseValue, final String stringValue, String humanReadable) {
        this.databaseValue = databaseValue;
        this.stringValue = stringValue;
        this.humanReadable = humanReadable;
    }
    
    public int getDatabaseValue() {
        return databaseValue;
    }
    
    public String getHumanReadable() {
        return humanReadable;
    }
    
    public String getStringValue() {
        return stringValue;
    }
    
    /**
     * 
     * @param databaseValue the database value
     * @return the relevant RevocationReasons object, null if none found. 
     */
    public static RevocationReasons getFromDatabaseValue(int databaseValue) {
        return databaseLookupMap.get(databaseValue);
    }
    
    /**
     * 
     * @param cliValue the database value
     * @return the relevant RevocationReasons object, null if none found. 
     */
    public static RevocationReasons getFromCliValue(String cliValue) {
        if(cliValue == null) {
            return null;
        }
        return cliLookupMap.get(cliValue);
    }
}