Package com.itextpdf.signatures.validation

Class ValidatorChainBuilder

  • public class ValidatorChainBuilder
extends java.lang.Object
    A builder class to construct all necessary parts of a validation chain. The builder can be reused to create multiple instances of a validator.

    • Field Detail

      • certificateChainValidatorFactory

        private java.util.function.Supplier<CertificateChainValidator> certificateChainValidatorFactory

      • revocationDataValidatorFactory

        private java.util.function.Supplier<RevocationDataValidator> revocationDataValidatorFactory

      • ocspValidatorFactory

        private java.util.function.Supplier<OCSPValidator> ocspValidatorFactory

      • crlValidatorFactory

        private java.util.function.Supplier<CRLValidator> crlValidatorFactory

      • resourceRetrieverFactory

        private java.util.function.Supplier<IResourceRetriever> resourceRetrieverFactory

      • documentRevisionsValidatorFactory

        private java.util.function.Supplier<DocumentRevisionsValidator> documentRevisionsValidatorFactory

      • crlClientFactory

        private java.util.function.Supplier<ICrlClient> crlClientFactory

      • trustedCertificates

        private java.util.Collection<java.security.cert.Certificate> trustedCertificates

      • knownCertificates

        private java.util.Collection<java.security.cert.Certificate> knownCertificates

    • Constructor Detail

      • ValidatorChainBuilder

        public ValidatorChainBuilder()
        Creates a ValidatorChainBuilder using default implementations

    • Method Detail

      • buildSignatureValidator

        public SignatureValidator buildSignatureValidator​(PdfDocument document)
        Create a new SignatureValidator instance with the current configuration. This method can be used to create multiple validators.
        Parameters:
        document - PdfDocument instance which will be validated
        Returns:
        a new instance of a signature validator.

      • buildDocumentRevisionsValidator

        public DocumentRevisionsValidator buildDocumentRevisionsValidator()
        Create a bew DocumentRevisionsValidator instance with the current configuration. This method can be used to create multiple validators.
        Returns:
        a new instance of a document revisions validator.

      • buildCertificateChainValidator

        public CertificateChainValidator buildCertificateChainValidator()
        Create a new CertificateChainValidator instance. This method can be used to create multiple validators.
        Returns:
        a new instance of a CertificateChainValidator.

      • buildRevocationDataValidator

        public RevocationDataValidator buildRevocationDataValidator()
        Create a new RevocationDataValidator instance This method can be used to create multiple validators.
        Returns:
        a new instance of a RevocationDataValidator.

      • buildOCSPValidator

        public OCSPValidator buildOCSPValidator()
        Create a new OCSPValidator instance. This method can be used to create multiple validators.
        Returns:
        a new instance of a OCSPValidator.

      • buildCRLValidator

        public CRLValidator buildCRLValidator()
        Create a new CRLValidator instance. This method can be used to create multiple validators.
        Returns:
        a new instance of a CRLValidator.

      • withDocumentRevisionsValidatorFactory

        public ValidatorChainBuilder withDocumentRevisionsValidatorFactory​(java.util.function.Supplier<DocumentRevisionsValidator> documentRevisionsValidatorFactory)
        Use this factory method to create instances of DocumentRevisionsValidator for use in the validation chain.
        Parameters:
        documentRevisionsValidatorFactory - the document revisions validator factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withCRLValidatorFactory

        public ValidatorChainBuilder withCRLValidatorFactory​(java.util.function.Supplier<CRLValidator> crlValidatorFactory)
        Use this factory method to create instances of CRLValidator for use in the validation chain.
        Parameters:
        crlValidatorFactory - the CRLValidatorFactory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withResourceRetriever

        public ValidatorChainBuilder withResourceRetriever​(java.util.function.Supplier<IResourceRetriever> resourceRetrieverFactory)
        Use this factory method to create instances of IResourceRetriever for use in the validation chain.
        Parameters:
        resourceRetrieverFactory - the ResourceRetrieverFactory method to use.
        Returns:
        the current ValidatorChainBuilder.

      • withOCSPValidatorFactory

        public ValidatorChainBuilder withOCSPValidatorFactory​(java.util.function.Supplier<OCSPValidator> ocspValidatorFactory)
        Use this factory method to create instances of OCSPValidator for use in the validation chain.
        Parameters:
        ocspValidatorFactory - the OCSPValidatorFactory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withRevocationDataValidatorFactory

        public ValidatorChainBuilder withRevocationDataValidatorFactory​(java.util.function.Supplier<RevocationDataValidator> revocationDataValidatorFactory)
        Use this factory method to create instances of RevocationDataValidator for use in the validation chain.
        Parameters:
        revocationDataValidatorFactory - the RevocationDataValidator factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withCertificateChainValidatorFactory

        public ValidatorChainBuilder withCertificateChainValidatorFactory​(java.util.function.Supplier<CertificateChainValidator> certificateChainValidatorFactory)
        Use this factory method to create instances of CertificateChainValidator for use in the validation chain.
        Parameters:
        certificateChainValidatorFactory - the CertificateChainValidator factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withIssuingCertificateRetrieverFactory

        public ValidatorChainBuilder withIssuingCertificateRetrieverFactory​(java.util.function.Supplier<IssuingCertificateRetriever> certificateRetrieverFactory)
        Use this factory method to create instances of IssuingCertificateRetriever for use in the validation chain.
        Parameters:
        certificateRetrieverFactory - the IssuingCertificateRetriever factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withOcspClient

        public ValidatorChainBuilder withOcspClient​(java.util.function.Supplier<IOcspClientBouncyCastle> ocspClientFactory)
        Use this factory to create instances of IOcspClientBouncyCastle for use in the validation chain.
        Parameters:
        ocspClientFactory - the IOcspClient factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withCrlClient

        public ValidatorChainBuilder withCrlClient​(java.util.function.Supplier<ICrlClient> crlClientFactory)
        Use this factory to create instances of ICrlClient for use in the validation chain.
        Parameters:
        crlClientFactory - the ICrlClient factory method to use
        Returns:
        the current ValidatorChainBuilder.

      • withKnownCertificates

        public ValidatorChainBuilder withKnownCertificates​(java.util.Collection<java.security.cert.Certificate> knownCertificates)
        Adds known certificates to the IssuingCertificateRetriever.
        Parameters:
        knownCertificates - the list of known certificates to add
        Returns:
        the current ValidatorChainBuilder.

      • withTrustedCertificates

        public ValidatorChainBuilder withTrustedCertificates​(java.util.Collection<java.security.cert.Certificate> trustedCertificates)
        Sets the trusted certificates to the IssuingCertificateRetriever.
        Parameters:
        trustedCertificates - the list of trusted certificates to set
        Returns:
        the current ValidatorChainBuilder.

      • getCrlClient

        ICrlClient getCrlClient()
        Retrieves the explicitly added or automatically created ICrlClient instance.
        Returns:
        the explicitly added or automatically created ICrlClient instance.

      • getCRLValidator

        CRLValidator getCRLValidator()
        Retrieves the explicitly added or automatically created CRLValidator instance.
        Returns:
        the explicitly added or automatically created CRLValidator instance.

      • getOCSPValidator

        OCSPValidator getOCSPValidator()
        Retrieves the explicitly added or automatically created OCSPValidator instance.
        Returns:
        the explicitly added or automatically created OCSPValidator instance.