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

Class AbstractEvidenceRecordRenewalDigestBuilder

java.lang.Object

eu.europa.esig.dss.evidencerecord.common.digest.AbstractEvidenceRecordRenewalDigestBuilder

All Implemented Interfaces:

EvidenceRecordRenewalDigestBuilder

Direct Known Subclasses:

ASN1EvidenceRecordRenewalDigestBuilder, XMLEvidenceRecordRenewalDigestBuilder

public abstract class AbstractEvidenceRecordRenewalDigestBuilder
extends Object
implements EvidenceRecordRenewalDigestBuilder

Abstract implementation of EvidenceRecordRenewalDigestBuilder. Contains common methods for digest computation for evidence record's renewal.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DSSDocument>	detachedContent	List of documents to compute hashes for
protected final DigestAlgorithm	digestAlgorithm	The digest algorithm to be used on hash computation for time-stamp chain renewal.
protected final DefaultEvidenceRecord	evidenceRecord	Evidence record to compute digest for

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEvidenceRecordRenewalDigestBuilder(DefaultEvidenceRecord evidenceRecord)	Creates an instance of EvidenceRecordRenewalDigestBuilder allowing to build hash for an evidence record's renewal, with a default SHA256 digest algorithm to be used on hash-tree renewal computation (see note).
protected	AbstractEvidenceRecordRenewalDigestBuilder(DefaultEvidenceRecord evidenceRecord, DigestAlgorithm digestAlgorithm)	Creates an instance of EvidenceRecordRenewalDigestBuilder allowing to build hash for an evidence record's renewal, with the provided digestAlgorithm (see note below).

Method Summary

Modifier and Type	Method	Description
abstract DSSMessageDigest	buildTimeStampRenewalDigest()	This method builds digest for a time-stamp renewal
protected DigestAlgorithm	getDigestAlgorithm(ArchiveTimeStampChainObject archiveTimeStampChain)	Extracts a digest algorithm defined within XML ArchiveTimeStampChainObject
protected DigestAlgorithm	getDigestAlgorithmOrDefault()	Gets the defined DigestAlgorithm or default (DigestAlgorithm.SHA256) if not provided.
protected ArchiveTimeStampChainObject	getLastArchiveTimeStampChainObject()	Gets an ArchiveTimeStampChainObject to build hash for.
protected ArchiveTimeStampObject	getLastArchiveTimeStampObject()	Gets an ArchiveTimeStampObject to build hash for.
AbstractEvidenceRecordRenewalDigestBuilder	setDetachedContent(List<DSSDocument> detachedContent)	Sets detached content to be used for a digest group hash computation on hash-tree renewal NOTE : at least one of the documents from the original data group should be provided for a correct hash-tree renewal

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.evidencerecord.common.digest.EvidenceRecordRenewalDigestBuilder

buildHashTreeRenewalDigestGroup

Field Details

evidenceRecord

protected final DefaultEvidenceRecord evidenceRecord

Evidence record to compute digest for

digestAlgorithm

protected final DigestAlgorithm digestAlgorithm

The digest algorithm to be used on hash computation for time-stamp chain renewal. Default : DigestAlgorithm.SHA256

detachedContent

protected List<DSSDocument> detachedContent

List of documents to compute hashes for

Constructor Details

AbstractEvidenceRecordRenewalDigestBuilder

protected AbstractEvidenceRecordRenewalDigestBuilder(DefaultEvidenceRecord evidenceRecord)

Creates an instance of EvidenceRecordRenewalDigestBuilder allowing to build hash for an evidence record's renewal, with a default SHA256 digest algorithm to be used on hash-tree renewal computation (see note). Builds digest for the last available ArchiveTimeStamp or ArchiveTimeStampChain, based on the called method. NOTE: time-stamp renewal uses digest algorithm extracted from the last ArchiveTimeStampChain.

Parameters:

evidenceRecord - DefaultEvidenceRecord

AbstractEvidenceRecordRenewalDigestBuilder

protected AbstractEvidenceRecordRenewalDigestBuilder(DefaultEvidenceRecord evidenceRecord,
 DigestAlgorithm digestAlgorithm)

Creates an instance of EvidenceRecordRenewalDigestBuilder allowing to build hash for an evidence record's renewal, with the provided digestAlgorithm (see note below). Builds digest for the last available ArchiveTimeStamp or ArchiveTimeStampChain, based on the called method. NOTE: time-stamp renewal uses digest algorithm extracted from the last ArchiveTimeStampChain.

Parameters:

evidenceRecord - DefaultEvidenceRecord

digestAlgorithm - DigestAlgorithm to be used on hash-tree renewal hash computation

Method Details

setDetachedContent

public AbstractEvidenceRecordRenewalDigestBuilder setDetachedContent(List<DSSDocument> detachedContent)

Sets detached content to be used for a digest group hash computation on hash-tree renewal NOTE : at least one of the documents from the original data group should be provided for a correct hash-tree renewal

Parameters:

detachedContent - a list of DSSDocument detached documents

Returns:

this builder

getLastArchiveTimeStampObject

protected ArchiveTimeStampObject getLastArchiveTimeStampObject()

Gets an ArchiveTimeStampObject to build hash for. Returns the set archiveTimeStampObject when valid, otherwise returns the last ArchiveTimeStampObject

Returns:

ArchiveTimeStampObject

getLastArchiveTimeStampChainObject

protected ArchiveTimeStampChainObject getLastArchiveTimeStampChainObject()

Gets an ArchiveTimeStampChainObject to build hash for. Returns the set archiveTimeStampChainObject when valid, otherwise returns the last ArchiveTimeStampChainObject

Returns:

ArchiveTimeStampChainObject

getDigestAlgorithm

protected DigestAlgorithm getDigestAlgorithm(ArchiveTimeStampChainObject archiveTimeStampChain)

Extracts a digest algorithm defined within XML ArchiveTimeStampChainObject

Parameters:

archiveTimeStampChain - ArchiveTimeStampChainObject to get digest algorithm from

Returns:

DigestAlgorithm

buildTimeStampRenewalDigest

public abstract DSSMessageDigest buildTimeStampRenewalDigest()

Description copied from interface: EvidenceRecordRenewalDigestBuilder

This method builds digest for a time-stamp renewal

Specified by:

buildTimeStampRenewalDigest in interface EvidenceRecordRenewalDigestBuilder

Returns:

Digest

getDigestAlgorithmOrDefault

protected DigestAlgorithm getDigestAlgorithmOrDefault()

Gets the defined DigestAlgorithm or default (DigestAlgorithm.SHA256) if not provided.

Returns:

DigestAlgorithm