Module jpms_dss_document
Package eu.europa.esig.dss.validation.evidencerecord

Interface EvidenceRecord

All Superinterfaces:
eu.europa.esig.dss.model.identifier.IdentifierBasedObject
public interface EvidenceRecord extends eu.europa.esig.dss.model.identifier.IdentifierBasedObject
Representation of an Evidence Record

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExternalEvidenceRecord(EvidenceRecord evidenceRecord)
    This method allows to add an external evidence record covering the current evidence record.
    eu.europa.esig.dss.spi.x509.TokenCertificateSource
    getCertificateSource()
    Gets a certificate source which contains ALL certificates embedded in the evidence record.
    eu.europa.esig.dss.spi.x509.revocation.OfflineRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL>
    getCRLSource()
    Gets a CRL source which contains ALL CRLs embedded in the evidence record.
    List<eu.europa.esig.dss.model.DSSDocument>
    getDetachedContents()
    Returns detached contents
    List<EvidenceRecord>
    getDetachedEvidenceRecords()
    Returns a list of detached evidence records covering the current evidence record.
    byte[]
    getEncoded()
    Returns binaries of the evidence record document
    List<eu.europa.esig.dss.model.scope.SignatureScope>
    getEvidenceRecordScopes()
    Returns a list of covered archival data objects
    String
    getFilename()
    Returns a name of the evidence record document, when present
    String
    getId()
    This method returns the DSS unique signature id.
    eu.europa.esig.dss.model.ManifestFile
    getManifestFile()
    Returns a manifest file associated with the evidence record (used in ASiC)
    eu.europa.esig.dss.spi.x509.revocation.OfflineRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP>
    getOCSPSource()
    Gets an OCSP source which contains ALL OCSP responses embedded in the evidence record.
    eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum
    getReferenceRecordType()
    Returns type of the evidence record
    List<eu.europa.esig.dss.model.ReferenceValidation>
    getReferenceValidation()
    Returns a list of archive data object validations
    List<String>
    getStructureValidationResult()
    Returns a message if the structure validation fails
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference>
    getTimestampedReferences()
    Returns a list of references covered by the evidence record
    List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    getTimestamps()
    Returns a list of incorporated timestamp tokens
    void
    setEvidenceRecordScopes(List<eu.europa.esig.dss.model.scope.SignatureScope> evidenceRecordScopes)
    Sets a list of covered archival data objects
    void
    setTimestampedReferences(List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> timestampedReferences)
    Sets references to objects covered by the evidence record

    Methods inherited from interface eu.europa.esig.dss.model.identifier.IdentifierBasedObject

    getDSSId

  • Method Details

    • getFilename

      String getFilename()
      Returns a name of the evidence record document, when present
      Returns:
      String

    • getReferenceValidation

      List<eu.europa.esig.dss.model.ReferenceValidation> getReferenceValidation()
      Returns a list of archive data object validations
      Returns:
      a list of ReferenceValidation objects corresponding to each archive data object validation

    • getDetachedContents

      List<eu.europa.esig.dss.model.DSSDocument> getDetachedContents()
      Returns detached contents
      Returns:
      in the case of the detached signature this is the List of signed contents.

    • getCertificateSource

      eu.europa.esig.dss.spi.x509.TokenCertificateSource getCertificateSource()
      Gets a certificate source which contains ALL certificates embedded in the evidence record.
      Returns:
      CertificateSource

    • getCRLSource

      eu.europa.esig.dss.spi.x509.revocation.OfflineRevocationSource<eu.europa.esig.dss.model.x509.revocation.crl.CRL> getCRLSource()
      Gets a CRL source which contains ALL CRLs embedded in the evidence record.
      Returns:
      OfflineRevocationSource

    • getOCSPSource

      eu.europa.esig.dss.spi.x509.revocation.OfflineRevocationSource<eu.europa.esig.dss.model.x509.revocation.ocsp.OCSP> getOCSPSource()
      Gets an OCSP source which contains ALL OCSP responses embedded in the evidence record.
      Returns:
      OfflineRevocationSource

    • getTimestamps

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getTimestamps()
      Returns a list of incorporated timestamp tokens
      Returns:
      a list of TimestampTokens

    • getDetachedEvidenceRecords

      List<EvidenceRecord> getDetachedEvidenceRecords()
      Returns a list of detached evidence records covering the current evidence record.
      Returns:
      a list of EvidenceRecords

    • addExternalEvidenceRecord

      void addExternalEvidenceRecord(EvidenceRecord evidenceRecord)
      This method allows to add an external evidence record covering the current evidence record.
      Parameters:
      evidenceRecord - EvidenceRecord

    • getEvidenceRecordScopes

      List<eu.europa.esig.dss.model.scope.SignatureScope> getEvidenceRecordScopes()
      Returns a list of covered archival data objects
      Returns:
      a list of SignatureScopes

    • setEvidenceRecordScopes

      void setEvidenceRecordScopes(List<eu.europa.esig.dss.model.scope.SignatureScope> evidenceRecordScopes)
      Sets a list of covered archival data objects
      Parameters:
      evidenceRecordScopes - a list of SignatureScopes

    • getStructureValidationResult

      List<String> getStructureValidationResult()
      Returns a message if the structure validation fails
      Returns:
      a list of String error messages if validation fails, an empty list if structural validation succeeds

    • getReferenceRecordType

      eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum getReferenceRecordType()
      Returns type of the evidence record
      Returns:
      EvidenceRecordTypeEnum

    • getManifestFile

      eu.europa.esig.dss.model.ManifestFile getManifestFile()
      Returns a manifest file associated with the evidence record (used in ASiC)
      Returns:
      ManifestFile

    • getTimestampedReferences

      List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> getTimestampedReferences()
      Returns a list of references covered by the evidence record
      Returns:
      a list of TimestampedReferences

    • setTimestampedReferences

      void setTimestampedReferences(List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> timestampedReferences)
      Sets references to objects covered by the evidence record
      Parameters:
      timestampedReferences - a list of TimestampedReferences

    • getId

      String getId()
      This method returns the DSS unique signature id. It allows to unambiguously identify each signature.
      Returns:
      The signature unique Id

    • getEncoded

      byte[] getEncoded()
      Returns binaries of the evidence record document
      Returns:
      byte array