org.cesecore.keys.validation.Validator Maven / Gradle / Ivy

/*************************************************************************
 *                                                                       *
 *  CESeCore: CE Security Core                                           *
 *                                                                       *
 *  This software is free software; you can redistribute it and/or       *
 *  modify it under the terms of the GNU Lesser General                  *
 *  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.keys.validation;

import java.util.List;

import org.cesecore.certificates.ca.CAInfo;
import org.cesecore.internal.UpgradeableDataHashMap;
import org.cesecore.profiles.Profile;

/**
 * Base interface for validators. All validators must implement this interface.
 * 
 * @version $Id: Validator.java 28537 2018-03-21 12:21:25Z mikekushner $
 */

public interface Validator extends PhasedValidator, CertificateProfileAwareValidator, Profile, Cloneable {

    static final String TYPE_NAME = "VALIDATOR";
    
    /**
     * Initializes the key validator.
     */
    void init();

    /**
     * Populates the sub class specific key validator values with template values based on {@link ValidatorBase#getSettingsTemplate()}. 
     * Sub classes only need to implement this method if they support configuration templates.
     * @param template the validator settings template.
     */
    void setKeyValidatorSettingsTemplate(KeyValidatorSettingsTemplate template);
    
    /**
     * Gets the failed action index {@see #setFailedAction(int)}.
     * @return the index.
     */
    int getFailedAction();
    
    /**
     * Sets the failed action index {@link KeyValidationFailedActions}, defining what action should
     * be taken when validation fails, i.e. #validate returns errors
     * @param index the index.
     */
    void setFailedAction(int index);

    
    /**
     * Gets the not_applicable action index {@see #setNotApplicableAction(int).
     * @return the index.
     */
    int getNotApplicableAction();

    /**
     * Sets the not_applicable action index {@link KeyValidationFailedActions}, defining what action should
     * be taken when a Validator is not applicable for the input (for example ECC keys to an RSA key validator),
     * i.e. #validate throws ValidatorNotApplicableException
     * @param index the index.
     */
    void setNotApplicableAction(int index);

    /**
     * Gets a list of applicable CA types (X509 or CVC see {@link CAInfo.CATYPE_X509 or CAInfo.CATYPE_CVC}).
     * @return the list of class names of the allowed CA types.
     */
    List getApplicableCaTypes();
    
    /**
     * @return the settings template index.
     */
    Integer getSettingsTemplate();
    
    /**
     * Sets the settings template index.
     * @param type the type {@link KeyValidatorSettingsTemplate}.
     */
    void setSettingsTemplate(Integer option);
    
     /**
      * 
      * @return a display friendly string of this validator
      */
     String toDisplayString();

     /**
      * Clone has to be implemented instead of a copy constructor due to the fact that we'll be referring to implementations by this interface only. 
      * 
      * @return a deep copied clone of this validator
      */
      Validator clone();
      
      /**
       * @return the description.
       */
      public String getDescription();

      /**
       * @param description the description. 
       */
      void setDescription(String description);
      
      /** Implementation of UpgradableDataHashMap function getLatestVersion */    
      float getLatestVersion();
      
      UpgradeableDataHashMap getUpgradableHashmap();
      
      /**
       * Returns an identifier for the type of the approval profile.
       * @return type of approval, e.g. "RSA_KEY_VALIDATOR"
       */
      String getValidatorTypeIdentifier();
      
      /**
       * @return the type as a human readable name.
       */
      String getLabel();
      
      /**
       * @return the subtype of this validator
       */
      Class getValidatorSubType();
}