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

Class DefaultEvidenceRecordAnalyzer

java.lang.Object

eu.europa.esig.dss.spi.validation.analyzer.DefaultDocumentAnalyzer

eu.europa.esig.dss.evidencerecord.common.validation.DefaultEvidenceRecordAnalyzer

All Implemented Interfaces:

DocumentAnalyzer, EvidenceRecordAnalyzer

Direct Known Subclasses:

ASN1EvidenceRecordAnalyzer, XMLEvidenceRecordAnalyzer

public abstract class DefaultEvidenceRecordAnalyzer
extends DefaultDocumentAnalyzer
implements EvidenceRecordAnalyzer

This class contains common method for processing of evidence record documents

Field Summary

Fields

Modifier and Type	Field	Description
protected EmbeddedEvidenceRecordHelper	embeddedEvidenceRecordHelper	Helper used for processing of the embedded evidence record type
protected EvidenceRecordIncorporationType	evidenceRecordIncorporationType	incorporation type
protected EvidenceRecordOrigin	evidenceRecordOrigin	Origin of the evidence record

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	DefaultEvidenceRecordAnalyzer()	Empty constructor
protected	DefaultEvidenceRecordAnalyzer(DSSDocument document)	Instantiates the class with a document to be validated

Method Summary

Modifier and Type	Method	Description
protected abstract EvidenceRecord	buildEvidenceRecord()	Builds an evidence record object
static EvidenceRecordAnalyzer	fromDocument(DSSDocument dssDocument)	This method guesses the document format and returns an appropriate evidence record reader.
List<EvidenceRecord>	getDetachedEvidenceRecords()	Retrieves the detached evidence records found in the document
EvidenceRecord	getEvidenceRecord()	Returns a single EvidenceRecord to be validated
protected List<DSSDocument>	getEvidenceRecordDetachedContents()	Returns a list of detached documents for the evidence record
List<DSSDocument>	getOriginalDocuments(AdvancedSignature advancedSignature)	This method returns the signed document(s) without their signature(s)
void	setEmbeddedEvidenceRecordHelper(EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper)	Sets a helper for processing and validation of the embedded evidence record type
void	setEvidenceRecordIncorporationType(EvidenceRecordIncorporationType evidenceRecordIncorporationType)	Sets the incorporation type of the evidence record within a signature's unsigned attributes NOTE: only used for attached CAdES evidence records
void	setEvidenceRecordOrigin(EvidenceRecordOrigin origin)	Sets the origin of the extracted evidence record

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

addReference, appendCounterSignatures, appendExternalEvidenceRecords, appendExternalEvidenceRecords, buildDetachedEvidenceRecords, buildDetachedTimestamps, buildEvidenceRecord, buildSignatures, coversSignature, createValidationContext, getAllEvidenceRecords, getAllSignatures, 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

getDetachedTimestamps, getDocument, getOriginalDocuments, getSignatures, getTokenIdentifierProvider, getValidationData, getValidationData, getValidationTime, isSupported, setCertificateVerifier, setContainerContents, setDetachedContents, setDetachedEvidenceRecordDocuments, setManifestFile, setSignaturePolicyProvider, setSigningCertificateSource, setTokenIdentifierProvider, setValidationContextExecutor, setValidationTime, validate

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

getEvidenceRecordType

Field Details

evidenceRecordOrigin

protected EvidenceRecordOrigin evidenceRecordOrigin

Origin of the evidence record

evidenceRecordIncorporationType

protected EvidenceRecordIncorporationType evidenceRecordIncorporationType

incorporation type

embeddedEvidenceRecordHelper

protected EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper

Helper used for processing of the embedded evidence record type

Constructor Details

DefaultEvidenceRecordAnalyzer

protected DefaultEvidenceRecordAnalyzer()

Empty constructor

DefaultEvidenceRecordAnalyzer

protected DefaultEvidenceRecordAnalyzer(DSSDocument document)

Instantiates the class with a document to be validated

Parameters:

document - DSSDocument to be validated

Method Details

fromDocument

public static EvidenceRecordAnalyzer fromDocument(DSSDocument dssDocument)

This method guesses the document format and returns an appropriate evidence record reader.

Parameters:

dssDocument - The instance of DSSDocument to validate

Returns:

returns the specific instance of DefaultEvidenceRecordAnalyzer in terms of the document type

getEvidenceRecord

public EvidenceRecord getEvidenceRecord()

Description copied from interface: EvidenceRecordAnalyzer

Returns a single EvidenceRecord to be validated

Specified by:

getEvidenceRecord in interface EvidenceRecordAnalyzer

Returns:

EvidenceRecord

setEvidenceRecordOrigin

public void setEvidenceRecordOrigin(EvidenceRecordOrigin origin)

Description copied from interface: EvidenceRecordAnalyzer

Sets the origin of the extracted evidence record

Default : EvidenceRecordOrigin.EXTERNAL

Specified by:

setEvidenceRecordOrigin in interface EvidenceRecordAnalyzer

Parameters:

origin - EvidenceRecordOrigin

setEvidenceRecordIncorporationType

public void setEvidenceRecordIncorporationType(EvidenceRecordIncorporationType evidenceRecordIncorporationType)

Description copied from interface: EvidenceRecordAnalyzer

Sets the incorporation type of the evidence record within a signature's unsigned attributes NOTE: only used for attached CAdES evidence records

Specified by:

setEvidenceRecordIncorporationType in interface EvidenceRecordAnalyzer

Parameters:

evidenceRecordIncorporationType - EvidenceRecordIncorporationType

setEmbeddedEvidenceRecordHelper

public void setEmbeddedEvidenceRecordHelper(EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper)

Description copied from interface: EvidenceRecordAnalyzer

Sets a helper for processing and validation of the embedded evidence record type

Specified by:

setEmbeddedEvidenceRecordHelper in interface EvidenceRecordAnalyzer

Parameters:

embeddedEvidenceRecordHelper - EmbeddedEvidenceRecordHelper

getEvidenceRecordDetachedContents

protected List<DSSDocument> getEvidenceRecordDetachedContents()

Returns a list of detached documents for the evidence record

Returns:

a list of DSSDocuments

buildEvidenceRecord

protected abstract EvidenceRecord buildEvidenceRecord()

Builds an evidence record object

Returns:

EvidenceRecord

getDetachedEvidenceRecords

public List<EvidenceRecord> getDetachedEvidenceRecords()

Description copied from interface: DocumentAnalyzer

Retrieves the detached evidence records found in the document

Specified by:

getDetachedEvidenceRecords in interface DocumentAnalyzer

Overrides:

getDetachedEvidenceRecords in class DefaultDocumentAnalyzer

Returns:

a list of Evidence Records for validation purposes

getOriginalDocuments

public List<DSSDocument> getOriginalDocuments(AdvancedSignature advancedSignature)

Description copied from interface: DocumentAnalyzer

This method returns the signed document(s) without their signature(s)

Specified by:

getOriginalDocuments in interface DocumentAnalyzer

Parameters:

advancedSignature - AdvancedSignature to find signer documents for

Returns:

list of DSSDocuments