Module jpms_dss_spi
Package eu.europa.esig.dss.spi.x509.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 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

      TokenCertificateSource getCertificateSource()
      Gets a certificate source which contains ALL certificates embedded in the evidence record.
      Returns:
      CertificateSource

    • getCRLSource

      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

      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<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

    • getOriginalDigestAlgorithm

      eu.europa.esig.dss.enumerations.DigestAlgorithm getOriginalDigestAlgorithm()
      Gets a DigestAlgorithm used on the first data object group's digest computation
      Returns:
      DigestAlgorithm

    • 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

    • getEvidenceRecordType

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

    • getOrigin

      eu.europa.esig.dss.enumerations.EvidenceRecordOrigin getOrigin()
      Returns origin of the evidence record
      Returns:
      EvidenceRecordOrigin

    • getManifestFile

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

    • getTimestampedReferences

      List<TimestampedReference> getTimestampedReferences()
      Returns a list of references covered by the evidence record
      Returns:
      a list of TimestampedReferences

    • setTimestampedReferences

      void setTimestampedReferences(List<TimestampedReference> timestampedReferences)
      Sets references to objects covered by the evidence record
      Parameters:
      timestampedReferences - a list of TimestampedReferences

    • setEmbeddedEvidenceRecordHelper

      void setEmbeddedEvidenceRecordHelper(EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper)
      Sets a helper for processing and validation of the embedded evidence record type
      Parameters:
      embeddedEvidenceRecordHelper - EmbeddedEvidenceRecordHelper

    • isEmbedded

      boolean isEmbedded()
      Returns whether the evidence record is embedded in a signature
      Returns:
      TRUE if the evidence record is embedded, FALSE otherwise

    • getMasterSignature

      AdvancedSignature getMasterSignature()
      Gets a master signature, enveloping the current evidence record
      Returns:
      AdvancedSignature

    • getIncorporationType

      eu.europa.esig.dss.enumerations.EvidenceRecordIncorporationType getIncorporationType()
      Gets the type of the unsigned attribute used for incorporation of an evidence record within a signature NOTE: applicable only for embedded evidence records within CAdES
      Returns:
      EvidenceRecordIncorporationType

    • getEmbeddedEvidenceRecordHelper

      EmbeddedEvidenceRecordHelper getEmbeddedEvidenceRecordHelper()
      Returns an EmbeddedEvidenceRecordHelper in case of an embedded evidence record
      Returns:
      EmbeddedEvidenceRecordHelper

    • 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