Package eu.europa.esig.dss.validation

Class SignedDocumentDiagnosticDataBuilder

java.lang.Object

eu.europa.esig.dss.validation.DiagnosticDataBuilder

eu.europa.esig.dss.validation.SignedDocumentDiagnosticDataBuilder

Direct Known Subclasses:

ASiCContainerDiagnosticDataBuilder, CAdESDiagnosticDataBuilder

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 ListRevocationSource<CRL>	commonCRLSource	The list of all CRL revocation sources
protected ListRevocationSource<OCSP>	commonOCSPSource	The list of all OCSP revocation sources
protected SignaturePolicyProvider	signaturePolicyProvider	The signature policy provider
protected List<AdvancedSignature>	signatures	The list of signatures
protected DSSDocument	signedDocument	The signed document
protected Set<TimestampToken>	usedTimestamps	The list of timestamp tokens
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 eu.europa.esig.dss.validation.DiagnosticDataBuilder

certificateIdsMap, certificateSourceTypes, defaultDigestAlgorithm, referenceMap, signingCertificateMap, tokenExtractionStrategy, trustedCertSources, usedCertificates, usedRevocations, validationDate, xmlCertsMap, xmlOrphanCertificateTokensMap, xmlOrphanRevocationTokensMap, xmlRevocationsMap, xmlTrustedListsMap

Constructor Summary

Constructors

Constructor	Description
SignedDocumentDiagnosticDataBuilder()

Method Summary

Modifier and Type	Method	Description
XmlDiagnosticData	build()	Builds XmlDiagnosticData
XmlSignature	buildDetachedXmlSignature(AdvancedSignature signature)	Builds XmlSignature
protected XmlTimestamp	buildDetachedXmlTimestamp(TimestampToken timestampToken)
protected XmlOrphanTokens	buildXmlOrphanTokens()
protected XmlSignerData	buildXmlSignerData(SignatureScope signatureScope)
SignedDocumentDiagnosticDataBuilder	certificateSourceTypes(Map<CertificateToken,Set<CertificateSourceType>> certificateSourceTypes)	This method allows to set the certificate source types
SignedDocumentDiagnosticDataBuilder	completeCRLSource(ListRevocationSource<CRL> completeCRLSource)	Sets a merged CRL Source
SignedDocumentDiagnosticDataBuilder	completeOCSPSource(ListRevocationSource<OCSP> completeOCSPSource)	Sets a merged OCSP Source
protected <R extends Revocation> XmlOrphanRevocationToken	createOrphanTokenFromRevocationIdentifier(EncapsulatedRevocationTokenIdentifier<R> revocationIdentifier)
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
protected String	emptyToNull(String text)
SignedDocumentDiagnosticDataBuilder	foundSignatures(List<AdvancedSignature> signatures)	This method allows to set the found signatures
protected List<XmlSignerInfo>	getXmlSignerInformationStore(Set<CertificateIdentifier> certificateIdentifiers)
SignedDocumentDiagnosticDataBuilder	signaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)	This method allows to set the SignaturePolicyProvider
SignedDocumentDiagnosticDataBuilder	tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)	This method allows to set the TokenExtractionStrategy to follow for the token extraction
SignedDocumentDiagnosticDataBuilder	trustedCertificateSources(ListCertificateSource trustedCertSources)	This method allows to set the TrustedListsCertificateSources
SignedDocumentDiagnosticDataBuilder	usedCertificates(Set<CertificateToken> usedCertificates)	This method allows to set the used certificates
SignedDocumentDiagnosticDataBuilder	usedRevocations(Set<RevocationToken<Revocation>> usedRevocations)	This method allows to set the used revocation data
SignedDocumentDiagnosticDataBuilder	usedTimestamps(Set<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 eu.europa.esig.dss.validation.DiagnosticDataBuilder

buildDetachedXmlCertificate, buildDetachedXmlRevocation, getUsedCertificateByCertificateRef, getXmlBasicSignature, getXmlCertificateRef, getXmlCRLRevocationRef, getXmlDigestAlgoAndValue, getXmlDigestAlgoAndValue, getXmlForCertificateChain, getXmlForCertificateChain, getXmlFoundCertificates, getXmlOCSPRevocationRef, getXmlRelatedCertificate, getXmlRelatedCertificate, getXmlRelatedCertificateForOrphanReferences, getXmlRevocationRefs, getXmlSignerInfo, getXmlSigningCertificate, populateCertificateOriginMap, verifyAgainstCertificateToken

Methods inherited from class java.lang.Object

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

Field Details

signedDocument

protected DSSDocument signedDocument

The signed document

signatures

protected List<AdvancedSignature> signatures

The list of signatures

usedTimestamps

protected Set<TimestampToken> usedTimestamps

The list of timestamp tokens

signaturePolicyProvider

protected SignaturePolicyProvider signaturePolicyProvider

The signature policy provider

commonCRLSource

protected ListRevocationSource<CRL> commonCRLSource

The list of all CRL revocation sources

commonOCSPSource

protected ListRevocationSource<OCSP> commonOCSPSource

The list of all OCSP revocation sources

xmlSignaturesMap

protected Map<String,XmlSignature> xmlSignaturesMap

The cached map of signatures

xmlTimestampsMap

protected Map<String,XmlTimestamp> xmlTimestampsMap

The cached map of timestamps

xmlSignedDataMap

protected Map<String,XmlSignerData> xmlSignedDataMap

The cached map of original signed data

Constructor Details

SignedDocumentDiagnosticDataBuilder

public SignedDocumentDiagnosticDataBuilder()

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

certificateSourceTypes

public SignedDocumentDiagnosticDataBuilder certificateSourceTypes(Map<CertificateToken,Set<CertificateSourceType>> certificateSourceTypes)

Description copied from class: DiagnosticDataBuilder

This method allows to set the certificate source types

Overrides:

certificateSourceTypes in class DiagnosticDataBuilder

Parameters:

certificateSourceTypes - the certificate source types

Returns:

the builder

usedRevocations

public SignedDocumentDiagnosticDataBuilder usedRevocations(Set<RevocationToken<Revocation>> 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

trustedCertificateSources

public SignedDocumentDiagnosticDataBuilder trustedCertificateSources(ListCertificateSource trustedCertSources)

Description copied from class: DiagnosticDataBuilder

This method allows to set the TrustedListsCertificateSources

Overrides:

trustedCertificateSources 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(List<AdvancedSignature> signatures)

This method allows to set the found signatures

Parameters:

signatures - the found signatures

Returns:

the builder

usedTimestamps

public SignedDocumentDiagnosticDataBuilder usedTimestamps(Set<TimestampToken> usedTimestamps)

This method allows to set the timestamps

Parameters:

usedTimestamps - a set of validated TimestampTokens

Returns:

the builder

signaturePolicyProvider

public SignedDocumentDiagnosticDataBuilder signaturePolicyProvider(SignaturePolicyProvider signaturePolicyProvider)

This method allows to set the SignaturePolicyProvider

Parameters:

signaturePolicyProvider - SignaturePolicyProvider

Returns:

the builder

completeCRLSource

public SignedDocumentDiagnosticDataBuilder completeCRLSource(ListRevocationSource<CRL> completeCRLSource)

Sets a merged CRL Source

Parameters:

completeCRLSource - ListRevocationSource computed from existing sources

Returns:

the builder

completeOCSPSource

public SignedDocumentDiagnosticDataBuilder completeOCSPSource(ListRevocationSource<OCSP> completeOCSPSource)

Sets a merged OCSP Source

Parameters:

completeOCSPSource - ListRevocationSource computed from existing sources

Returns:

the builder

build

public XmlDiagnosticData build()

Builds XmlDiagnosticData

Overrides:

build in class DiagnosticDataBuilder

Returns:

XmlDiagnosticData

buildXmlSignerData

protected XmlSignerData buildXmlSignerData(SignatureScope signatureScope)

buildDetachedXmlSignature

public XmlSignature buildDetachedXmlSignature(AdvancedSignature signature)

Builds XmlSignature

Parameters:

signature - AdvancedSignature

Returns:

XmlSignature

emptyToNull

protected String emptyToNull(String text)

createOrphanTokenFromRevocationIdentifier

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

buildDetachedXmlTimestamp

protected XmlTimestamp buildDetachedXmlTimestamp(TimestampToken timestampToken)

getXmlSignerInformationStore

protected List<XmlSignerInfo> getXmlSignerInformationStore(Set<CertificateIdentifier> certificateIdentifiers)

buildXmlOrphanTokens

protected XmlOrphanTokens buildXmlOrphanTokens()