Class SignedDocumentDiagnosticDataBuilder

java.lang.Object

eu.europa.esig.dss.validation.reports.diagnostic.DiagnosticDataBuilder

eu.europa.esig.dss.validation.reports.diagnostic.SignedDocumentDiagnosticDataBuilder

Direct Known Subclasses:

ASiCContainerDiagnosticDataBuilder, CAdESDiagnosticDataBuilder, JAdESDiagnosticDataBuilder, QWACCertificateDiagnosticDataBuilder

public class SignedDocumentDiagnosticDataBuilder
extends DiagnosticDataBuilder

The common class for DiagnosticData creation from a signed/timestamped document

Field Summary

Fields

Modifier and Type	Field	Description
protected ListCertificateSource	documentCertificateSource	The list of all certificate sources extracted from a validating document (signature(s), timestamp(s))
protected ListRevocationSource<CRL>	documentCRLSource	The list of all CRL revocation sources extracted from a validating document (signature(s), timestamp(s))
protected ListRevocationSource<OCSP>	documentOCSPSource	The list of all OCSP revocation sources extracted from a validating document (signature(s), timestamp(s))
protected Collection<EvidenceRecord>	evidenceRecords	The collection of evidence records
protected Collection<AdvancedSignature>	signatures	The collection of signatures
protected DSSDocument	signedDocument	The signed document
protected Collection<TimestampToken>	usedTimestamps	The collection of timestamp tokens
protected Map<String, XmlEvidenceRecord>	xmlEvidenceRecordMap	The cached map of evidence records
protected Map<String, XmlSignature>	xmlSignaturesMap	The cached map of signatures
protected Map<String, XmlSignerData>	xmlSignedDataMap	The cached map of original signed data
protected Map<String, XmlTimestamp>	xmlTimestampsMap	The cached map of timestamps

Fields inherited from class DiagnosticDataBuilder

allCertificateSources, certificateIdsMap, defaultDigestAlgorithm, identifierProvider, referenceMap, signingCertificateMap, tlInfoMap, tokenExtractionStrategy, usedCertificates, usedRevocations, validationDate, xmlCertsMap, xmlOrphanCertificateTokensMap, xmlOrphanRevocationTokensMap, xmlRevocationsMap, xmlTrustedListsMap

Constructor Summary

Constructors

Constructor	Description
SignedDocumentDiagnosticDataBuilder()	Default constructor instantiating object with null values and empty maps

Method Summary

Modifier and Type	Method	Description
SignedDocumentDiagnosticDataBuilder	allCertificateSources(ListCertificateSource trustedCertSources)	This method allows to set ListCertificateSource containing all certificate sources used in the validator (including trusted certificate sources)
protected void	assertConfigurationValid()	This method verifies whether the configuration is valid in order to build a Diagnostic Data
XmlDiagnosticData	build()	Builds XmlDiagnosticData
XmlSignature	buildDetachedXmlSignature(AdvancedSignature signature)	Builds XmlSignature
protected XmlTimestamp	buildDetachedXmlTimestamp(TimestampToken timestampToken)	This method builds XmlTimestamp from TimestampToken
protected <R extends Revocation> XmlOrphanRevocationToken	createOrphanTokenFromRevocationIdentifier(EncapsulatedRevocationTokenIdentifier<R> revocationIdentifier)	Creates an orphan revocation token from EncapsulatedRevocationTokenIdentifier
SignedDocumentDiagnosticDataBuilder	defaultDigestAlgorithm(DigestAlgorithm digestAlgorithm)	This method allows to set the default DigestAlgorithm which will be used for tokens' DigestAlgoAndValue calculation
SignedDocumentDiagnosticDataBuilder	document(DSSDocument signedDocument)	This method allows to set the document which is analysed
SignedDocumentDiagnosticDataBuilder	documentCertificateSource(ListCertificateSource documentCertificateSource)	Sets a document Certificate Source containing all sources extracted from the provided signature(s)/timestamp(s)
SignedDocumentDiagnosticDataBuilder	documentCRLSource(ListRevocationSource<CRL> documentCRLSource)	Sets a document CRL Source containing all sources extracted from the provided signature(s)/timestamp(s)
SignedDocumentDiagnosticDataBuilder	documentOCSPSource(ListRevocationSource<OCSP> documentCRLSource)	Sets a document OCSP Source containing all sources extracted from the provided signature(s)/timestamp(s)
protected String	emptyToNull(String text)	If text is empty returns NULL, or original text otherwise
SignedDocumentDiagnosticDataBuilder	foundEvidenceRecords(Collection<EvidenceRecord> evidenceRecords)	This method allows to set the evidence records
SignedDocumentDiagnosticDataBuilder	foundSignatures(Collection<AdvancedSignature> signatures)	This method allows to set the found signatures
protected List<XmlSignerInfo>	getXmlSignerInformationStore(Set<SignerIdentifier> signerIdentifiers)	Builds a list of XmlSignerInfo from SignerIdentifiers
protected void	linkSigningCertificateAndChains(Set<CertificateToken> certificates)	Links the certificates and their certificate chains
SignedDocumentDiagnosticDataBuilder	tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)	This method allows to set the TokenExtractionStrategy to follow for the token extraction
SignedDocumentDiagnosticDataBuilder	usedCertificates(Set<CertificateToken> usedCertificates)	This method allows to set the used certificates
SignedDocumentDiagnosticDataBuilder	usedRevocations(Set<RevocationToken<?>> usedRevocations)	This method allows to set the used revocation data
SignedDocumentDiagnosticDataBuilder	usedTimestamps(Collection<TimestampToken> usedTimestamps)	This method allows to set the timestamps
SignedDocumentDiagnosticDataBuilder	validationDate(Date validationDate)	This method allows to set the validation date

Methods inherited from class DiagnosticDataBuilder

buildDetachedXmlCertificate, buildDetachedXmlRevocation, buildXmlOrphanCertificateToken, buildXmlOrphanTokens, getUsedCertificatesByCertificateRef, getXmlBasicSignature, getXmlCertificateRef, getXmlCRLRevocationRef, getXmlDigestAlgoAndValue, getXmlDigestAlgoAndValue, getXmlForCertificateChain, getXmlForCertificateChain, getXmlForCertificateChain, getXmlFoundCertificates, getXmlFoundCertificates, getXmlOCSPRevocationRef, getXmlOrphanCertificate, getXmlRelatedCertificateForOrphanReferences, getXmlRevocationRefs, getXmlSignerInfo, getXmlSigningCertificate, getXmlStructuralValidation, populateCertificateOriginMap, populateOrphanCertificateOriginMap, populateXmlRelatedCertificatesList, populateXmlRelatedCertificatesList, tokenIdentifierProvider, verifyAgainstCertificateToken

Methods inherited from class Object

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

Field Details

signedDocument

protected DSSDocument signedDocument

The signed document

signatures

protected Collection<AdvancedSignature> signatures

The collection of signatures

usedTimestamps

protected Collection<TimestampToken> usedTimestamps

The collection of timestamp tokens

evidenceRecords

protected Collection<EvidenceRecord> evidenceRecords

The collection of evidence records

documentCertificateSource

protected ListCertificateSource documentCertificateSource

The list of all certificate sources extracted from a validating document (signature(s), timestamp(s))

documentCRLSource

protected ListRevocationSource<CRL> documentCRLSource

The list of all CRL revocation sources extracted from a validating document (signature(s), timestamp(s))

documentOCSPSource

protected ListRevocationSource<OCSP> documentOCSPSource

The list of all OCSP revocation sources extracted from a validating document (signature(s), timestamp(s))

xmlSignaturesMap

protected Map<String, XmlSignature> xmlSignaturesMap

The cached map of signatures

xmlTimestampsMap

protected Map<String, XmlTimestamp> xmlTimestampsMap

The cached map of timestamps

xmlEvidenceRecordMap

protected Map<String, XmlEvidenceRecord> xmlEvidenceRecordMap

The cached map of evidence records

xmlSignedDataMap

protected Map<String, XmlSignerData> xmlSignedDataMap

The cached map of original signed data

Constructor Details

SignedDocumentDiagnosticDataBuilder

public SignedDocumentDiagnosticDataBuilder()

Default constructor instantiating object with null values and empty maps

Method Details

usedCertificates

public SignedDocumentDiagnosticDataBuilder usedCertificates(Set<CertificateToken> usedCertificates)

Description copied from class: DiagnosticDataBuilder

This method allows to set the used certificates

Overrides:

usedCertificates in class DiagnosticDataBuilder

Parameters:

usedCertificates - the used certificates

Returns:

the builder

usedRevocations

public SignedDocumentDiagnosticDataBuilder usedRevocations(Set<RevocationToken<?>> usedRevocations)

Description copied from class: DiagnosticDataBuilder

This method allows to set the used revocation data

Overrides:

usedRevocations in class DiagnosticDataBuilder

Parameters:

usedRevocations - the used revocation data

Returns:

the builder

allCertificateSources

public SignedDocumentDiagnosticDataBuilder allCertificateSources(ListCertificateSource trustedCertSources)

Description copied from class: DiagnosticDataBuilder

This method allows to set ListCertificateSource containing all certificate sources used in the validator (including trusted certificate sources)

Overrides:

allCertificateSources in class DiagnosticDataBuilder

Parameters:

trustedCertSources - the list of trusted lists certificate sources

Returns:

the builder

validationDate

public SignedDocumentDiagnosticDataBuilder validationDate(Date validationDate)

Description copied from class: DiagnosticDataBuilder

This method allows to set the validation date

Overrides:

validationDate in class DiagnosticDataBuilder

Parameters:

validationDate - the validation date

Returns:

the builder

tokenExtractionStrategy

public SignedDocumentDiagnosticDataBuilder tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)

Description copied from class: DiagnosticDataBuilder

This method allows to set the TokenExtractionStrategy to follow for the token extraction

Overrides:

tokenExtractionStrategy in class DiagnosticDataBuilder

Parameters:

tokenExtractionStrategy - TokenExtractionStrategy to use

Returns:

the builder

defaultDigestAlgorithm

public SignedDocumentDiagnosticDataBuilder defaultDigestAlgorithm(DigestAlgorithm digestAlgorithm)

Description copied from class: DiagnosticDataBuilder

This method allows to set the default DigestAlgorithm which will be used for tokens' DigestAlgoAndValue calculation

Overrides:

defaultDigestAlgorithm in class DiagnosticDataBuilder

Parameters:

digestAlgorithm - DigestAlgorithm to set as default

Returns:

the builder

document

public SignedDocumentDiagnosticDataBuilder document(DSSDocument signedDocument)

This method allows to set the document which is analysed

Parameters:

signedDocument - the document which is analysed

Returns:

the builder

foundSignatures

public SignedDocumentDiagnosticDataBuilder foundSignatures(Collection<AdvancedSignature> signatures)

This method allows to set the found signatures

Parameters:

signatures - the found signatures

Returns:

the builder

usedTimestamps

public SignedDocumentDiagnosticDataBuilder usedTimestamps(Collection<TimestampToken> usedTimestamps)

This method allows to set the timestamps

Parameters:

usedTimestamps - a set of validated TimestampTokens

Returns:

the builder

foundEvidenceRecords

public SignedDocumentDiagnosticDataBuilder foundEvidenceRecords(Collection<EvidenceRecord> evidenceRecords)

This method allows to set the evidence records

Parameters:

evidenceRecords - a set of found EvidenceRecords

Returns:

the builder

documentCertificateSource

public SignedDocumentDiagnosticDataBuilder documentCertificateSource(ListCertificateSource documentCertificateSource)

Sets a document Certificate Source containing all sources extracted from the provided signature(s)/timestamp(s)

Parameters:

documentCertificateSource - ListCertificateSource computed from document sources

Returns:

the builder

documentCRLSource

public SignedDocumentDiagnosticDataBuilder documentCRLSource(ListRevocationSource<CRL> documentCRLSource)

Sets a document CRL Source containing all sources extracted from the provided signature(s)/timestamp(s)

Parameters:

documentCRLSource - ListRevocationSource computed from document sources

Returns:

the builder

documentOCSPSource

public SignedDocumentDiagnosticDataBuilder documentOCSPSource(ListRevocationSource<OCSP> documentCRLSource)

Sets a document OCSP Source containing all sources extracted from the provided signature(s)/timestamp(s)

Parameters:

documentCRLSource - ListRevocationSource computed from document sources

Returns:

the builder

build

public XmlDiagnosticData build()

Builds XmlDiagnosticData

Overrides:

build in class DiagnosticDataBuilder

Returns:

XmlDiagnosticData

assertConfigurationValid

protected void assertConfigurationValid()

This method verifies whether the configuration is valid in order to build a Diagnostic Data

linkSigningCertificateAndChains

protected void linkSigningCertificateAndChains(Set<CertificateToken> certificates)

Description copied from class: DiagnosticDataBuilder

Links the certificates and their certificate chains

Overrides:

linkSigningCertificateAndChains in class DiagnosticDataBuilder

Parameters:

certificates - a set of CertificateTokens

buildDetachedXmlSignature

public XmlSignature buildDetachedXmlSignature(AdvancedSignature signature)

Builds XmlSignature

Parameters:

signature - AdvancedSignature

Returns:

XmlSignature

emptyToNull

protected String emptyToNull(String text)

If text is empty returns NULL, or original text otherwise

Parameters:

text - String

Returns:

String

createOrphanTokenFromRevocationIdentifier

protected <R extends Revocation>
XmlOrphanRevocationToken createOrphanTokenFromRevocationIdentifier(EncapsulatedRevocationTokenIdentifier<R> revocationIdentifier)

Creates an orphan revocation token from EncapsulatedRevocationTokenIdentifier

Type Parameters:

R - Revocation

Parameters:

revocationIdentifier - EncapsulatedRevocationTokenIdentifier

Returns:

XmlOrphanRevocationToken

buildDetachedXmlTimestamp

protected XmlTimestamp buildDetachedXmlTimestamp(TimestampToken timestampToken)

This method builds XmlTimestamp from TimestampToken

Parameters:

timestampToken - TimestampToken

Returns:

XmlTimestamp

getXmlSignerInformationStore

protected List<XmlSignerInfo> getXmlSignerInformationStore(Set<SignerIdentifier> signerIdentifiers)

Builds a list of XmlSignerInfo from SignerIdentifiers

Parameters:

signerIdentifiers - a set of SignerIdentifier

Returns:

a list of XmlSignerInfos