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

Class DefaultEvidenceRecord

java.lang.Object

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

All Implemented Interfaces:

IdentifierBasedObject, EvidenceRecord

Direct Known Subclasses:

ASN1EvidenceRecord, XmlEvidenceRecord

public abstract class DefaultEvidenceRecord
extends Object
implements EvidenceRecord

Default representation of an Evidence Record

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ReferenceValidation>	referenceValidations	Cached result of archive data objects validation
protected List<String>	structureValidationMessages	A list of error messages occurred during a structure validation

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultEvidenceRecord()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addExternalEvidenceRecord(EvidenceRecord evidenceRecord)	This method allows to add an external evidence record covering the current evidence record.
protected List<? extends ArchiveTimeStampChainObject>	buildArchiveTimeStampSequence()	Build an archive time-stamp sequence
protected abstract EvidenceRecordTimeStampSequenceVerifier	buildCryptographicEvidenceRecordVerifier()	Builds an instance of EvidenceRecordTimeStampSequenceVerifier to perform a cryptographic validation of an evidence record
protected abstract EvidenceRecordParser	buildEvidenceRecordParser()	Builds an EvidenceRecordParser parsing the Evidence Record to a list of DSS DTOs
protected abstract EvidenceRecordTimestampSource<?>	buildTimestampSource()	Builds a new instance of an EvidenceRecordTimestampSource
List<? extends ArchiveTimeStampChainObject>	getArchiveTimeStampSequence()	Gets an archive time-stamp sequence
TokenCertificateSource	getCertificateSource()	Gets a certificate source which contains ALL certificates embedded in the evidence record.
OfflineRevocationSource<CRL>	getCRLSource()	Gets a CRL source which contains ALL CRLs embedded in the evidence record.
List<DSSDocument>	getDetachedContents()	Returns detached contents
List<EvidenceRecord>	getDetachedEvidenceRecords()	Returns a list of detached evidence records covering the current evidence record.
Identifier	getDSSId()	Returns the Identifier of the object
EmbeddedEvidenceRecordHelper	getEmbeddedEvidenceRecordHelper()	Returns an EmbeddedEvidenceRecordHelper in case of an embedded evidence record
List<SignatureScope>	getEvidenceRecordScopes()	Returns a list of covered archival data objects
String	getFilename()	Returns a name of the evidence record document, when present
String	getId()	This method returns the DSS unique signature id.
EvidenceRecordIncorporationType	getIncorporationType()	Gets the type of the unsigned attribute used for incorporation of an evidence record within a signature NOTE: applicable only for embedded evidence records within CAdES
ManifestFile	getManifestFile()	Returns a manifest file associated with the evidence record (used in ASiC)
AdvancedSignature	getMasterSignature()	Gets a master signature, enveloping the current evidence record
OfflineRevocationSource<OCSP>	getOCSPSource()	Gets an OCSP source which contains ALL OCSP responses embedded in the evidence record.
EvidenceRecordOrigin	getOrigin()	Returns origin of the evidence record
DigestAlgorithm	getOriginalDigestAlgorithm()	Gets a DigestAlgorithm used on the first data object group's digest computation
List<ReferenceValidation>	getReferenceValidation()	Returns a list of archive data object validations
List<String>	getStructureValidationResult()	Returns a message if the structure validation fails
List<TimestampedReference>	getTimestampedReferences()	Returns a list of references covered by the evidence record
List<TimestampToken>	getTimestamps()	Returns a list of incorporated timestamp tokens
EvidenceRecordTimestampSource<?>	getTimestampSource()	Gets a Timestamp source which contains ALL timestamps embedded in the evidence record.
boolean	isEmbedded()	Returns whether the evidence record is embedded in a signature
void	setDetachedContents(List<DSSDocument> detachedContents)	Sets a list of detached documents covered by the reduced HashTree of the Evidence Record
void	setEmbeddedEvidenceRecordHelper(EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper)	Sets a helper for processing and validation of the embedded evidence record type
void	setEvidenceRecordScopes(List<SignatureScope> evidenceRecordScopes)	Sets a list of covered archival data objects
void	setFilename(String filename)	Sets the evidence record filename
void	setIncorporationType(EvidenceRecordIncorporationType incorporationType)	Sets the incorporation type for embedded evidence records
void	setManifestFile(ManifestFile manifestFile)	Sets a manifest file associated with the evidence record
void	setOrigin(EvidenceRecordOrigin origin)	Sets the origin of the evidence record
void	setTimestampedReferences(List<TimestampedReference> timestampedReferences)	Sets references to objects covered by the evidence record
protected List<ReferenceValidation>	validate()	Performs validation of the evidence record
List<String>	validateStructure()	This method is used to verify the structure of the evidence record document

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.x509.evidencerecord.EvidenceRecord

getEncoded, getEvidenceRecordType

Field Details

referenceValidations

protected List<ReferenceValidation> referenceValidations

Cached result of archive data objects validation

structureValidationMessages

protected List<String> structureValidationMessages

A list of error messages occurred during a structure validation

Constructor Details

DefaultEvidenceRecord

protected DefaultEvidenceRecord()

Default constructor

Method Details

getFilename

public String getFilename()

Description copied from interface: EvidenceRecord

Returns a name of the evidence record document, when present

Specified by:

getFilename in interface EvidenceRecord

Returns:

String

setFilename

public void setFilename(String filename)

Sets the evidence record filename

Parameters:

filename - String

getOrigin

public EvidenceRecordOrigin getOrigin()

Description copied from interface: EvidenceRecord

Returns origin of the evidence record

Specified by:

getOrigin in interface EvidenceRecord

Returns:

EvidenceRecordOrigin

setOrigin

public void setOrigin(EvidenceRecordOrigin origin)

Sets the origin of the evidence record

Parameters:

origin - EvidenceRecordOrigin

getIncorporationType

public EvidenceRecordIncorporationType getIncorporationType()

Description copied from interface: EvidenceRecord

Gets the type of the unsigned attribute used for incorporation of an evidence record within a signature NOTE: applicable only for embedded evidence records within CAdES

Specified by:

getIncorporationType in interface EvidenceRecord

Returns:

EvidenceRecordIncorporationType

setIncorporationType

public void setIncorporationType(EvidenceRecordIncorporationType incorporationType)

Sets the incorporation type for embedded evidence records

Parameters:

incorporationType - EvidenceRecordIncorporationType

getDetachedContents

public List<DSSDocument> getDetachedContents()

Description copied from interface: EvidenceRecord

Returns detached contents

Specified by:

getDetachedContents in interface EvidenceRecord

Returns:

in the case of the detached signature this is the List of signed contents.

setDetachedContents

public void setDetachedContents(List<DSSDocument> detachedContents)

Sets a list of detached documents covered by the reduced HashTree of the Evidence Record

Parameters:

detachedContents - a list of DSSDocuments

getManifestFile

public ManifestFile getManifestFile()

Description copied from interface: EvidenceRecord

Returns a manifest file associated with the evidence record (used in ASiC)

Specified by:

getManifestFile in interface EvidenceRecord

Returns:

ManifestFile

setManifestFile

public void setManifestFile(ManifestFile manifestFile)

Sets a manifest file associated with the evidence record

Parameters:

manifestFile - ManifestFile

getTimestampedReferences

public List<TimestampedReference> getTimestampedReferences()

Description copied from interface: EvidenceRecord

Returns a list of references covered by the evidence record

Specified by:

getTimestampedReferences in interface EvidenceRecord

Returns:

a list of TimestampedReferences

setTimestampedReferences

public void setTimestampedReferences(List<TimestampedReference> timestampedReferences)

Description copied from interface: EvidenceRecord

Sets references to objects covered by the evidence record

Specified by:

setTimestampedReferences in interface EvidenceRecord

Parameters:

timestampedReferences - a list of TimestampedReferences

getArchiveTimeStampSequence

public List<? extends ArchiveTimeStampChainObject> getArchiveTimeStampSequence()

Gets an archive time-stamp sequence

Returns:

a list of ArchiveTimeStampChainObjects

buildArchiveTimeStampSequence

protected List<? extends ArchiveTimeStampChainObject> buildArchiveTimeStampSequence()

Build an archive time-stamp sequence

Returns:

a list of ordered ArchiveTimeStampChainObjects

buildEvidenceRecordParser

protected abstract EvidenceRecordParser buildEvidenceRecordParser()

Builds an EvidenceRecordParser parsing the Evidence Record to a list of DSS DTOs

Returns:

EvidenceRecordParser

getCertificateSource

public TokenCertificateSource getCertificateSource()

Description copied from interface: EvidenceRecord

Gets a certificate source which contains ALL certificates embedded in the evidence record.

Specified by:

getCertificateSource in interface EvidenceRecord

Returns:

CertificateSource

getCRLSource

public OfflineRevocationSource<CRL> getCRLSource()

Description copied from interface: EvidenceRecord

Gets a CRL source which contains ALL CRLs embedded in the evidence record.

Specified by:

getCRLSource in interface EvidenceRecord

Returns:

OfflineRevocationSource

getOCSPSource

public OfflineRevocationSource<OCSP> getOCSPSource()

Description copied from interface: EvidenceRecord

Gets an OCSP source which contains ALL OCSP responses embedded in the evidence record.

Specified by:

getOCSPSource in interface EvidenceRecord

Returns:

OfflineRevocationSource

getReferenceValidation

public List<ReferenceValidation> getReferenceValidation()

Description copied from interface: EvidenceRecord

Returns a list of archive data object validations

Specified by:

getReferenceValidation in interface EvidenceRecord

Returns:

a list of ReferenceValidation objects corresponding to each archive data object validation

validate

protected List<ReferenceValidation> validate()

Performs validation of the evidence record

Returns:

a list of ReferenceValidations

buildCryptographicEvidenceRecordVerifier

protected abstract EvidenceRecordTimeStampSequenceVerifier buildCryptographicEvidenceRecordVerifier()

Builds an instance of EvidenceRecordTimeStampSequenceVerifier to perform a cryptographic validation of an evidence record

Returns:

EvidenceRecordTimeStampSequenceVerifier

getTimestamps

public List<TimestampToken> getTimestamps()

Description copied from interface: EvidenceRecord

Returns a list of incorporated timestamp tokens

Specified by:

getTimestamps in interface EvidenceRecord

Returns:

a list of TimestampTokens

getTimestampSource

public EvidenceRecordTimestampSource<?> getTimestampSource()

Gets a Timestamp source which contains ALL timestamps embedded in the evidence record.

Returns:

EvidenceRecordTimestampSource

buildTimestampSource

protected abstract EvidenceRecordTimestampSource<?> buildTimestampSource()

Builds a new instance of an EvidenceRecordTimestampSource

Returns:

EvidenceRecordTimestampSource

getDetachedEvidenceRecords

public List<EvidenceRecord> getDetachedEvidenceRecords()

Description copied from interface: EvidenceRecord

Returns a list of detached evidence records covering the current evidence record.

Specified by:

getDetachedEvidenceRecords in interface EvidenceRecord

Returns:

a list of EvidenceRecords

addExternalEvidenceRecord

public void addExternalEvidenceRecord(EvidenceRecord evidenceRecord)

Description copied from interface: EvidenceRecord

This method allows to add an external evidence record covering the current evidence record.

Specified by:

addExternalEvidenceRecord in interface EvidenceRecord

Parameters:

evidenceRecord - EvidenceRecord

getEvidenceRecordScopes

public List<SignatureScope> getEvidenceRecordScopes()

Description copied from interface: EvidenceRecord

Returns a list of covered archival data objects

Specified by:

getEvidenceRecordScopes in interface EvidenceRecord

Returns:

a list of SignatureScopes

setEvidenceRecordScopes

public void setEvidenceRecordScopes(List<SignatureScope> evidenceRecordScopes)

Description copied from interface: EvidenceRecord

Sets a list of covered archival data objects

Specified by:

setEvidenceRecordScopes in interface EvidenceRecord

Parameters:

evidenceRecordScopes - a list of SignatureScopes

getOriginalDigestAlgorithm

public DigestAlgorithm getOriginalDigestAlgorithm()

Description copied from interface: EvidenceRecord

Gets a DigestAlgorithm used on the first data object group's digest computation

Specified by:

getOriginalDigestAlgorithm in interface EvidenceRecord

Returns:

DigestAlgorithm

setEmbeddedEvidenceRecordHelper

public void setEmbeddedEvidenceRecordHelper(EmbeddedEvidenceRecordHelper embeddedEvidenceRecordHelper)

Description copied from interface: EvidenceRecord

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

Specified by:

setEmbeddedEvidenceRecordHelper in interface EvidenceRecord

Parameters:

embeddedEvidenceRecordHelper - EmbeddedEvidenceRecordHelper

isEmbedded

public boolean isEmbedded()

Description copied from interface: EvidenceRecord

Returns whether the evidence record is embedded in a signature

Specified by:

isEmbedded in interface EvidenceRecord

Returns:

TRUE if the evidence record is embedded, FALSE otherwise

getMasterSignature

public AdvancedSignature getMasterSignature()

Description copied from interface: EvidenceRecord

Gets a master signature, enveloping the current evidence record

Specified by:

getMasterSignature in interface EvidenceRecord

Returns:

AdvancedSignature

getEmbeddedEvidenceRecordHelper

public EmbeddedEvidenceRecordHelper getEmbeddedEvidenceRecordHelper()

Description copied from interface: EvidenceRecord

Returns an EmbeddedEvidenceRecordHelper in case of an embedded evidence record

Specified by:

getEmbeddedEvidenceRecordHelper in interface EvidenceRecord

Returns:

EmbeddedEvidenceRecordHelper

getStructureValidationResult

public List<String> getStructureValidationResult()

Description copied from interface: EvidenceRecord

Returns a message if the structure validation fails

Specified by:

getStructureValidationResult in interface EvidenceRecord

Returns:

a list of String error messages if validation fails, an empty list if structural validation succeeds

validateStructure

public List<String> validateStructure()

This method is used to verify the structure of the evidence record document

Returns:

a list of String errors when applicable

getDSSId

public Identifier getDSSId()

Description copied from interface: IdentifierBasedObject

Returns the Identifier of the object

Specified by:

getDSSId in interface IdentifierBasedObject

Returns:

Identifier

getId

public String getId()

Description copied from interface: EvidenceRecord

This method returns the DSS unique signature id. It allows to unambiguously identify each signature.

Specified by:

getId in interface EvidenceRecord

Returns:

The signature unique Id