Package eu.europa.esig.dss.validation

Class DiagnosticDataBuilder

java.lang.Object

eu.europa.esig.dss.validation.DiagnosticDataBuilder

Direct Known Subclasses:

CertificateDiagnosticDataBuilder, SignedDocumentDiagnosticDataBuilder

public abstract class DiagnosticDataBuilder
extends Object

Contains a common code for DiagnosticData building

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,CertificateToken>	certificateIdsMap	A map between certificate id Strings and the related CertificateTokens
protected Map<CertificateToken,Set<CertificateSourceType>>	certificateSourceTypes	A map between certificate tokens and source types where they been obtained from
protected DigestAlgorithm	defaultDigestAlgorithm	The digest algorithm to use for digest computation
protected Map<String,String>	referenceMap	A map between references ids and their related token ids (used to map references for timestamped refs)
protected Map<String,CertificateToken>	signingCertificateMap	A map between certificate id Strings and the related CertificateTokens for signing certificates
protected TokenExtractionStrategy	tokenExtractionStrategy	The token extraction strategy
protected ListCertificateSource	trustedCertSources	The list of trusted certificate sources
protected Set<CertificateToken>	usedCertificates	The certificates used during the validation process
protected Set<RevocationToken<Revocation>>	usedRevocations	The revocation used during the validation process
protected Date	validationDate	The validation time
protected Map<String,XmlCertificate>	xmlCertsMap	The cached map of certificates
protected Map<String,XmlOrphanCertificateToken>	xmlOrphanCertificateTokensMap	The cached map of orphan certificates
protected Map<String,XmlOrphanRevocationToken>	xmlOrphanRevocationTokensMap	The cached map of orphan revocation data
protected Map<String,XmlRevocation>	xmlRevocationsMap	The cached map of revocation data
protected Map<String,XmlTrustedList>	xmlTrustedListsMap	The cached map of trusted lists

Constructor Summary

Constructors

Constructor	Description
DiagnosticDataBuilder()

Method Summary

Modifier and Type	Method	Description
XmlDiagnosticData	build()	Builds XmlDiagnosticData
protected XmlCertificate	buildDetachedXmlCertificate(CertificateToken certToken)
protected XmlRevocation	buildDetachedXmlRevocation(RevocationToken<Revocation> revocationToken)
DiagnosticDataBuilder	certificateSourceTypes(Map<CertificateToken,Set<CertificateSourceType>> certificateSourceTypes)	This method allows to set the certificate source types
DiagnosticDataBuilder	defaultDigestAlgorithm(DigestAlgorithm digestAlgorithm)	This method allows to set the default DigestAlgorithm which will be used for tokens' DigestAlgoAndValue calculation
protected CertificateToken	getUsedCertificateByCertificateRef(CertificateRef certificateRef)
protected XmlBasicSignature	getXmlBasicSignature(Token token)
protected XmlCertificateRef	getXmlCertificateRef(CertificateRef ref, CertificateRefOrigin origin)
protected XmlRevocationRef	getXmlCRLRevocationRef(CRLRef crlRef, Set<RevocationRefOrigin> origins)
protected XmlDigestAlgoAndValue	getXmlDigestAlgoAndValue(DigestAlgorithm digestAlgo, byte[] digestValue)
protected XmlDigestAlgoAndValue	getXmlDigestAlgoAndValue(Digest digest)
protected List<XmlChainItem>	getXmlForCertificateChain(Token token)
protected List<XmlChainItem>	getXmlForCertificateChain(PublicKey publicKey)
protected XmlFoundCertificates	getXmlFoundCertificates(Identifier tokenIdentifier, TokenCertificateSource certificateSource)
protected XmlRevocationRef	getXmlOCSPRevocationRef(OCSPRef ocspRef, Set<RevocationRefOrigin> origins)
protected XmlRelatedCertificate	getXmlRelatedCertificate(CertificateOrigin origin, CertificateToken cert, TokenCertificateSource certificateSource)
protected XmlRelatedCertificate	getXmlRelatedCertificate(TokenCertificateSource certificateSource, CertificateToken cert, CertificateRef certificateRef)
protected List<XmlRelatedCertificate>	getXmlRelatedCertificateForOrphanReferences(TokenCertificateSource certificateSource)
protected <R extends Revocation> List<XmlRevocationRef>	getXmlRevocationRefs(String tokenId, Map<RevocationRef<R>,Set<RevocationRefOrigin>> refsAndOrigins)
protected XmlSignerInfo	getXmlSignerInfo(CertificateIdentifier certificateIdentifier)
protected XmlSigningCertificate	getXmlSigningCertificate(Identifier tokenIdentifier, CertificateValidity certificateValidity)
protected void	populateCertificateOriginMap(Map<String,XmlRelatedCertificate> relatedCertificatesMap, CertificateOrigin origin, List<CertificateToken> certificateTokens, TokenCertificateSource certificateSource)
DiagnosticDataBuilder	tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)	This method allows to set the TokenExtractionStrategy to follow for the token extraction
DiagnosticDataBuilder	trustedCertificateSources(ListCertificateSource trustedCertSources)	This method allows to set the TrustedListsCertificateSources
DiagnosticDataBuilder	usedCertificates(Set<CertificateToken> usedCertificates)	This method allows to set the used certificates
DiagnosticDataBuilder	usedRevocations(Set<RevocationToken<Revocation>> usedRevocations)	This method allows to set the used revocation data
DiagnosticDataBuilder	validationDate(Date validationDate)	This method allows to set the validation date
protected void	verifyAgainstCertificateToken(XmlCertificateRef xmlCertificateRef, CertificateRef ref, CertificateToken signingCertificate)

Methods inherited from class java.lang.Object

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

Field Details

usedCertificates

protected Set<CertificateToken> usedCertificates

The certificates used during the validation process

usedRevocations

protected Set<RevocationToken<Revocation>> usedRevocations

The revocation used during the validation process

trustedCertSources

protected ListCertificateSource trustedCertSources

The list of trusted certificate sources

validationDate

protected Date validationDate

The validation time

certificateSourceTypes

protected Map<CertificateToken,Set<CertificateSourceType>> certificateSourceTypes

A map between certificate tokens and source types where they been obtained from

tokenExtractionStrategy

protected TokenExtractionStrategy tokenExtractionStrategy

The token extraction strategy

defaultDigestAlgorithm

protected DigestAlgorithm defaultDigestAlgorithm

The digest algorithm to use for digest computation

xmlCertsMap

protected Map<String,XmlCertificate> xmlCertsMap

The cached map of certificates

xmlRevocationsMap

protected Map<String,XmlRevocation> xmlRevocationsMap

The cached map of revocation data

xmlTrustedListsMap

protected Map<String,XmlTrustedList> xmlTrustedListsMap

The cached map of trusted lists

xmlOrphanCertificateTokensMap

protected Map<String,XmlOrphanCertificateToken> xmlOrphanCertificateTokensMap

The cached map of orphan certificates

xmlOrphanRevocationTokensMap

protected Map<String,XmlOrphanRevocationToken> xmlOrphanRevocationTokensMap

The cached map of orphan revocation data

referenceMap

protected Map<String,String> referenceMap

A map between references ids and their related token ids (used to map references for timestamped refs)

certificateIdsMap

protected Map<String,CertificateToken> certificateIdsMap

A map between certificate id Strings and the related CertificateTokens

signingCertificateMap

protected Map<String,CertificateToken> signingCertificateMap

A map between certificate id Strings and the related CertificateTokens for signing certificates

Constructor Details

DiagnosticDataBuilder

public DiagnosticDataBuilder()

Method Details

usedCertificates

public DiagnosticDataBuilder usedCertificates(Set<CertificateToken> usedCertificates)

This method allows to set the used certificates

Parameters:

usedCertificates - the used certificates

Returns:

the builder

certificateSourceTypes

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

This method allows to set the certificate source types

Parameters:

certificateSourceTypes - the certificate source types

Returns:

the builder

usedRevocations

public DiagnosticDataBuilder usedRevocations(Set<RevocationToken<Revocation>> usedRevocations)

This method allows to set the used revocation data

Parameters:

usedRevocations - the used revocation data

Returns:

the builder

trustedCertificateSources

public DiagnosticDataBuilder trustedCertificateSources(ListCertificateSource trustedCertSources)

This method allows to set the TrustedListsCertificateSources

Parameters:

trustedCertSources - the list of trusted lists certificate sources

Returns:

the builder

validationDate

public DiagnosticDataBuilder validationDate(Date validationDate)

This method allows to set the validation date

Parameters:

validationDate - the validation date

Returns:

the builder

tokenExtractionStrategy

public DiagnosticDataBuilder tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)

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

Parameters:

tokenExtractionStrategy - TokenExtractionStrategy to use

Returns:

the builder

defaultDigestAlgorithm

public DiagnosticDataBuilder defaultDigestAlgorithm(DigestAlgorithm digestAlgorithm)

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

Parameters:

digestAlgorithm - DigestAlgorithm to set as default

Returns:

the builder

build

public XmlDiagnosticData build()

Builds XmlDiagnosticData

Returns:

XmlDiagnosticData

getXmlSignerInfo

protected XmlSignerInfo getXmlSignerInfo(CertificateIdentifier certificateIdentifier)

buildDetachedXmlRevocation

protected XmlRevocation buildDetachedXmlRevocation(RevocationToken<Revocation> revocationToken)

getXmlRevocationRefs

protected <R extends Revocation>
List<XmlRevocationRef> getXmlRevocationRefs(String tokenId,
Map<RevocationRef<R>,Set<RevocationRefOrigin>> refsAndOrigins)

getXmlCRLRevocationRef

protected XmlRevocationRef getXmlCRLRevocationRef(CRLRef crlRef,
Set<RevocationRefOrigin> origins)

getXmlOCSPRevocationRef

protected XmlRevocationRef getXmlOCSPRevocationRef(OCSPRef ocspRef,
Set<RevocationRefOrigin> origins)

getXmlForCertificateChain

protected List<XmlChainItem> getXmlForCertificateChain(Token token)

getXmlForCertificateChain

protected List<XmlChainItem> getXmlForCertificateChain(PublicKey publicKey)

getXmlSigningCertificate

protected XmlSigningCertificate getXmlSigningCertificate(Identifier tokenIdentifier,
CertificateValidity certificateValidity)

getXmlFoundCertificates

protected XmlFoundCertificates getXmlFoundCertificates(Identifier tokenIdentifier,
TokenCertificateSource certificateSource)

populateCertificateOriginMap

protected void populateCertificateOriginMap(Map<String,XmlRelatedCertificate> relatedCertificatesMap,
CertificateOrigin origin,
List<CertificateToken> certificateTokens,
TokenCertificateSource certificateSource)

getXmlRelatedCertificate

protected XmlRelatedCertificate getXmlRelatedCertificate(CertificateOrigin origin,
CertificateToken cert,
TokenCertificateSource certificateSource)

getXmlRelatedCertificate

protected XmlRelatedCertificate getXmlRelatedCertificate(TokenCertificateSource certificateSource,
CertificateToken cert,
CertificateRef certificateRef)

getXmlCertificateRef

protected XmlCertificateRef getXmlCertificateRef(CertificateRef ref,
CertificateRefOrigin origin)

getXmlRelatedCertificateForOrphanReferences

protected List<XmlRelatedCertificate> getXmlRelatedCertificateForOrphanReferences(TokenCertificateSource certificateSource)

getUsedCertificateByCertificateRef

protected CertificateToken getUsedCertificateByCertificateRef(CertificateRef certificateRef)

verifyAgainstCertificateToken

protected void verifyAgainstCertificateToken(XmlCertificateRef xmlCertificateRef,
CertificateRef ref,
CertificateToken signingCertificate)

getXmlBasicSignature

protected XmlBasicSignature getXmlBasicSignature(Token token)

buildDetachedXmlCertificate

protected XmlCertificate buildDetachedXmlCertificate(CertificateToken certToken)

getXmlDigestAlgoAndValue

protected XmlDigestAlgoAndValue getXmlDigestAlgoAndValue(Digest digest)

getXmlDigestAlgoAndValue

protected XmlDigestAlgoAndValue getXmlDigestAlgoAndValue(DigestAlgorithm digestAlgo,
byte[] digestValue)