Package eu.europa.esig.dss.asic.common.validation

Class AbstractASiCContainerValidator

java.lang.Object

eu.europa.esig.dss.validation.SignedDocumentValidator

eu.europa.esig.dss.asic.common.validation.AbstractASiCContainerValidator

All Implemented Interfaces:

DocumentValidator, ProcessExecutorProvider<DocumentProcessExecutor>

Direct Known Subclasses:

ASiCContainerWithCAdESValidator, ASiCContainerWithXAdESValidator

public abstract class AbstractASiCContainerValidator
extends SignedDocumentValidator

The abstract class for an ASiC container validation

Field Summary

Fields

Modifier and Type	Field	Description
protected ASiCContent	asicContent	The container extraction result
protected List<DocumentValidator>	signatureValidators	List of signature document validators
protected List<DetachedTimestampValidator>	timestampValidators	List of timestamp document validators

Fields inherited from class eu.europa.esig.dss.validation.SignedDocumentValidator

certificateVerifier, containerContents, detachedContents, document, manifestFile, processExecutor, signatureScopeFinder, signingCertificateSource, skipValidationContextExecution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractASiCContainerValidator()	Empty constructor
protected	AbstractASiCContainerValidator(ASiCContent asicContent)	The constructor with ASiCContent
protected	AbstractASiCContainerValidator(ASiCContent asicContent, SignatureScopeFinder<?> signatureScopeFinder)	Constructor with a ASiCContent
protected	AbstractASiCContainerValidator(DSSDocument document)	The default constructor
protected	AbstractASiCContainerValidator(DSSDocument document, SignatureScopeFinder<?> signatureScopeFinder)	Constructor with a custom SignatureScopeFinder

Method Summary

Modifier and Type	Method	Description
protected List<TimestampToken>	attachExternalTimestamps(List<AdvancedSignature> allSignatures)	Attaches existing external timestamps to the list of AdvancedSignatures
protected List<AdvancedSignature>	buildSignatures()	This method build a list of signatures to be extracted from a document
protected DiagnosticDataBuilder	createDiagnosticDataBuilder(ValidationContext validationContext, List<AdvancedSignature> signatures)	Creates and fills the DiagnosticDataBuilder with a relevant data
List<DSSDocument>	getAllDocuments()	Returns a list of all embedded documents
List<DSSDocument>	getAllManifestDocuments()	Returns a list of all embedded manifest documents
List<AdvancedSignature>	getAllSignatures()	Returns a list of all signatures from the validating document
List<DSSDocument>	getArchiveDocuments()	Returns a list of archive documents embedded the container
List<DSSDocument>	getArchiveManifestDocuments()	Returns a list of embedded archive manifest documents
protected abstract AbstractASiCContainerExtractor	getContainerExtractor()	Returns the relevant container extractor
protected ContainerInfo	getContainerInfo()	This method allows to retrieve the container information (ASiC Container)
ASiCContainerType	getContainerType()	Returns a container type
List<DSSDocument>	getManifestDocuments()	Returns a list of embedded signature manifest documents
List<ManifestFile>	getManifestFiles()	Returns a list of parser Manifest files
protected abstract List<ManifestFile>	getManifestFilesDescriptions()	Returns a list of parser ManifestFiles
DSSDocument	getMimeTypeDocument()	Returns a mimetype document
List<DSSDocument>	getSignatureDocuments()	Returns a list of embedded signature documents
protected abstract List<DocumentValidator>	getSignatureValidators()	Returns a list of validators for signature documents embedded into the container
List<DSSDocument>	getSignedDocuments()	Returns a list of embedded signed documents
protected List<DSSDocument>	getSignedDocumentsASiCS(List<DSSDocument> retrievedDocs)	Returns a list of "package.zip" documents
List<DSSDocument>	getTimestampDocuments()	Returns a list of embedded timestamp documents
List<DSSDocument>	getUnsupportedDocuments()	Returns a list of unsupported documents from the container
protected ASiCContainerDiagnosticDataBuilder	initializeDiagnosticDataBuilder()	Initializes a relevant DiagnosticDataBuilder for the given implementation
abstract boolean	isSupported(ASiCContent asicContent)	Checks if the ASiCContent is supported by the current validator

Methods inherited from class eu.europa.esig.dss.validation.SignedDocumentValidator

addReference, appendCounterSignatures, assertConfigurationValid, buildDetachedTimestamps, findSignatureScopes, findTimestampScopes, fromDocument, getDefaultDigestAlgorithm, getDefaultProcessExecutor, getDetachedTimestamps, getDiagnosticData, getOriginalDocuments, getSignatureById, getSignaturePolicyProvider, getSignaturePolicyValidatorLoader, getSignatures, getTimestampedReferences, getTimestampScopeFinder, getTokenIdentifierProvider, getValidationData, getValidationData, getValidationTime, instantiateValidationDataContainer, isSupported, prepareDetachedTimestampValidationContext, prepareDiagnosticDataBuilder, prepareSignatureForVerification, prepareSignatureScopeFinder, prepareSignatureValidationContext, prepareTimestampScopeFinder, prepareValidationContext, processSignaturesValidation, processValidationPolicy, provideProcessExecutorInstance, setCertificateVerifier, setContainerContents, setDetachedContents, setEnableEtsiValidationReport, setIncludeSemantics, setLocale, setManifestFile, setProcessExecutor, setSignaturePolicyProvider, setSigningCertificateSource, setSkipValidationContextExecution, setTokenExtractionStrategy, setTokenIdentifierProvider, setValidationLevel, setValidationTime, validateContext, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument, validateDocument

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.validation.DocumentValidator

getOriginalDocuments

Field Details

asicContent

protected ASiCContent asicContent

The container extraction result

signatureValidators

protected List<DocumentValidator> signatureValidators

List of signature document validators

timestampValidators

protected List<DetachedTimestampValidator> timestampValidators

List of timestamp document validators

Constructor Details

AbstractASiCContainerValidator

protected AbstractASiCContainerValidator()

Empty constructor

AbstractASiCContainerValidator

protected AbstractASiCContainerValidator(DSSDocument document)

The default constructor

Parameters:

document - DSSDocument to be validated

AbstractASiCContainerValidator

protected AbstractASiCContainerValidator(ASiCContent asicContent)

The constructor with ASiCContent

Parameters:

asicContent - ASiCContent to be validated

AbstractASiCContainerValidator

protected AbstractASiCContainerValidator(DSSDocument document,
 SignatureScopeFinder<?> signatureScopeFinder)

Constructor with a custom SignatureScopeFinder

Parameters:

document - DSSDocument to be validated

signatureScopeFinder - SignatureScopeFinder to be used

AbstractASiCContainerValidator

protected AbstractASiCContainerValidator(ASiCContent asicContent,
 SignatureScopeFinder<?> signatureScopeFinder)

Constructor with a ASiCContent

Parameters:

asicContent - ASiCContent to be validated

signatureScopeFinder - SignatureScopeFinder to be used

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 AbstractASiCContainerExtractor getContainerExtractor()

Returns the relevant container extractor

Returns:

AbstractASiCContainerExtractor

createDiagnosticDataBuilder

protected DiagnosticDataBuilder createDiagnosticDataBuilder(ValidationContext validationContext,
 List<AdvancedSignature> signatures)

Description copied from class: SignedDocumentValidator

Creates and fills the DiagnosticDataBuilder with a relevant data

Overrides:

createDiagnosticDataBuilder in class SignedDocumentValidator

Parameters:

validationContext - ValidationContext used for the validation

signatures - a list of AdvancedSignatures to be validated collection

Returns:

filled DiagnosticDataBuilder

initializeDiagnosticDataBuilder

protected ASiCContainerDiagnosticDataBuilder initializeDiagnosticDataBuilder()

Description copied from class: SignedDocumentValidator

Initializes a relevant DiagnosticDataBuilder for the given implementation

Overrides:

initializeDiagnosticDataBuilder in class SignedDocumentValidator

Returns:

SignedDocumentDiagnosticDataBuilder

getContainerInfo

protected ContainerInfo getContainerInfo()

This method allows to retrieve the container information (ASiC Container)

Returns:

a DTO with the container information

attachExternalTimestamps

protected List<TimestampToken> attachExternalTimestamps(List<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<ManifestFile> getManifestFilesDescriptions()

Returns a list of parser ManifestFiles

Returns:

a list of ManifestFiles

getAllSignatures

public List<AdvancedSignature> getAllSignatures()

Description copied from class: SignedDocumentValidator

Returns a list of all signatures from the validating document

Overrides:

getAllSignatures in class SignedDocumentValidator

Returns:

a list of AdvancedSignatures

buildSignatures

protected List<AdvancedSignature> buildSignatures()

Description copied from class: SignedDocumentValidator

This method build a list of signatures to be extracted from a document

Overrides:

buildSignatures in class SignedDocumentValidator

Returns:

a list of AdvancedSignatures

getSignatureValidators

protected abstract List<DocumentValidator> getSignatureValidators()

Returns a list of validators for signature documents embedded into the container

Returns:

a list of DocumentValidators

getContainerType

public ASiCContainerType getContainerType()

Returns a container type

Returns:

ASiCContainerType

getAllDocuments

public List<DSSDocument> getAllDocuments()

Returns a list of all embedded documents

Returns:

a list of all embedded DSSDocuments

getSignatureDocuments

public List<DSSDocument> getSignatureDocuments()

Returns a list of embedded signature documents

Returns:

a list of signature DSSDocuments

getSignedDocuments

public List<DSSDocument> getSignedDocuments()

Returns a list of embedded signed documents

Returns:

a list of signed DSSDocuments

getManifestDocuments

public List<DSSDocument> getManifestDocuments()

Returns a list of embedded signature manifest documents

Returns:

a list of signature manifest DSSDocuments

getTimestampDocuments

public List<DSSDocument> getTimestampDocuments()

Returns a list of embedded timestamp documents

Returns:

a list of timestamp DSSDocuments

getArchiveManifestDocuments

public List<DSSDocument> getArchiveManifestDocuments()

Returns a list of embedded archive manifest documents

Returns:

a list of archive manifest DSSDocuments

getAllManifestDocuments

public List<DSSDocument> getAllManifestDocuments()

Returns a list of all embedded manifest documents

Returns:

a list of manifest DSSDocuments

getArchiveDocuments

public List<DSSDocument> getArchiveDocuments()

Returns a list of archive documents embedded the container

Returns:

a list of archive DSSDocuments

getMimeTypeDocument

public DSSDocument getMimeTypeDocument()

Returns a mimetype document

Returns:

DSSDocument mimetype

getUnsupportedDocuments

public List<DSSDocument> getUnsupportedDocuments()

Returns a list of unsupported documents from the container

Returns:

a list of unsupported documents DSSDocuments

getManifestFiles

public List<ManifestFile> getManifestFiles()

Returns a list of parser Manifest files

Returns:

a list of ManifestFiles

getSignedDocumentsASiCS

protected List<DSSDocument> getSignedDocumentsASiCS(List<DSSDocument> retrievedDocs)

Returns a list of "package.zip" documents

Parameters:

retrievedDocs - the retrieved signed documents

Returns:

a list of DSSDocuments