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

Class XMLEvidenceRecordRenewalDigestBuilder

java.lang.Object

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

eu.europa.esig.dss.evidencerecord.xml.digest.XMLEvidenceRecordRenewalDigestBuilder

All Implemented Interfaces:

EvidenceRecordRenewalDigestBuilder

public class XMLEvidenceRecordRenewalDigestBuilder
extends AbstractEvidenceRecordRenewalDigestBuilder

This class builds digest for an RFC 6283 XMLERS evidence record's renewal

Field Summary

Fields inherited from class eu.europa.esig.dss.evidencerecord.common.digest.AbstractEvidenceRecordRenewalDigestBuilder

detachedContent, digestAlgorithm, evidenceRecord

Constructor Summary

Constructors

Constructor	Description
XMLEvidenceRecordRenewalDigestBuilder(XmlEvidenceRecord xmlEvidenceRecord)	Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XmlEvidenceRecord's renewal, with a default SHA256 digest algorithm to be used on hash-tree renewal computation (see note).
XMLEvidenceRecordRenewalDigestBuilder(XmlEvidenceRecord xmlEvidenceRecord, DigestAlgorithm digestAlgorithm)	Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XmlEvidenceRecord's renewal, with the provided digestAlgorithm (see note below).
XMLEvidenceRecordRenewalDigestBuilder(DSSDocument document)	Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XML evidence record document's renewal, with a default SHA256 digest algorithm to be used on hash-tree renewal computation (see note).
XMLEvidenceRecordRenewalDigestBuilder(DSSDocument document, DigestAlgorithm digestAlgorithm)	Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XML evidence record document's renewal, with the provided digestAlgorithm (see note below).

Method Summary

Modifier and Type	Method	Description
List<Digest>	buildHashTreeRenewalDigestGroup()	This method builds digest for a hash-tree renewal.
DSSMessageDigest	buildTimeStampRenewalDigest()	This method builds digest for a time-stamp renewal
protected XMLEvidenceRecordRenewalDigestBuilderHelper	getArchiveTimeStampSequenceDigestHelper()	This method returns a helper class containing supporting methods for digest computation in relation to an archive-time-stamp-sequence
XMLEvidenceRecordRenewalDigestBuilder	setCanonicalizationMethod(String canonicalizationMethod)	Sets a canonicalization method to be used on hash-tree renewal Default: "http://www.w3.org/TR/2001/REC-xml-c14n-20010315" canonicalization algorithm Note: for time-stamp renewal, a canonicalization method defined within a corresponding ArchiveTimeStampChain is used.
XMLEvidenceRecordRenewalDigestBuilder	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 eu.europa.esig.dss.evidencerecord.common.digest.AbstractEvidenceRecordRenewalDigestBuilder

getDigestAlgorithm, getLastArchiveTimeStampChainObject, getLastArchiveTimeStampObject

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XMLEvidenceRecordRenewalDigestBuilder

public XMLEvidenceRecordRenewalDigestBuilder(DSSDocument document)

Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XML evidence record document'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:

document - DSSDocument

XMLEvidenceRecordRenewalDigestBuilder

public XMLEvidenceRecordRenewalDigestBuilder(DSSDocument document,
 DigestAlgorithm digestAlgorithm)

Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XML evidence record document'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:

document - DSSDocument

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

XMLEvidenceRecordRenewalDigestBuilder

public XMLEvidenceRecordRenewalDigestBuilder(XmlEvidenceRecord xmlEvidenceRecord)

Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XmlEvidenceRecord'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:

xmlEvidenceRecord - XmlEvidenceRecord

XMLEvidenceRecordRenewalDigestBuilder

public XMLEvidenceRecordRenewalDigestBuilder(XmlEvidenceRecord xmlEvidenceRecord,
 DigestAlgorithm digestAlgorithm)

Creates an instance of XMLEvidenceRecordRenewalDigestBuilder allowing to build hash for XmlEvidenceRecord'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:

xmlEvidenceRecord - XmlEvidenceRecord

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

Method Details

setCanonicalizationMethod

public XMLEvidenceRecordRenewalDigestBuilder setCanonicalizationMethod(String canonicalizationMethod)

Sets a canonicalization method to be used on hash-tree renewal Default: "http://www.w3.org/TR/2001/REC-xml-c14n-20010315" canonicalization algorithm Note: for time-stamp renewal, a canonicalization method defined within a corresponding ArchiveTimeStampChain is used.

Parameters:

canonicalizationMethod - String

Returns:

this XMLEvidenceRecordRenewalDigestBuilder

setDetachedContent

public XMLEvidenceRecordRenewalDigestBuilder setDetachedContent(List<DSSDocument> detachedContent)

Description copied from class: AbstractEvidenceRecordRenewalDigestBuilder

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

Overrides:

setDetachedContent in class AbstractEvidenceRecordRenewalDigestBuilder

Parameters:

detachedContent - a list of DSSDocument detached documents

Returns:

this builder

buildTimeStampRenewalDigest

public DSSMessageDigest buildTimeStampRenewalDigest()

Description copied from interface: EvidenceRecordRenewalDigestBuilder

This method builds digest for a time-stamp renewal

Specified by:

buildTimeStampRenewalDigest in interface EvidenceRecordRenewalDigestBuilder

Specified by:

buildTimeStampRenewalDigest in class AbstractEvidenceRecordRenewalDigestBuilder

Returns:

Digest

buildHashTreeRenewalDigestGroup

public List<Digest> buildHashTreeRenewalDigestGroup()

Description copied from interface: EvidenceRecordRenewalDigestBuilder

This method builds digest for a hash-tree renewal. NOTE: the corresponding detached contents may be required to be provided

Returns:

a list of Digests

getArchiveTimeStampSequenceDigestHelper

protected XMLEvidenceRecordRenewalDigestBuilderHelper getArchiveTimeStampSequenceDigestHelper()

This method returns a helper class containing supporting methods for digest computation in relation to an archive-time-stamp-sequence

Returns:

XMLEvidenceRecordRenewalDigestBuilderHelper