Class AbstractASiCContainerEvidenceRecordBuilder
java.lang.Object
eu.europa.esig.dss.asic.common.evidencerecord.AbstractASiCContainerEvidenceRecordBuilder
Incorporates an existing evidence record document within an ASiC container
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ASiCEvidenceRecordFilenameFactoryFilename factoryprotected final eu.europa.esig.dss.spi.validation.CertificateVerifierUsed to verify the evidence record against the provided data -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractASiCContainerEvidenceRecordBuilder(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier, ASiCEvidenceRecordFilenameFactory asicFilenameFactory) Default constructor -
Method Summary
Modifier and TypeMethodDescriptionprotected voidassertASiCContentValid(ASiCContent asicContent, ASiCParameters parameters) This method verifies whether the providedASiCContentis valid and can be successfully protected by a new evidence recordprotected voidassertASiCEvidenceRecordManifestValid(String manifestFilename, ASiCContent asicContent) This method verifies whether the ASiCEvidenceRecordManifest filename is validprotected voidassertEvidenceRecordFilenameValid(String evidenceRecordFilename, eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum evidenceRecordType, ASiCContent asicContent) This method verifies validity of the evidence record filename to the ASiC container conventionprotected voidassertEvidenceRecordValid(eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord, eu.europa.esig.dss.model.ManifestFile manifestFile) This method verifies whether the providedEvidenceRecordand covers the original data filesprotected voidassertManifestFileValid(eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) This method verifies the validity of the ASiCEvidenceRecordManifest fileprotected voidassertSignedDataCovered(ASiCContent asicContent, List<String> coveredDocumentFilenames) This method verifies whether the original or signed documents are successfully covered by the evidence recordbuild(List<eu.europa.esig.dss.model.DSSDocument> documents, eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, ASiCContainerEvidenceRecordParameters parameters) Builds anASiCContentcontaining the evidence record file documentprotected eu.europa.esig.dss.model.DSSDocumentbuildEvidenceRecordManifest(ASiCContent asicContent, List<eu.europa.esig.dss.model.DSSDocument> coveredDocuments, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm, String evidenceRecordFilename) Builds an ASiCEvidenceRecordManifest for the evidence record based on a list ofcoveredDocumentswhen requiredprotected abstract AbstractASiCContentBuilderGets an instance ofAbstractASiCContentBuilderprotected eu.europa.esig.dss.model.DSSDocumentGets the provided ASiCEvidenceRecordManifest fileprotected eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecordgetEvidenceRecord(eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) Creates anEvidenceRecordfrom a providedevidenceRecordDocumentprotected StringgetEvidenceRecordFilename(eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord, eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) Gets the filename for the evidence record to be incorporatedprotected ASiCContentinitASiCContent(List<eu.europa.esig.dss.model.DSSDocument> documents, ASiCParameters parameters) This method initializes anASiCContentfrom the given list ofdocumentsprotected eu.europa.esig.dss.model.ManifestFileparseManifestFile(eu.europa.esig.dss.model.DSSDocument evidenceRecordManifest, ASiCContent asicContent) This method attempts to parse aevidenceRecordManifestdocument as an ASiCEvidenceRecordManifest file
-
Field Details
-
certificateVerifier
protected final eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifierUsed to verify the evidence record against the provided data -
asicFilenameFactory
Filename factory
-
-
Constructor Details
-
AbstractASiCContainerEvidenceRecordBuilder
protected AbstractASiCContainerEvidenceRecordBuilder(eu.europa.esig.dss.spi.validation.CertificateVerifier certificateVerifier, ASiCEvidenceRecordFilenameFactory asicFilenameFactory) Default constructor- Parameters:
certificateVerifier-CertificateVerifierasicFilenameFactory-ASiCEvidenceRecordFilenameFactory
-
-
Method Details
-
build
public ASiCContent build(List<eu.europa.esig.dss.model.DSSDocument> documents, eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, ASiCContainerEvidenceRecordParameters parameters) Builds anASiCContentcontaining the evidence record file document- Parameters:
documents- a list ofDSSDocuments to be preserved or an ASiC containerevidenceRecordDocument-DSSDocumentcontaining an evidence record to be added in ASiC containerparameters-ASiCContainerEvidenceRecordParametersparameters used for container creation- Returns:
ASiCContent
-
initASiCContent
protected ASiCContent initASiCContent(List<eu.europa.esig.dss.model.DSSDocument> documents, ASiCParameters parameters) This method initializes anASiCContentfrom the given list ofdocuments- Parameters:
documents- a list ofDSSDocuments to create an ASiC container fromparameters-ASiCParameters- Returns:
ASiCContent
-
getASiCContentBuilder
Gets an instance ofAbstractASiCContentBuilder- Returns:
AbstractASiCContentBuilder
-
getASiCEvidenceRecordManifest
protected eu.europa.esig.dss.model.DSSDocument getASiCEvidenceRecordManifest(ASiCContainerEvidenceRecordParameters parameters) Gets the provided ASiCEvidenceRecordManifest file- Parameters:
parameters-ASiCContainerEvidenceRecordParameters- Returns:
DSSDocument
-
getEvidenceRecord
protected eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord getEvidenceRecord(eu.europa.esig.dss.model.DSSDocument evidenceRecordDocument, eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) Creates anEvidenceRecordfrom a providedevidenceRecordDocument- Parameters:
evidenceRecordDocument-DSSDocumentcontaining evidence recordmanifestFile-ManifestFileASiCEvidenceRecordDocument applying to the evidence record, when presentasicContent-ASiCContent- Returns:
EvidenceRecord
-
parseManifestFile
protected eu.europa.esig.dss.model.ManifestFile parseManifestFile(eu.europa.esig.dss.model.DSSDocument evidenceRecordManifest, ASiCContent asicContent) This method attempts to parse aevidenceRecordManifestdocument as an ASiCEvidenceRecordManifest file- Parameters:
evidenceRecordManifest-DSSDocumentasicContent-ASiCContent- Returns:
ManifestFile
-
assertASiCEvidenceRecordManifestValid
protected void assertASiCEvidenceRecordManifestValid(String manifestFilename, ASiCContent asicContent) This method verifies whether the ASiCEvidenceRecordManifest filename is valid- Parameters:
manifestFilename-StringasicContent-ASiCContent
-
assertManifestFileValid
protected void assertManifestFileValid(eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) This method verifies the validity of the ASiCEvidenceRecordManifest file- Parameters:
manifestFile-ManifestFileto verifyasicContent-ASiCContent
-
getEvidenceRecordFilename
protected String getEvidenceRecordFilename(eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord, eu.europa.esig.dss.model.ManifestFile manifestFile, ASiCContent asicContent) Gets the filename for the evidence record to be incorporated- Parameters:
evidenceRecord-EvidenceRecordmanifestFile-ManifestFileasicContent-ASiCContent- Returns:
String
-
buildEvidenceRecordManifest
protected eu.europa.esig.dss.model.DSSDocument buildEvidenceRecordManifest(ASiCContent asicContent, List<eu.europa.esig.dss.model.DSSDocument> coveredDocuments, eu.europa.esig.dss.enumerations.DigestAlgorithm digestAlgorithm, String evidenceRecordFilename) Builds an ASiCEvidenceRecordManifest for the evidence record based on a list ofcoveredDocumentswhen required- Parameters:
asicContent-ASiCContentcoveredDocuments- a list ofDSSDocumentsdigestAlgorithm-DigestAlgorithmevidenceRecordFilename-String- Returns:
DSSDocument
-
assertASiCContentValid
This method verifies whether the providedASiCContentis valid and can be successfully protected by a new evidence record- Parameters:
asicContent-ASiCContentto verifyparameters-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-ASiCContentcoveredDocumentFilenames- a list of document filenameStrings covered by the evidence record
-
assertEvidenceRecordValid
protected void assertEvidenceRecordValid(eu.europa.esig.dss.spi.x509.evidencerecord.EvidenceRecord evidenceRecord, eu.europa.esig.dss.model.ManifestFile manifestFile) This method verifies whether the providedEvidenceRecordand covers the original data files- Parameters:
evidenceRecord-EvidenceRecordto verifymanifestFile-ManifestFileassociated with the evidence record
-
assertEvidenceRecordFilenameValid
protected void assertEvidenceRecordFilenameValid(String evidenceRecordFilename, eu.europa.esig.dss.enumerations.EvidenceRecordTypeEnum evidenceRecordType, ASiCContent asicContent) This method verifies validity of the evidence record filename to the ASiC container convention- Parameters:
evidenceRecordFilename-Stringevidence record filenameevidenceRecordType-EvidenceRecordTypeEnumasicContent-ASiCContent
-