Module jpms_dss_asic_common
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
FieldsModifier and TypeFieldDescriptionprotected ASiCContentThe container extraction resultprotected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer> List of evidence record document validatorsprotected List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer> List of signature document analyzersprotected List<eu.europa.esig.dss.spi.validation.analyzer.timestamp.TimestampAnalyzer> List of timestamp document validatorsFields inherited from class eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
certificateVerifier, containerContents, detachedContents, detachedEvidenceRecordDocuments, document, manifestFile, signingCertificateSource -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedEmpty constructorprotectedAbstractASiCContainerAnalyzer(ASiCContent asicContent) The constructor withASiCContentprotectedAbstractASiCContainerAnalyzer(eu.europa.esig.dss.model.DSSDocument document) The default constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected booleanaddReference(eu.europa.esig.dss.model.scope.SignatureScope signatureScope) protected voidassertEvidenceRecordDocumentExtensionMatch(eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum evidenceRecordTypeEnum) This method verifies whether the extension ofevidenceRecordDocumentis conformant to the applicable standard for the givenevidenceRecordTypeEnumprotected voidattachExternalEvidenceRecords(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 recordsprotected 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 ofAdvancedSignaturesprotected List<eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord> protected List<eu.europa.esig.dss.spi.signature.AdvancedSignature> protected booleancoversSignature(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 documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of all embedded manifest documentsList<eu.europa.esig.dss.spi.signature.AdvancedSignature> List<eu.europa.esig.dss.model.DSSDocument> Returns a list of archive documents embedded the containerList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded archive manifest documentsprotected abstract DefaultASiCContainerExtractorReturns the relevant container extractorprotected eu.europa.esig.dss.model.ContainerInfoThis method allows to retrieve the container information (ASiC Container)eu.europa.esig.dss.enumerations.ASiCContainerTypeReturns a container typeprotected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer> Builds and returns a list of evidence record analyzersList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded evidence record documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded evidence record manifest documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded signature manifest documentsList<eu.europa.esig.dss.model.ManifestFile> Returns a list of parser Manifest filesprotected abstract List<eu.europa.esig.dss.model.ManifestFile> Returns a list of parser ManifestFileseu.europa.esig.dss.model.DSSDocumentReturns a mimetype documentprotected abstract List<eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer> Returns a list of validators for signature documents embedded into the containerList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded signature documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded signed documentsprotected List<eu.europa.esig.dss.model.DSSDocument> getSignedDocumentsASiCS(List<eu.europa.esig.dss.model.DSSDocument> retrievedDocs) Returns a list of "package.zip" documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of embedded timestamp documentsList<eu.europa.esig.dss.model.DSSDocument> Returns a list of unsupported documents from the containerprotected eu.europa.esig.dss.model.ManifestFilegetValidatedManifestFile(eu.europa.esig.dss.model.DSSDocument manifest) Returns a validatedManifestFilefor the givenmanifestdocumentabstract booleanisSupported(ASiCContent asicContent) Checks if theASiCContentis supported by the current validatorMethods 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, validateSignaturePolicyMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface eu.europa.esig.dss.spi.validation.analyzer.DocumentAnalyzer
getOriginalDocuments, isSupported
-
Field Details
-
asicContent
The container extraction result -
signatureValidators
List of signature document analyzers -
timestampAnalyzers
protected List<eu.europa.esig.dss.spi.validation.analyzer.timestamp.TimestampAnalyzer> timestampAnalyzersList of timestamp document validators -
evidenceRecordAnalyzers
protected List<eu.europa.esig.dss.spi.validation.analyzer.evidencerecord.EvidenceRecordAnalyzer> evidenceRecordAnalyzersList 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-DSSDocumentto be validated
-
AbstractASiCContainerAnalyzer
The constructor withASiCContent- Parameters:
asicContent-ASiCContentto be validated
-
-
Method Details
-
isSupported
Checks if theASiCContentis supported by the current validator- Parameters:
asicContent-ASiCContentto check- Returns:
- TRUE if the ASiC Content is supported, FALSE otherwise
-
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 ofAdvancedSignatures- Parameters:
allSignatures- list ofAdvancedSignatures- Returns:
- list of attached
TimestampTokens
-
getManifestFilesDescriptions
Returns a list of parser ManifestFiles- Returns:
- a list of
ManifestFiles
-
getAllSignatures
- Overrides:
getAllSignaturesin classeu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
-
buildSignatures
- Overrides:
buildSignaturesin classeu.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
Returns a list of all embedded documents- Returns:
- a list of all embedded
DSSDocuments
-
getSignatureDocuments
Returns a list of embedded signature documents- Returns:
- a list of signature
DSSDocuments
-
getSignedDocuments
Returns a list of embedded signed documents- Returns:
- a list of signed
DSSDocuments
-
getManifestDocuments
Returns a list of embedded signature manifest documents- Returns:
- a list of signature manifest
DSSDocuments
-
getTimestampDocuments
Returns a list of embedded timestamp documents- Returns:
- a list of timestamp
DSSDocuments
-
getEvidenceRecordDocuments
Returns a list of embedded evidence record documents- Returns:
- a list of evidence record
DSSDocuments
-
getArchiveManifestDocuments
Returns a list of embedded archive manifest documents- Returns:
- a list of archive manifest
DSSDocuments
-
getEvidenceRecordManifestDocuments
Returns a list of embedded evidence record manifest documents- Returns:
- a list of evidence record manifest
DSSDocuments
-
getAllManifestDocuments
Returns a list of all embedded manifest documents- Returns:
- a list of manifest
DSSDocuments
-
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:
DSSDocumentmimetype
-
getUnsupportedDocuments
Returns a list of unsupported documents from the container- Returns:
- a list of unsupported documents
DSSDocuments
-
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:
buildDetachedEvidenceRecordsin classeu.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 ofEvidenceRecords extracted from the ASiC containerdetachedEvidenceRecords- a list ofEvidenceRecords 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 ofevidenceRecordDocumentis conformant to the applicable standard for the givenevidenceRecordTypeEnum- Parameters:
evidenceRecordDocument-DSSDocumentto be validatedevidenceRecordTypeEnum-EvidenceRecordTypeEnumidentified 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:
coversSignaturein classeu.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 validatedManifestFilefor the givenmanifestdocument- Parameters:
manifest-DSSDocument- Returns:
ManifestFile
-
addReference
protected boolean addReference(eu.europa.esig.dss.model.scope.SignatureScope signatureScope) - Overrides:
addReferencein classeu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer
-