Class AbstractASiCContainerAnalyzer

java.lang.Object
eu.europa.esig.dss.asic.common.validation.AbstractASiCContainerAnalyzer

public abstract class AbstractASiCContainerAnalyzer extends Object
The abstract class for an ASiC container validation
  • 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
    • document

      protected eu.europa.esig.dss.model.DSSDocument document
    • detachedContents

      protected List<eu.europa.esig.dss.model.DSSDocument> detachedContents
    • detachedEvidenceRecordDocuments

      protected List<eu.europa.esig.dss.model.DSSDocument> detachedEvidenceRecordDocuments
    • containerContents

      protected List<eu.europa.esig.dss.model.DSSDocument> containerContents
    • manifestFile

      protected eu.europa.esig.dss.model.ManifestFile manifestFile
    • signingCertificateSource

      protected eu.europa.esig.dss.spi.x509.CertificateSource signingCertificateSource
    • certificateVerifier

      protected eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier
  • 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()
    • buildSignatures

      protected List<eu.europa.esig.dss.spi.signature.AdvancedSignature> buildSignatures()
    • 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()
    • 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)
    • 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)
    • fromDocument

      public static eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer fromDocument(eu.europa.esig.dss.model.DSSDocument arg0)
    • getDocument

      public eu.europa.esig.dss.model.DSSDocument getDocument()
    • setSigningCertificateSource

      public void setSigningCertificateSource(eu.europa.esig.dss.spi.x509.CertificateSource arg0)
    • setCertificateVerifier

      public void setCertificateVerifier(eu.europa.esig.dss.spi.validation.CertificateVerifier arg0)
    • setValidationContextExecutor

      public void setValidationContextExecutor(eu.europa.esig.dss.spi.validation.executor.ValidationContextExecutor arg0)
    • getTokenIdentifierProvider

      public eu.europa.esig.dss.model.identifier.TokenIdentifierProvider getTokenIdentifierProvider()
    • setTokenIdentifierProvider

      public void setTokenIdentifierProvider(eu.europa.esig.dss.model.identifier.TokenIdentifierProvider arg0)
    • setDetachedContents

      public void setDetachedContents(List<eu.europa.esig.dss.model.DSSDocument> arg0)
    • setDetachedEvidenceRecordDocuments

      public void setDetachedEvidenceRecordDocuments(List<eu.europa.esig.dss.model.DSSDocument> arg0)
    • setContainerContents

      public void setContainerContents(List<eu.europa.esig.dss.model.DSSDocument> arg0)
    • setManifestFile

      public void setManifestFile(eu.europa.esig.dss.model.ManifestFile arg0)
    • getValidationTime

      public Date getValidationTime()
    • setValidationTime

      public void setValidationTime(Date arg0)
    • setDetachedEvidenceRecords

      public void setDetachedEvidenceRecords(List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> arg0)
    • getSignaturePolicyProvider

      protected eu.europa.esig.dss.spi.policy.SignaturePolicyProvider getSignaturePolicyProvider()
    • setSignaturePolicyProvider

      public void setSignaturePolicyProvider(eu.europa.esig.dss.spi.policy.SignaturePolicyProvider arg0)
    • setSignaturePolicyValidatorLoader

      public void setSignaturePolicyValidatorLoader(eu.europa.esig.dss.spi.policy.SignaturePolicyValidatorLoader arg0)
    • validate

      public eu.europa.esig.dss.spi.validation.ValidationContext validate()
    • prepareValidationContext

      protected <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> eu.europa.esig.dss.spi.validation.ValidationContext prepareValidationContext(Collection<T> arg0, Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> arg1, Collection<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> arg2, eu.europa.esig.dss.spi.validation.CertificateVerifier arg3)
    • createValidationContext

      protected eu.europa.esig.dss.spi.validation.ValidationContext createValidationContext()
    • getValidationData

      public <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> eu.europa.esig.dss.spi.validation.ValidationDataContainer getValidationData(Collection<T> arg0)
    • getValidationData

      public <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> eu.europa.esig.dss.spi.validation.ValidationDataContainer getValidationData(Collection<T> arg0, Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> arg1)
    • instantiateValidationDataContainer

      protected eu.europa.esig.dss.spi.validation.ValidationDataContainer instantiateValidationDataContainer()
    • getAllEvidenceRecords

      protected List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> getAllEvidenceRecords(List<eu.europa.esig.dss.spi.signature.AdvancedSignature> arg0, List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> arg1)
    • prepareSignatureValidationContext

      protected <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> void prepareSignatureValidationContext(eu.europa.esig.dss.spi.validation.ValidationContext arg0, Collection<T> arg1)
    • prepareSignatureForVerification

      protected <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> void prepareSignatureForVerification(eu.europa.esig.dss.spi.validation.ValidationContext arg0, Collection<T> arg1)
    • prepareDetachedTimestampValidationContext

      protected void prepareDetachedTimestampValidationContext(eu.europa.esig.dss.spi.validation.ValidationContext arg0, Collection<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> arg1)
    • prepareDetachedEvidenceRecordValidationContext

      protected void prepareDetachedEvidenceRecordValidationContext(eu.europa.esig.dss.spi.validation.ValidationContext arg0, Collection<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> arg1)
    • validateContext

      protected void validateContext(eu.europa.esig.dss.spi.validation.ValidationContext arg0)
    • getSignaturePolicyValidatorLoader

      public eu.europa.esig.dss.spi.policy.SignaturePolicyValidatorLoader getSignaturePolicyValidatorLoader()
    • getDefaultSignaturePolicyValidator

      protected eu.europa.esig.dss.spi.policy.SignaturePolicyValidator getDefaultSignaturePolicyValidator()
    • appendCounterSignatures

      protected void appendCounterSignatures(List<eu.europa.esig.dss.spi.signature.AdvancedSignature> arg0, eu.europa.esig.dss.spi.signature.AdvancedSignature arg1)
    • appendExternalEvidenceRecords

      protected void appendExternalEvidenceRecords(List<eu.europa.esig.dss.spi.signature.AdvancedSignature> arg0)
    • appendExternalEvidenceRecords

      protected void appendExternalEvidenceRecords(eu.europa.esig.dss.spi.x509.tsp.TimestampToken arg0)
    • isTimestampCoveredByEvidenceRecord

      protected boolean isTimestampCoveredByEvidenceRecord(eu.europa.esig.dss.spi.x509.tsp.TimestampToken arg0, eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord arg1)
    • getSignatures

      public List<eu.europa.esig.dss.spi.signature.AdvancedSignature> getSignatures()
    • getDetachedTimestamps

      public List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> getDetachedTimestamps()
    • buildDetachedTimestamps

      protected List<eu.europa.esig.dss.spi.x509.tsp.TimestampToken> buildDetachedTimestamps()
    • getTimestampReaders

      protected List<eu.europa.esig.dss.spi.validation.analyzer.timestamp.TimestampAnalyzer> getTimestampReaders()
    • getDetachedEvidenceRecords

      public List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> getDetachedEvidenceRecords()
    • buildEvidenceRecord

      protected eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord buildEvidenceRecord(eu.europa.esig.dss.model.DSSDocument arg0)
    • getEvidenceRecord

      protected eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord getEvidenceRecord(eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer arg0)
    • getEvidenceRecordScopes

      protected List<eu.europa.esig.dss.model.scope.SignatureScope> getEvidenceRecordScopes(eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord arg0)
    • processSignaturesValidation

      protected <T extends eu.europa.esig.dss.spi.signature.AdvancedSignature> void processSignaturesValidation(Collection<T> arg0)
    • getTimestampedReferences

      protected List<eu.europa.esig.dss.spi.x509.tsp.TimestampedReference> getTimestampedReferences(List<eu.europa.esig.dss.model.scope.SignatureScope> arg0)
    • getOriginalDocuments

      public List<eu.europa.esig.dss.model.DSSDocument> getOriginalDocuments(String arg0)
    • getSignatureById

      public eu.europa.esig.dss.spi.signature.AdvancedSignature getSignatureById(String arg0)
    • validateSignaturePolicy

      protected void validateSignaturePolicy(eu.europa.esig.dss.spi.signature.AdvancedSignature arg0)
    • isSupported

      boolean isSupported(eu.europa.esig.dss.model.DSSDocument arg0)
    • getOriginalDocuments

      List<eu.europa.esig.dss.model.DSSDocument> getOriginalDocuments(eu.europa.esig.dss.spi.signature.AdvancedSignature arg0)