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

Class AbstractASiCContainerEvidenceRecordBuilder

java.lang.Object

eu.europa.esig.dss.asic.common.evidencerecord.AbstractASiCContainerEvidenceRecordBuilder

Direct Known Subclasses:

ASiCWithCAdESContainerEvidenceRecordBuilder, ASiCWithXAdESContainerEvidenceRecordBuilder

public abstract class AbstractASiCContainerEvidenceRecordBuilder
extends Object

Incorporates an existing evidence record document within an ASiC container

Field Summary

Fields

Modifier and Type	Field	Description
protected final ASiCEvidenceRecordFilenameFactory	asicFilenameFactory	Filename factory
protected final CertificateVerifier	certificateVerifier	Used to verify the evidence record against the provided data

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractASiCContainerEvidenceRecordBuilder(CertificateVerifier certificateVerifier, ASiCEvidenceRecordFilenameFactory asicFilenameFactory)	Default constructor

Method Summary

Modifier and Type	Method	Description
protected void	assertASiCContentValid(ASiCContent asicContent, ASiCParameters parameters)	This method verifies whether the provided ASiCContent is valid and can be successfully protected by a new evidence record
protected void	assertASiCEvidenceRecordManifestValid(String manifestFilename, ASiCContent asicContent)	This method verifies whether the ASiCEvidenceRecordManifest filename is valid
protected void	assertEvidenceRecordFilenameValid(String evidenceRecordFilename, EvidenceRecordTypeEnum evidenceRecordType, ASiCContent asicContent)	This method verifies validity of the evidence record filename to the ASiC container convention
protected void	assertEvidenceRecordValid(EvidenceRecord evidenceRecord, ManifestFile manifestFile)	This method verifies whether the provided EvidenceRecord and covers the original data files
protected void	assertManifestFileValid(ManifestFile manifestFile, ASiCContent asicContent)	This method verifies the validity of the ASiCEvidenceRecordManifest file
protected void	assertSignedDataCovered(ASiCContent asicContent, List<String> coveredDocumentFilenames)	This method verifies whether the original or signed documents are successfully covered by the evidence record
ASiCContent	build(List<DSSDocument> documents, DSSDocument evidenceRecordDocument, ASiCContainerEvidenceRecordParameters parameters)	Builds an ASiCContent containing the evidence record file document
protected DSSDocument	buildEvidenceRecordManifest(ASiCContent asicContent, List<DSSDocument> coveredDocuments, DigestAlgorithm digestAlgorithm, String evidenceRecordFilename)	Builds an ASiCEvidenceRecordManifest for the evidence record based on a list of coveredDocuments when required
protected abstract AbstractASiCContentBuilder	getASiCContentBuilder()	Gets an instance of AbstractASiCContentBuilder
protected DSSDocument	getASiCEvidenceRecordManifest(ASiCContainerEvidenceRecordParameters parameters)	Gets the provided ASiCEvidenceRecordManifest file
protected EvidenceRecord	getEvidenceRecord(DSSDocument evidenceRecordDocument, ManifestFile manifestFile, ASiCContent asicContent)	Creates an EvidenceRecord from a provided evidenceRecordDocument
protected String	getEvidenceRecordFilename(EvidenceRecord evidenceRecord, ManifestFile manifestFile, ASiCContent asicContent)	Gets the filename for the evidence record to be incorporated
protected ASiCContent	initASiCContent(List<DSSDocument> documents, ASiCParameters parameters)	This method initializes an ASiCContent from the given list of documents
protected ManifestFile	parseManifestFile(DSSDocument evidenceRecordManifest, ASiCContent asicContent)	This method attempts to parse a evidenceRecordManifest document as an ASiCEvidenceRecordManifest file

Methods inherited from class java.lang.Object

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

Field Details

certificateVerifier

protected final CertificateVerifier certificateVerifier

Used to verify the evidence record against the provided data

asicFilenameFactory

protected final ASiCEvidenceRecordFilenameFactory asicFilenameFactory

Filename factory

Constructor Details

AbstractASiCContainerEvidenceRecordBuilder

protected AbstractASiCContainerEvidenceRecordBuilder(CertificateVerifier certificateVerifier,
 ASiCEvidenceRecordFilenameFactory asicFilenameFactory)

Default constructor

Parameters:

certificateVerifier - CertificateVerifier

asicFilenameFactory - ASiCEvidenceRecordFilenameFactory

Method Details

build

public ASiCContent build(List<DSSDocument> documents,
 DSSDocument evidenceRecordDocument,
 ASiCContainerEvidenceRecordParameters parameters)

Builds an ASiCContent containing the evidence record file document

Parameters:

documents - a list of DSSDocuments to be preserved or an ASiC container

evidenceRecordDocument - DSSDocument containing an evidence record to be added in ASiC container

parameters - ASiCContainerEvidenceRecordParameters parameters used for container creation

Returns:

ASiCContent

initASiCContent

protected ASiCContent initASiCContent(List<DSSDocument> documents,
 ASiCParameters parameters)

This method initializes an ASiCContent from the given list of documents

Parameters:

documents - a list of DSSDocuments to create an ASiC container from

parameters - ASiCParameters

Returns:

ASiCContent

getASiCContentBuilder

protected abstract AbstractASiCContentBuilder getASiCContentBuilder()

Gets an instance of AbstractASiCContentBuilder

Returns:

AbstractASiCContentBuilder

getASiCEvidenceRecordManifest

protected DSSDocument getASiCEvidenceRecordManifest(ASiCContainerEvidenceRecordParameters parameters)

Gets the provided ASiCEvidenceRecordManifest file

Parameters:

parameters - ASiCContainerEvidenceRecordParameters

Returns:

DSSDocument

getEvidenceRecord

protected EvidenceRecord getEvidenceRecord(DSSDocument evidenceRecordDocument,
 ManifestFile manifestFile,
 ASiCContent asicContent)

Creates an EvidenceRecord from a provided evidenceRecordDocument

Parameters:

evidenceRecordDocument - DSSDocument containing evidence record

manifestFile - ManifestFile ASiCEvidenceRecordDocument applying to the evidence record, when present

asicContent - ASiCContent

Returns:

EvidenceRecord

parseManifestFile

protected ManifestFile parseManifestFile(DSSDocument evidenceRecordManifest,
 ASiCContent asicContent)

This method attempts to parse a evidenceRecordManifest document as an ASiCEvidenceRecordManifest file

Parameters:

evidenceRecordManifest - DSSDocument

asicContent - ASiCContent

Returns:

ManifestFile

assertASiCEvidenceRecordManifestValid

protected void assertASiCEvidenceRecordManifestValid(String manifestFilename,
 ASiCContent asicContent)

This method verifies whether the ASiCEvidenceRecordManifest filename is valid

Parameters:

manifestFilename - String

asicContent - ASiCContent

assertManifestFileValid

protected void assertManifestFileValid(ManifestFile manifestFile,
 ASiCContent asicContent)

This method verifies the validity of the ASiCEvidenceRecordManifest file

Parameters:

manifestFile - ManifestFile to verify

asicContent - ASiCContent

getEvidenceRecordFilename

protected String getEvidenceRecordFilename(EvidenceRecord evidenceRecord,
 ManifestFile manifestFile,
 ASiCContent asicContent)

Gets the filename for the evidence record to be incorporated

Parameters:

evidenceRecord - EvidenceRecord

manifestFile - ManifestFile

asicContent - ASiCContent

Returns:

String

buildEvidenceRecordManifest

protected DSSDocument buildEvidenceRecordManifest(ASiCContent asicContent,
 List<DSSDocument> coveredDocuments,
 DigestAlgorithm digestAlgorithm,
 String evidenceRecordFilename)

Builds an ASiCEvidenceRecordManifest for the evidence record based on a list of coveredDocuments when required

Parameters:

asicContent - ASiCContent

coveredDocuments - a list of DSSDocuments

digestAlgorithm - DigestAlgorithm

evidenceRecordFilename - String

Returns:

DSSDocument

assertASiCContentValid

protected void assertASiCContentValid(ASiCContent asicContent,
 ASiCParameters parameters)

This method verifies whether the provided ASiCContent is valid and can be successfully protected by a new evidence record

Parameters:

asicContent - ASiCContent to verify

parameters - ASiCParameters

assertSignedDataCovered

protected void assertSignedDataCovered(ASiCContent asicContent,
 List<String> coveredDocumentFilenames)

This method verifies whether the original or signed documents are successfully covered by the evidence record

Parameters:

asicContent - ASiCContent

coveredDocumentFilenames - a list of document filename Strings covered by the evidence record

assertEvidenceRecordValid

protected void assertEvidenceRecordValid(EvidenceRecord evidenceRecord,
 ManifestFile manifestFile)

This method verifies whether the provided EvidenceRecord and covers the original data files

Parameters:

evidenceRecord - EvidenceRecord to verify

manifestFile - ManifestFile associated with the evidence record

assertEvidenceRecordFilenameValid

protected void assertEvidenceRecordFilenameValid(String evidenceRecordFilename,
 EvidenceRecordTypeEnum evidenceRecordType,
 ASiCContent asicContent)

This method verifies validity of the evidence record filename to the ASiC container convention

Parameters:

evidenceRecordFilename - String evidence record filename

evidenceRecordType - EvidenceRecordTypeEnum

asicContent - ASiCContent