Class AbstractASiCContainerAnalyzer

java.lang.Object
eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
eu.europa.esig.dss.asic.common.validation.AbstractASiCContainerAnalyzer
All Implemented Interfaces:
eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer

public abstract class AbstractASiCContainerAnalyzer extends eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
The abstract class for an ASiC container validation
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ASiCContent
    The container extraction result
    protected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer>
    List of evidence record document validators
    protected List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer>
    List of signature document analyzers
    protected List<eu.europa.esig.dss.spi.validation.analyzer.timestamp.TimestampAnalyzer>
    List of timestamp document validators

    Fields inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

    certificateVerifier, containerContents, detachedContents, detachedEvidenceRecordDocuments, document, manifestFile, signingCertificateSource
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Empty constructor
    protected
    The constructor with ASiCContent
    protected
    AbstractASiCContainerAnalyzer(eu.europa.esig.dss.model.DSSDocument document)
    The default constructor
  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    addReference(eu.europa.esig.dss.model.scope.SignatureScope signatureScope)
     
    protected void
    assertEvidenceRecordDocumentExtensionMatch(eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum evidenceRecordTypeEnum)
    This method verifies whether the extension of evidenceRecordDocument is conformant to the applicable standard for the given evidenceRecordTypeEnum
    protected void
    attachExternalEvidenceRecords(List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> embeddedEvidenceRecords, List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> detachedEvidenceRecords)
    Appends detached evidence record provided to the validator to the evidence records covered by the corresponding evidence records
    protected List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken>
    attachExternalTimestamps(List<eu.europa.esig.dss.spi.signature.AdvancedSignature> allSignatures)
    Attaches existing external timestamps to the list of AdvancedSignatures
    protected List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord>
     
    protected List<eu.europa.esig.dss.spi.signature.AdvancedSignature>
     
    protected boolean
    coversSignature(eu.europa.esig.dss.spi.signature.AdvancedSignature signature, eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord)
     
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of all embedded documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of all embedded manifest documents
    List<eu.europa.esig.dss.spi.signature.AdvancedSignature>
     
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of archive documents embedded the container
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded archive manifest documents
    Returns the relevant container extractor
    protected eu.europa.esig.dss.model.ContainerInfo
    This method allows to retrieve the container information (ASiC Container)
    eu.europa.esig.dss.enumerations.ASiCContainerType
    Returns a container type
    protected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer>
    Builds and returns a list of evidence record analyzers
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded evidence record documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded evidence record manifest documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded signature manifest documents
    List<eu.europa.esig.dss.model.ManifestFile>
    Returns a list of parser Manifest files
    protected abstract List<eu.europa.esig.dss.model.ManifestFile>
    Returns a list of parser ManifestFiles
    eu.europa.esig.dss.model.DSSDocument
    Returns a mimetype document
    protected abstract List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer>
    Returns a list of validators for signature documents embedded into the container
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded signature documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded signed documents
    protected List<eu.europa.esig.dss.model.DSSDocument>
    getSignedDocumentsASiCS(List<eu.europa.esig.dss.model.DSSDocument> retrievedDocs)
    Returns a list of "package.zip" documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of embedded timestamp documents
    List<eu.europa.esig.dss.model.DSSDocument>
    Returns a list of unsupported documents from the container
    protected eu.europa.esig.dss.model.ManifestFile
    getValidatedManifestFile(eu.europa.esig.dss.model.DSSDocument manifest)
    Returns a validated ManifestFile for the given manifest document
    abstract boolean
    isSupported(ASiCContent asicContent)
    Checks if the ASiCContent is supported by the current validator

    Methods inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

    appendCounterSignatures, appendExternalEvidenceRecords, appendExternalEvidenceRecords, buildDetachedTimestamps, buildEvidenceRecord, createValidationContext, fromDocument, getAllEvidenceRecords, getDetachedEvidenceRecords, getDetachedTimestamps, getDocument, getEvidenceRecord, getEvidenceRecordScopes, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignaturePolicyValidatorLoader, getSignatures, getTimestampedReferences, getTimestampReaders, getTokenIdentifierProvider, getValidationData, getValidationData, getValidationTime, instantiateValidationDataContainer, isTimestampCoveredByEvidenceRecord, prepareDetachedEvidenceRecordValidationContext, prepareDetachedTimestampValidationContext, prepareSignatureForVerification, prepareSignatureValidationContext, prepareValidationContext, processSignaturesValidation, setCertificateVerifier, setContainerContents, setDetachedContents, setDetachedEvidenceRecordDocuments, setDetachedEvidenceRecords, setManifestFile, setSignaturePolicyProvider, setSigningCertificateSource, setTokenIdentifierProvider, setValidationContextExecutor, setValidationTime, validate, validateContext, validateSignaturePolicy

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer

    getOriginalDocuments, isSupported
  • Field Details

    • asicContent

      protected ASiCContent asicContent
      The container extraction result
    • signatureValidators

      protected List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer> signatureValidators
      List of signature document analyzers
    • timestampAnalyzers

      protected List<eu.europa.esig.dss.spi.validation.analyzer.timestamp.TimestampAnalyzer> timestampAnalyzers
      List of timestamp document validators
    • evidenceRecordAnalyzers

      protected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer> evidenceRecordAnalyzers
      List of evidence record document validators
  • Constructor Details

    • AbstractASiCContainerAnalyzer

      protected AbstractASiCContainerAnalyzer()
      Empty constructor
    • AbstractASiCContainerAnalyzer

      protected AbstractASiCContainerAnalyzer(eu.europa.esig.dss.model.DSSDocument document)
      The default constructor
      Parameters:
      document - DSSDocument to be validated
    • AbstractASiCContainerAnalyzer

      protected AbstractASiCContainerAnalyzer(ASiCContent asicContent)
      The constructor with ASiCContent
      Parameters:
      asicContent - ASiCContent to be validated
  • Method Details

    • isSupported

      public abstract boolean isSupported(ASiCContent asicContent)
      Checks if the ASiCContent is supported by the current validator
      Parameters:
      asicContent - ASiCContent to check
      Returns:
      TRUE if the ASiC Content is supported, FALSE otherwise
    • getContainerExtractor

      protected abstract DefaultASiCContainerExtractor getContainerExtractor()
      Returns the relevant container extractor
      Returns:
      DefaultASiCContainerExtractor
    • getContainerInfo

      protected eu.europa.esig.dss.model.ContainerInfo getContainerInfo()
      This method allows to retrieve the container information (ASiC Container)
      Returns:
      a DTO with the container information
    • attachExternalTimestamps

      protected List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> attachExternalTimestamps(List<eu.europa.esig.dss.spi.signature.AdvancedSignature> allSignatures)
      Attaches existing external timestamps to the list of AdvancedSignatures
      Parameters:
      allSignatures - list of AdvancedSignatures
      Returns:
      list of attached TimestampTokens
    • getManifestFilesDescriptions

      protected abstract List<eu.europa.esig.dss.model.ManifestFile> getManifestFilesDescriptions()
      Returns a list of parser ManifestFiles
      Returns:
      a list of ManifestFiles
    • getAllSignatures

      public List<eu.europa.esig.dss.spi.signature.AdvancedSignature> getAllSignatures()
      Overrides:
      getAllSignatures in class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
    • buildSignatures

      protected List<eu.europa.esig.dss.spi.signature.AdvancedSignature> buildSignatures()
      Overrides:
      buildSignatures in class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
    • getSignatureAnalyzers

      protected abstract List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer> getSignatureAnalyzers()
      Returns a list of validators for signature documents embedded into the container
      Returns:
      a list of DocumentValidators
    • getContainerType

      public eu.europa.esig.dss.enumerations.ASiCContainerType getContainerType()
      Returns a container type
      Returns:
      ASiCContainerType
    • getAllDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getAllDocuments()
      Returns a list of all embedded documents
      Returns:
      a list of all embedded DSSDocuments
    • getSignatureDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getSignatureDocuments()
      Returns a list of embedded signature documents
      Returns:
      a list of signature DSSDocuments
    • getSignedDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getSignedDocuments()
      Returns a list of embedded signed documents
      Returns:
      a list of signed DSSDocuments
    • getManifestDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getManifestDocuments()
      Returns a list of embedded signature manifest documents
      Returns:
      a list of signature manifest DSSDocuments
    • getTimestampDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getTimestampDocuments()
      Returns a list of embedded timestamp documents
      Returns:
      a list of timestamp DSSDocuments
    • getEvidenceRecordDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getEvidenceRecordDocuments()
      Returns a list of embedded evidence record documents
      Returns:
      a list of evidence record DSSDocuments
    • getArchiveManifestDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getArchiveManifestDocuments()
      Returns a list of embedded archive manifest documents
      Returns:
      a list of archive manifest DSSDocuments
    • getEvidenceRecordManifestDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getEvidenceRecordManifestDocuments()
      Returns a list of embedded evidence record manifest documents
      Returns:
      a list of evidence record manifest DSSDocuments
    • getAllManifestDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getAllManifestDocuments()
      Returns a list of all embedded manifest documents
      Returns:
      a list of manifest DSSDocuments
    • getArchiveDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getArchiveDocuments()
      Returns a list of archive documents embedded the container
      Returns:
      a list of archive DSSDocuments
    • getMimeTypeDocument

      public eu.europa.esig.dss.model.DSSDocument getMimeTypeDocument()
      Returns a mimetype document
      Returns:
      DSSDocument mimetype
    • getUnsupportedDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getUnsupportedDocuments()
      Returns a list of unsupported documents from the container
      Returns:
      a list of unsupported documents DSSDocuments
    • getManifestFiles

      public List<eu.europa.esig.dss.model.ManifestFile> getManifestFiles()
      Returns a list of parser Manifest files
      Returns:
      a list of ManifestFiles
    • getSignedDocumentsASiCS

      protected List<eu.europa.esig.dss.model.DSSDocument> getSignedDocumentsASiCS(List<eu.europa.esig.dss.model.DSSDocument> retrievedDocs)
      Returns a list of "package.zip" documents
      Parameters:
      retrievedDocs - the retrieved signed documents
      Returns:
      a list of DSSDocuments
    • buildDetachedEvidenceRecords

      protected List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> buildDetachedEvidenceRecords()
      Overrides:
      buildDetachedEvidenceRecords in class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
    • attachExternalEvidenceRecords

      protected void attachExternalEvidenceRecords(List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> embeddedEvidenceRecords, List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> detachedEvidenceRecords)
      Appends detached evidence record provided to the validator to the evidence records covered by the corresponding evidence records
      Parameters:
      embeddedEvidenceRecords - a list of EvidenceRecords extracted from the ASiC container
      detachedEvidenceRecords - a list of EvidenceRecords provided externally to the validation
    • getEvidenceRecordAnalyzers

      protected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer> getEvidenceRecordAnalyzers()
      Builds and returns a list of evidence record analyzers
      Returns:
      a list of EvidenceRecordAnalyzer
    • assertEvidenceRecordDocumentExtensionMatch

      protected void assertEvidenceRecordDocumentExtensionMatch(eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum evidenceRecordTypeEnum)
      This method verifies whether the extension of evidenceRecordDocument is conformant to the applicable standard for the given evidenceRecordTypeEnum
      Parameters:
      evidenceRecordDocument - DSSDocument to be validated
      evidenceRecordTypeEnum - EvidenceRecordTypeEnum identified for the document
    • coversSignature

      protected boolean coversSignature(eu.europa.esig.dss.spi.signature.AdvancedSignature signature, eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord)
      Overrides:
      coversSignature in class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
    • getValidatedManifestFile

      protected eu.europa.esig.dss.model.ManifestFile getValidatedManifestFile(eu.europa.esig.dss.model.DSSDocument manifest)
      Returns a validated ManifestFile for the given manifest document
      Parameters:
      manifest - DSSDocument
      Returns:
      ManifestFile
    • addReference

      protected boolean addReference(eu.europa.esig.dss.model.scope.SignatureScope signatureScope)
      Overrides:
      addReference in class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer