Class SignedDocumentDiagnosticDataBuilder

java.lang.Object
eu.europa.esig.dss.validation.reports.diagnostic.DiagnosticDataBuilder
eu.europa.esig.dss.validation.reports.diagnostic.SignedDocumentDiagnosticDataBuilder
Direct Known Subclasses:
QWACCertificateDiagnosticDataBuilder
public class SignedDocumentDiagnosticDataBuilder extends DiagnosticDataBuilder
The common class for DiagnosticData creation from a signed/timestamped document

  • Field Details

    • signedDocument

      protected eu.europa.esig.dss.model.DSSDocument signedDocument
      The signed document

    • signatures

      protected Collection<eu.europa.esig.dss.spi.signature.AdvancedSignature> signatures
      The collection of signatures

    • usedTimestamps

      protected Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> usedTimestamps
      The collection of timestamp tokens

    • evidenceRecords

      protected Collection<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> evidenceRecords
      The collection of evidence records

    • documentCertificateSource

      protected eu.europa.esig.dss.spi.x509.ListCertificateSource documentCertificateSource
      The list of all certificate sources extracted from a validating document (signature(s), timestamp(s))

    • documentCRLSource

      protected eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL> documentCRLSource
      The list of all CRL revocation sources extracted from a validating document (signature(s), timestamp(s))

    • documentOCSPSource

      protected eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP> documentOCSPSource
      The list of all OCSP revocation sources extracted from a validating document (signature(s), timestamp(s))

    • xmlSignaturesMap

      protected Map<String, eu.europa.esig.dss.diagnostic.jaxb.XmlSignature> xmlSignaturesMap
      The cached map of signatures

    • xmlTimestampsMap

      protected Map<String, eu.europa.esig.dss.diagnostic.jaxb.XmlTimestamp> xmlTimestampsMap
      The cached map of timestamps

    • xmlEvidenceRecordMap

      protected Map<String, eu.europa.esig.dss.diagnostic.jaxb.XmlEvidenceRecord> xmlEvidenceRecordMap
      The cached map of evidence records

    • xmlSignedDataMap

      protected Map<String, eu.europa.esig.dss.diagnostic.jaxb.XmlSignerData> xmlSignedDataMap
      The cached map of original signed data

  • Constructor Details

    • SignedDocumentDiagnosticDataBuilder

      public SignedDocumentDiagnosticDataBuilder()
      Default constructor instantiating object with null values and empty maps

  • Method Details

    • usedCertificates

      public SignedDocumentDiagnosticDataBuilder usedCertificates(Set<eu.europa.esig.dss.model.x509.CertificateToken> usedCertificates)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set the used certificates
      Overrides:
      usedCertificates in class DiagnosticDataBuilder
      Parameters:
      usedCertificates - the used certificates
      Returns:
      the builder

    • usedRevocations

      public SignedDocumentDiagnosticDataBuilder usedRevocations(Set<eu.europa.esig.dss.spi.x509.revocation.RevocationToken<?>> usedRevocations)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set the used revocation data
      Overrides:
      usedRevocations in class DiagnosticDataBuilder
      Parameters:
      usedRevocations - the used revocation data
      Returns:
      the builder

    • allCertificateSources

      public SignedDocumentDiagnosticDataBuilder allCertificateSources(eu.europa.esig.dss.spi.x509.ListCertificateSource trustedCertSources)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set ListCertificateSource containing all certificate sources used in the validator (including trusted certificate sources)
      Overrides:
      allCertificateSources in class DiagnosticDataBuilder
      Parameters:
      trustedCertSources - the list of trusted lists certificate sources
      Returns:
      the builder

    • validationDate

      public SignedDocumentDiagnosticDataBuilder validationDate(Date validationDate)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set the validation date
      Overrides:
      validationDate in class DiagnosticDataBuilder
      Parameters:
      validationDate - the validation date
      Returns:
      the builder

    • tokenExtractionStrategy

      public SignedDocumentDiagnosticDataBuilder tokenExtractionStrategy(eu.europa.esig.dss.enumerations.TokenExtractionStrategy tokenExtractionStrategy)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set the TokenExtractionStrategy to follow for the token extraction
      Overrides:
      tokenExtractionStrategy in class DiagnosticDataBuilder
      Parameters:
      tokenExtractionStrategy - TokenExtractionStrategy to use
      Returns:
      the builder

    • defaultDigestAlgorithm

      public SignedDocumentDiagnosticDataBuilder defaultDigestAlgorithm(eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)
      Description copied from class: DiagnosticDataBuilder
      This method allows to set the default DigestAlgorithm which will be used for tokens' DigestAlgoAndValue calculation
      Overrides:
      defaultDigestAlgorithm in class DiagnosticDataBuilder
      Parameters:
      digestAlgorithm - DigestAlgorithm to set as default
      Returns:
      the builder

    • document

      public SignedDocumentDiagnosticDataBuilder document(eu.europa.esig.dss.model.DSSDocument signedDocument)
      This method allows to set the document which is analysed
      Parameters:
      signedDocument - the document which is analysed
      Returns:
      the builder

    • foundSignatures

      public SignedDocumentDiagnosticDataBuilder foundSignatures(Collection<eu.europa.esig.dss.spi.signature.AdvancedSignature> signatures)
      This method allows to set the found signatures
      Parameters:
      signatures - the found signatures
      Returns:
      the builder

    • usedTimestamps

      public SignedDocumentDiagnosticDataBuilder usedTimestamps(Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> usedTimestamps)
      This method allows to set the timestamps
      Parameters:
      usedTimestamps - a set of validated TimestampTokens
      Returns:
      the builder

    • foundEvidenceRecords

      public SignedDocumentDiagnosticDataBuilder foundEvidenceRecords(Collection<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> evidenceRecords)
      This method allows to set the evidence records
      Parameters:
      evidenceRecords - a set of found EvidenceRecords
      Returns:
      the builder

    • documentCertificateSource

      public SignedDocumentDiagnosticDataBuilder documentCertificateSource(eu.europa.esig.dss.spi.x509.ListCertificateSource documentCertificateSource)
      Sets a document Certificate Source containing all sources extracted from the provided signature(s)/timestamp(s)
      Parameters:
      documentCertificateSource - ListCertificateSource computed from document sources
      Returns:
      the builder

    • documentCRLSource

      public SignedDocumentDiagnosticDataBuilder documentCRLSource(eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL> documentCRLSource)
      Sets a document CRL Source containing all sources extracted from the provided signature(s)/timestamp(s)
      Parameters:
      documentCRLSource - ListRevocationSource computed from document sources
      Returns:
      the builder

    • documentOCSPSource

      public SignedDocumentDiagnosticDataBuilder documentOCSPSource(eu.europa.esig.dss.spi.x509.revocation.ListRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP> documentCRLSource)
      Sets a document OCSP Source containing all sources extracted from the provided signature(s)/timestamp(s)
      Parameters:
      documentCRLSource - ListRevocationSource computed from document sources
      Returns:
      the builder

    • build

      public eu.europa.esig.dss.diagnostic.jaxb.XmlDiagnosticData build()
      Builds XmlDiagnosticData
      Overrides:
      build in class DiagnosticDataBuilder
      Returns:
      XmlDiagnosticData

    • assertConfigurationValid

      protected void assertConfigurationValid()
      This method verifies whether the configuration is valid in order to build a Diagnostic Data

    • linkSigningCertificateAndChains

      protected void linkSigningCertificateAndChains(Set<eu.europa.esig.dss.model.x509.CertificateToken> certificates)
      Description copied from class: DiagnosticDataBuilder
      Links the certificates and their certificate chains
      Overrides:
      linkSigningCertificateAndChains in class DiagnosticDataBuilder
      Parameters:
      certificates - a set of CertificateTokens

    • buildDetachedXmlSignature

      public eu.europa.esig.dss.diagnostic.jaxb.XmlSignature buildDetachedXmlSignature(eu.europa.esig.dss.spi.signature.AdvancedSignature signature)
      Builds XmlSignature
      Parameters:
      signature - AdvancedSignature
      Returns:
      XmlSignature

    • emptyToNull

      protected String emptyToNull(String text)
      If text is empty returns NULL, or original text otherwise
      Parameters:
      text - String
      Returns:
      String

    • createOrphanTokenFromRevocationIdentifier

      protected <R extends eu.europa.esig.dss.model.x509.revocation.Revocation> eu.europa.esig.dss.diagnostic.jaxb.XmlOrphanRevocationToken createOrphanTokenFromRevocationIdentifier(eu.europa.esig.dss.model.identifier.EncapsulatedRevocationTokenIdentifier<R> revocationIdentifier)
      Creates an orphan revocation token from EncapsulatedRevocationTokenIdentifier
      Type Parameters:
      R - Revocation
      Parameters:
      revocationIdentifier - EncapsulatedRevocationTokenIdentifier
      Returns:
      XmlOrphanRevocationToken

    • buildDetachedXmlTimestamp

      protected eu.europa.esig.dss.diagnostic.jaxb.XmlTimestamp buildDetachedXmlTimestamp(eu.europa.esig.dss.spi.x509.tsp.TimestampToken timestampToken)
      This method builds XmlTimestamp from TimestampToken
      Parameters:
      timestampToken - TimestampToken
      Returns:
      XmlTimestamp

    • getXmlSignerInformationStore

      protected List<eu.europa.esig.dss.diagnostic.jaxb.XmlSignerInfo> getXmlSignerInformationStore(Set<eu.europa.esig.dss.spi.x509.SignerIdentifier> signerIdentifiers)
      Builds a list of XmlSignerInfo from SignerIdentifiers
      Parameters:
      signerIdentifiers - a set of SignerIdentifier
      Returns:
      a list of XmlSignerInfos