Class SignatureValidationProperties


  • public class SignatureValidationProperties
    extends java.lang.Object
    Class which stores properties, which are related to signature validation process.
    • Field Detail

      • DEFAULT_CONTINUE_AFTER_FAILURE

        public static final boolean DEFAULT_CONTINUE_AFTER_FAILURE
        See Also:
        Constant Field Values
      • DEFAULT_FRESHNESS_PRESENT_CRL

        public static final java.time.Duration DEFAULT_FRESHNESS_PRESENT_CRL
      • DEFAULT_FRESHNESS_PRESENT_OCSP

        public static final java.time.Duration DEFAULT_FRESHNESS_PRESENT_OCSP
      • DEFAULT_FRESHNESS_HISTORICAL

        public static final java.time.Duration DEFAULT_FRESHNESS_HISTORICAL
      • ocspClients

        private final java.util.List<IOcspClient> ocspClients
      • crlClients

        private final java.util.List<ICrlClient> crlClients
    • Method Detail

      • getFreshness

        public java.time.Duration getFreshness​(ValidationContext validationContext)
        Returns the freshness setting for the provided validation context or the default context in milliseconds.
        Parameters:
        validationContext - the validation context for which to retrieve the freshness setting
        Returns:
        the freshness setting for the provided validation context or the default context in milliseconds
      • setFreshness

        public final SignatureValidationProperties setFreshness​(ValidatorContexts validatorContexts,
                                                                CertificateSources certificateSources,
                                                                TimeBasedContexts timeBasedContexts,
                                                                java.time.Duration value)
        Sets the freshness setting for the specified validator, time based and certificate source contexts in milliseconds.

        This parameter specifies how old revocation data can be, compared to validation time, in order to be trustworthy.

        Parameters:
        validatorContexts - the validators for which to apply the setting
        certificateSources - the certificate sources to
        timeBasedContexts - the date comparison context for which to apply the setting
        value - the settings value in milliseconds
        Returns:
        this same SignatureValidationProperties instance.
      • getContinueAfterFailure

        public boolean getContinueAfterFailure​(ValidationContext validationContext)
        Returns the Continue after failure setting for the provided context or the default context.
        Parameters:
        validationContext - the context for which to retrieve the Continue after failure setting
        Returns:
        the Continue after failure setting for the provided context or the default context
      • setContinueAfterFailure

        public final SignatureValidationProperties setContinueAfterFailure​(ValidatorContexts validatorContexts,
                                                                           CertificateSources certificateSources,
                                                                           boolean value)
        Sets the Continue after failure setting for the provided context.

        This parameter specifies if validation is expected to continue after first failure is encountered. Only ValidationReport.ValidationResult.INVALID is considered to be a failure.

        Parameters:
        validatorContexts - the validators for which to set the Continue after failure setting
        certificateSources - the certificateSources for which to set the Continue after failure setting
        value - the Continue after failure setting
        Returns:
        this same SignatureValidationProperties instance.
      • getRevocationOnlineFetching

        public SignatureValidationProperties.OnlineFetching getRevocationOnlineFetching​(ValidationContext validationContext)
        Sets the onlineFetching property representing possible online fetching permissions.
        Parameters:
        validationContext - the context for which to retrieve the online fetching setting
        Returns:
        the online fetching setting.
      • getRequiredExtensions

        public java.util.List<CertificateExtension> getRequiredExtensions​(ValidationContext validationContext)
        Returns required extension for the provided validation context.
        Parameters:
        validationContext - the validation context for which to retrieve required extensions
        Returns:
        required extensions for the provided validation context
      • getCrlClients

        public java.util.List<ICrlClient> getCrlClients()
        Gets all ICrlClient instances which will be used to retrieve CRL responses during the validation.
        Returns:
        all ICrlClient instances which will be used to retrieve CRL responses during the validation
      • getOcspClients

        public java.util.List<IOcspClient> getOcspClients()
        Gets all IOcspClient instances which will be used to retrieve OCSP responses during the validation.
        Returns:
        all IOcspClient instances which will be used to retrieve OCSP responses during the validation
      • setParameterValueFor

        final void setParameterValueFor​(java.util.EnumSet<ValidatorContext> validatorContexts,
                                        java.util.EnumSet<CertificateSource> certificateSources,
                                        java.util.EnumSet<TimeBasedContext> timeBasedContexts,
                                        java.util.function.Consumer<SignatureValidationProperties.ContextProperties> setter)
        This method executes the setter method for every combination of selected validators and certificateSources
        Parameters:
        validatorContexts - the validators to execute the setter on
        certificateSources - the certificate sources to execute the setter on
        setter - the setter to execute
      • getParametersValueFor

        <T> T getParametersValueFor​(ValidatorContext validatorContext,
                                    CertificateSource certSource,
                                    TimeBasedContext timeBasedContext,
                                    java.util.function.Function<SignatureValidationProperties.ContextProperties,​T> getter)
        This method executes the getter method to the most granular parameters set down until the getter returns a non-null value
        Type Parameters:
        T - the type of the return value of this method and the getter method
        Parameters:
        validatorContext - the validator for which the value is to be retrieved
        certSource - the certificate source for which the value is to be retrieved
        getter - the getter to get the value from the parameters set
        Returns:
        the first non-null value returned.