Class ZipContentEvidenceRecordDigestBuilder

java.lang.Object
eu.europa.esig.dss.asic.common.evidencerecord.ZipContentEvidenceRecordDigestBuilder
Direct Known Subclasses:
ASiCEvidenceRecordDigestBuilder

public class ZipContentEvidenceRecordDigestBuilder extends Object
Builds hashes for all documents present within a ZIP archive. Note: for covering an ASiC container with an evidence record, please use ASiCEvidenceRecordDigestBuilder
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected eu.europa.esig.dss.spi.x509.evidencerecord.digest.DataObjectDigestBuilderFactory
    Factory to be used to instantiate a new DataObjectDigestBuilder for hashes computation
    protected final eu.europa.esig.dss.enumerations.DigestAlgorithm
    The digest algorithm to be used on hash computation.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Empty constructor
    protected
    ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)
    Constructor with defined digest algorithm
     
    ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.model.DSSDocument zipContainer)
    Creates a ZipContentEvidenceRecordDigestBuilder to build hashes from a DSSDocument, represented by a ZIP container, using a default SHA-256 digest algorithm
     
    ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.model.DSSDocument zipContainer, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)
    Creates a ZipContentEvidenceRecordDigestBuilder to build hashes with the provided DigestAlgorithm from a DSSDocument, represented by a ZIP container
  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    This method verifies whether the configuration of the current builder class is valid
    List<eu.europa.esig.dss.model.Digest>
    Builds a list of hashes for the content files of the provided ZIP container
    protected List<eu.europa.esig.dss.model.Digest>
    computeDigestForDocuments(List<eu.europa.esig.dss.model.DSSDocument> documents)
    Computes a list of digests for the given list of DSSDocuments
    setDataObjectDigestBuilderFactory(eu.europa.esig.dss.spi.x509.evidencerecord.digest.DataObjectDigestBuilderFactory dataObjectDigestBuilderFactory)
    Sets a factory to instantiate a new DataObjectDigestBuilder for hashes computation of the given evidence record type (e.g.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • digestAlgorithm

      protected final eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm
      The digest algorithm to be used on hash computation. Default : DigestAlgorithm.SHA256
    • dataObjectDigestBuilderFactory

      protected eu.europa.esig.dss.spi.x509.evidencerecord.digest.DataObjectDigestBuilderFactory dataObjectDigestBuilderFactory
      Factory to be used to instantiate a new DataObjectDigestBuilder for hashes computation
  • Constructor Details

    • ZipContentEvidenceRecordDigestBuilder

      protected ZipContentEvidenceRecordDigestBuilder()
      Empty constructor
    • ZipContentEvidenceRecordDigestBuilder

      protected ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)
      Constructor with defined digest algorithm
      Parameters:
      digestAlgorithm - DigestAlgorithm
    • ZipContentEvidenceRecordDigestBuilder

      public ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.model.DSSDocument zipContainer)
      Creates a ZipContentEvidenceRecordDigestBuilder to build hashes from a DSSDocument, represented by a ZIP container, using a default SHA-256 digest algorithm
      Parameters:
      zipContainer - DSSDocument representing a ZIP container, which content will be covered by an Evidence Record
    • ZipContentEvidenceRecordDigestBuilder

      public ZipContentEvidenceRecordDigestBuilder(eu.europa.esig.dss.model.DSSDocument zipContainer, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm)
      Creates a ZipContentEvidenceRecordDigestBuilder to build hashes with the provided DigestAlgorithm from a DSSDocument, represented by a ZIP container
      Parameters:
      zipContainer - DSSDocument representing a ZIP container, which content will be covered by an Evidence Record
      digestAlgorithm - DigestAlgorithm to be used on digest computation
  • Method Details

    • setDataObjectDigestBuilderFactory

      public ZipContentEvidenceRecordDigestBuilder setDataObjectDigestBuilderFactory(eu.europa.esig.dss.spi.x509.evidencerecord.digest.DataObjectDigestBuilderFactory dataObjectDigestBuilderFactory)
      Sets a factory to instantiate a new DataObjectDigestBuilder for hashes computation of the given evidence record type (e.g. XMLERS or ASN.1 ERS)
      Parameters:
      dataObjectDigestBuilderFactory - DataObjectDigestBuilderFactory
      Returns:
      this ZipContentEvidenceRecordDigestBuilder
    • buildDigestGroup

      public List<eu.europa.esig.dss.model.Digest> buildDigestGroup()
      Builds a list of hashes for the content files of the provided ZIP container
      Returns:
      a list of Digests
    • assertConfigurationValid

      protected void assertConfigurationValid()
      This method verifies whether the configuration of the current builder class is valid
    • computeDigestForDocuments

      protected List<eu.europa.esig.dss.model.Digest> computeDigestForDocuments(List<eu.europa.esig.dss.model.DSSDocument> documents)
      Computes a list of digests for the given list of DSSDocuments
      Parameters:
      documents - a list of DSSDocuments to compute digests for
      Returns:
      a list of Digests