Module jpms_dss_detailed_report
Package eu.europa.esig.dss.detailedreport

Class DetailedReport

java.lang.Object
eu.europa.esig.dss.detailedreport.DetailedReport
public class DetailedReport extends Object
This class represents the detailed report built during the validation process. It contains information on each executed constraint. It is composed among other of the following building blocks:
- Identification of the Signer's Certificate (ISC)
- Validation Context Initialization (VCI)
- X.509 Certificate Validation (XCV)
- Cryptographic Verification (CV)
- Signature Acceptance Validation (SAV)
- Basic Validation Process
- Validation Process for Time-Stamps
- Validation Process for AdES-T
- Validation of LTV forms

  • Constructor Details

  • Method Details

    • getBasicBuildingBlocksIndication

      public eu.europa.esig.dss.enumerations.Indication getBasicBuildingBlocksIndication(String tokenId)
      This method returns the result of the Basic Building Block for a token (signature, timestamp, revocation)
      Parameters:
      tokenId - the token identifier
      Returns:
      the Indication

    • getBasicBuildingBlocksSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getBasicBuildingBlocksSubIndication(String tokenId)
      This method returns the result of the Basic Building Block for a token (signature, timestamp, revocation)
      Parameters:
      tokenId - the token identifier
      Returns:
      the SubIndication

    • getBasicBuildingBlocksCertChain

      public List<String> getBasicBuildingBlocksCertChain(String tokenId)
      Returns a list of certificate token ids representing the certificate chain of the token in question
      Parameters:
      tokenId - String id of a token to get certificate chain for
      Returns:
      a list of String ids

    • getBasicBuildingBlockById

      public XmlBasicBuildingBlocks getBasicBuildingBlockById(String tokenId)
      This method returns the full content of the Basic Building Block for a token (signature, timestamp, revocation)
      Parameters:
      tokenId - the token identifier
      Returns:
      the XmlBasicBuildingBlocks

    • getBasicBuildingBlocksNumber

      public int getBasicBuildingBlocksNumber()
      Returns the number of Basic Building Blocks.
      Returns:
      int number of Basic Building Blocks

    • getBasicBuildingBlocksSignatureId

      public String getBasicBuildingBlocksSignatureId(int index)
      Returns the id of the token. The signature is identified by its index: 0 for the first one.
      Parameters:
      index - (position/order) of the signature within the report
      Returns:
      String identifying the token

    • getSignatureIds

      public List<String> getSignatureIds()
      Returns a list of all signature ids
      Returns:
      a list of String ids

    • getFirstSignatureId

      public String getFirstSignatureId()
      This method returns the first signature id.
      Returns:
      the first signature id

    • getFirstTimestampId

      public String getFirstTimestampId()
      This method returns the first timestamp id.
      Returns:
      the first timestamp id

    • getTimestampIds

      public List<String> getTimestampIds()
      Returns a list of all timestamp ids
      Returns:
      a list of String ids

    • getFirstEvidenceRecordId

      public String getFirstEvidenceRecordId()
      This method returns the first evidence record id.
      Returns:
      the first evidence record id

    • getEvidenceRecordIds

      public List<String> getEvidenceRecordIds()
      Returns a list of all evidence record ids
      Returns:
      a list of String ids

    • getRevocationIds

      public List<String> getRevocationIds()
      Returns a list of all revocation data ids
      Returns:
      a list of String ids

    • getBestSignatureTime

      public Date getBestSignatureTime(String signatureId)
      Returns best-signature-time for the signature with id
      Parameters:
      signatureId - String
      Returns:
      Date

    • getBestProofOfExistence

      public XmlProofOfExistence getBestProofOfExistence(String signatureId)
      Gets best proof-of-existence for the signature with id
      Parameters:
      signatureId - String
      Returns:
      XmlProofOfExistence

    • getEvidenceRecordLowestPOETime

      public Date getEvidenceRecordLowestPOETime(String evidenceRecordId)
      Returns lowest POE of the evidence record with the given Id
      Parameters:
      evidenceRecordId - String id of the evidence record to get POE for
      Returns:
      Date

    • getBasicValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getBasicValidationIndication(String signatureId)
      Gets basic validation indication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      Indication

    • getBasicValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getBasicValidationSubIndication(String signatureId)
      Gets basic validation subIndication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      SubIndication

    • getBasicTimestampValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getBasicTimestampValidationIndication(String timestampId)
      Gets timestamp basic validation indication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      Indication

    • getBasicTimestampValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getBasicTimestampValidationSubIndication(String timestampId)
      Gets timestamp basic validation subIndication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      Indication

    • getTimestampValidationIndication

      @Deprecated public eu.europa.esig.dss.enumerations.Indication getTimestampValidationIndication(String timestampId)
      Deprecated.
      since DSS 5.13. Use #getBasicTimestampValidationIndication(timestampId) instead
      Gets timestamp validation indication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      Indication

    • getTimestampValidationSubIndication

      @Deprecated public eu.europa.esig.dss.enumerations.SubIndication getTimestampValidationSubIndication(String timestampId)
      Deprecated.
      since DSS 5.13. Use #getBasicTimestampValidationSubIndication(timestampId) instead
      Gets timestamp validation subIndication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      Indication

    • getArchiveDataTimestampValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getArchiveDataTimestampValidationIndication(String timestampId)
      Gets timestamp validation with archive data indication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      Indication

    • getArchiveDataTimestampValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getArchiveDataTimestampValidationSubIndication(String timestampId)
      Gets timestamp validation with archive data subIndication for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      SubIndication

    • getEvidenceRecordValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getEvidenceRecordValidationIndication(String evidenceRecordId)
      Gets evidence record validation indication for an evidence record with id
      Parameters:
      evidenceRecordId - String
      Returns:
      Indication

    • getEvidenceRecordValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getEvidenceRecordValidationSubIndication(String evidenceRecordId)
      Gets evidence record validation subIndication for an evidence record with id
      Parameters:
      evidenceRecordId - String
      Returns:
      SubIndication

    • getXmlEvidenceRecordById

      public XmlEvidenceRecord getXmlEvidenceRecordById(String evidenceRecordId)
      Returns an XmlEvidenceRecord by the given id Null if the evidence record is not found
      Parameters:
      evidenceRecordId - String id of an evidence record to get
      Returns:
      XmlEvidenceRecord

    • getLongTermValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getLongTermValidationIndication(String signatureId)
      Gets long-term validation indication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      Indication

    • getLongTermValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getLongTermValidationSubIndication(String signatureId)
      Gets long-term validation subIndication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      Indication

    • getArchiveDataValidationIndication

      public eu.europa.esig.dss.enumerations.Indication getArchiveDataValidationIndication(String signatureId)
      Gets validation with archive data indication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      Indication

    • getArchiveDataValidationSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getArchiveDataValidationSubIndication(String signatureId)
      Gets validation with archive data subIndication for a signature with id
      Parameters:
      signatureId - String
      Returns:
      SubIndication

    • getSignatureQualification

      public eu.europa.esig.dss.enumerations.SignatureQualification getSignatureQualification(String signatureId)
      Gets qualification for a signature with id
      Parameters:
      signatureId - String
      Returns:
      SignatureQualification

    • getTimestampQualification

      public eu.europa.esig.dss.enumerations.TimestampQualification getTimestampQualification(String timestampId)
      Gets the final qualification result for a timestamp with id
      Parameters:
      timestampId - String
      Returns:
      TimestampQualification

    • getTimestampQualificationAtTstGenerationTime

      public eu.europa.esig.dss.enumerations.TimestampQualification getTimestampQualificationAtTstGenerationTime(String timestampId)
      Gets qualification for a timestamp with the given id at the timestamp generation time
      Parameters:
      timestampId - String
      Returns:
      TimestampQualification

    • getTimestampQualificationAtBestPoeTime

      public eu.europa.esig.dss.enumerations.TimestampQualification getTimestampQualificationAtBestPoeTime(String timestampId)
      Gets qualification for a timestamp with the given id at its best available POE time
      Parameters:
      timestampId - String
      Returns:
      TimestampQualification

    • getXmlTimestampById

      public XmlTimestamp getXmlTimestampById(String timestampId)
      Returns an XmlTimestamp by the given id Null if the timestamp is not found
      Parameters:
      timestampId - String id of a timestamp to get
      Returns:
      XmlTimestamp

    • getXmlSignatureById

      public XmlSignature getXmlSignatureById(String signatureId)
      Returns an XmlSignature by the given id Null if the signature is not found
      Parameters:
      signatureId - String id of a signature to get
      Returns:
      XmlSignature

    • getXmlCertificateById

      public XmlCertificate getXmlCertificateById(String certificateId)
      Returns an XmlCertificate by id if exists, null otherwise NOTE: should be used only for certificate validation process
      Parameters:
      certificateId - id of a certificate to extract
      Returns:
      XmlCertificate

    • getSignatures

      public List<XmlSignature> getSignatures()
      Returns a list of all signatures
      Returns:
      a list of XmlSignatures

    • getIndependentTimestamps

      public List<XmlTimestamp> getIndependentTimestamps()
      Returns a list of all independent (detached) timestamps
      Returns:
      a list of XmlTimestamps

    • getIndependentEvidenceRecords

      public List<XmlEvidenceRecord> getIndependentEvidenceRecords()
      Returns a list of all independent (detached) evidence records
      Returns:
      a list of XmlEvidenceRecords

    • getCertificates

      public List<XmlCertificate> getCertificates()
      Returns a list of processed XmlCertificates NOTE: the method returns not empty list only for certificate validation process
      Returns:
      list of XmlCertificates

    • getTLAnalysisById

      public XmlTLAnalysis getTLAnalysisById(String tlId)
      This method returns a complete block of a TL validation
      Parameters:
      tlId - the LOTL/TL identifier
      Returns:
      XmlTLAnalysis

    • getJAXBModel

      public XmlDetailedReport getJAXBModel()
      Returns the JAXB Detailed Report
      Returns:
      XmlDetailedReport

    • isCertificateValidation

      public boolean isCertificateValidation()
      Returns if the certificate validation has been performed (therefore the certificate corresponding data can be retrieved)
      Returns:
      if the certificate validation has been performed

    • getCertificateQualificationAtIssuance

      public eu.europa.esig.dss.enumerations.CertificateQualification getCertificateQualificationAtIssuance(String certificateId)
      Gets the qualification for certificate with id at its issuance time
      Parameters:
      certificateId - String
      Returns:
      CertificateQualification

    • getCertificateQualificationAtValidation

      public eu.europa.esig.dss.enumerations.CertificateQualification getCertificateQualificationAtValidation(String certificateId)
      Gets the qualification for certificate with id at the validation time
      Parameters:
      certificateId - String
      Returns:
      CertificateQualification

    • getCertificateXCVConclusion

      public XmlConclusion getCertificateXCVConclusion(String certificateId)
      Gets XCV building block conclusion for a certificate with id
      Parameters:
      certificateId - String
      Returns:
      XmlConclusion

    • getFinalConclusion

      public XmlConclusion getFinalConclusion(String tokenId)
      Returns the final validation conclusion for a token with a given Id
      Parameters:
      tokenId - String of a token to get the final validation conclusion result for
      Returns:
      XmlConclusion

    • getFinalIndication

      public eu.europa.esig.dss.enumerations.Indication getFinalIndication(String tokenId)
      Gets the validation indication to a token with id corresponding to the highest validation level
      Parameters:
      tokenId - String
      Returns:
      Indication

    • getFinalSubIndication

      public eu.europa.esig.dss.enumerations.SubIndication getFinalSubIndication(String tokenId)
      Gets the validation subIndication to a token with id corresponding to the highest validation level
      Parameters:
      tokenId - String
      Returns:
      Indication

    • getHighestConclusion

      public XmlConstraintsConclusion getHighestConclusion(String signatureId)
      Gets the validation conclusion to a signature with id corresponding to the highest validation level
      Parameters:
      signatureId - String
      Returns:
      Indication

    • getSigningCertificate

      public XmlSubXCV getSigningCertificate(String bbbId)
      Gets signing certificate validation block for the given BasicBuildingBlock
      Parameters:
      bbbId - String BBB's id
      Returns:
      XmlSubXCV

    • getAdESValidationErrors

      public List<eu.europa.esig.dss.jaxb.object.Message> getAdESValidationErrors(String tokenId)
      Returns a list of ETSI EN 319 102-1 AdES validation error messages for a token with the given id
      Parameters:
      tokenId - String
      Returns:
      a list of error Messages

    • getAdESValidationWarnings

      public List<eu.europa.esig.dss.jaxb.object.Message> getAdESValidationWarnings(String tokenId)
      Returns a list of ETSI EN 319 102-1 AdES validation warning messages for a token with the given id
      Parameters:
      tokenId - String
      Returns:
      a list of warning Messages

    • getAdESValidationInfos

      public List<eu.europa.esig.dss.jaxb.object.Message> getAdESValidationInfos(String tokenId)
      Returns a list of ETSI EN 319 102-1 AdES validation info messages for a token with the given id
      Parameters:
      tokenId - String
      Returns:
      a list of info Messages

    • getQualificationErrors

      public List<eu.europa.esig.dss.jaxb.object.Message> getQualificationErrors(String tokenId)
      Returns a list of qualification validation errors for a token with the given id
      Parameters:
      tokenId - String id of a token to get qualification errors for
      Returns:
      a list of Messages

    • getQualificationWarnings

      public List<eu.europa.esig.dss.jaxb.object.Message> getQualificationWarnings(String tokenId)
      Returns a list of qualification validation warnings for a token with the given id
      Parameters:
      tokenId - String id of a token to get qualification warnings for
      Returns:
      a list of Messages

    • getQualificationInfos

      public List<eu.europa.esig.dss.jaxb.object.Message> getQualificationInfos(String tokenId)
      Returns a list of qualification validation infos for a token with the given id
      Parameters:
      tokenId - String id of a token to get qualification infos for
      Returns:
      a list of Messages

    • getCertificateQualificationErrorsAtIssuanceTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationErrorsAtIssuanceTime(String certificateId)
      Returns a list of qualification validation errors for a certificate with the given id at certificate issuance time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification errors for
      Returns:
      a list of Messages

    • getCertificateQualificationWarningsAtIssuanceTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationWarningsAtIssuanceTime(String certificateId)
      Returns a list of qualification validation warnings for a certificate with the given id at certificate issuance time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification warnings for
      Returns:
      a list of Messages

    • getCertificateQualificationInfosAtIssuanceTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationInfosAtIssuanceTime(String certificateId)
      Returns a list of qualification validation information messages for a certificate with the given id at certificate issuance time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification information messages for
      Returns:
      a list of Messages

    • getCertificateQualificationErrorsAtValidationTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationErrorsAtValidationTime(String certificateId)
      Returns a list of qualification validation errors for a certificate with the given id at validation time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification errors for
      Returns:
      a list of Messages

    • getCertificateQualificationWarningsAtValidationTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationWarningsAtValidationTime(String certificateId)
      Returns a list of qualification validation warnings for a certificate with the given id at validation time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification warnings for
      Returns:
      a list of Messages

    • getCertificateQualificationInfosAtValidationTime

      public List<eu.europa.esig.dss.jaxb.object.Message> getCertificateQualificationInfosAtValidationTime(String certificateId)
      Returns a list of qualification validation information messages for a certificate with the given id at validation time NOTE: applicable only on certificate validation (see eu.europa.esig.dss.validation.CertificateValidator)
      Parameters:
      certificateId - String id of a certificate to get qualification information messages for
      Returns:
      a list of Messages