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

Class DiagnosticDataBuilder

java.lang.Object

eu.europa.esig.dss.validation.reports.diagnostic.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 ListCertificateSource	allCertificateSources	The list of all certificate sources
protected Map<String,CertificateToken>	certificateIdsMap	A map between certificate id Strings and the related CertificateTokens
protected DigestAlgorithm	defaultDigestAlgorithm	The digest algorithm to use for digest computation
protected TokenIdentifierProvider	identifierProvider	Generates ids for the tokens
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 Map<String,TLInfo>	tlInfoMap	The cached map of trusted lists with corresponding TLInfo
protected TokenExtractionStrategy	tokenExtractionStrategy	The token extraction strategy
protected Set<CertificateToken>	usedCertificates	The certificates used during the validation process
protected Set<RevocationToken<?>>	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

Modifier	Constructor	Description
protected	DiagnosticDataBuilder()	Default constructor instantiating object with null values

Method Summary

Modifier and Type	Method	Description
DiagnosticDataBuilder	allCertificateSources(ListCertificateSource allCertificateSources)	This method allows to set ListCertificateSource containing all certificate sources used in the validator (including trusted certificate sources)
XmlDiagnosticData	build()	Builds XmlDiagnosticData
protected XmlCertificate	buildDetachedXmlCertificate(CertificateToken certToken)	This method builds an XmlCertificate from the given CertificateToken
protected XmlRevocation	buildDetachedXmlRevocation(RevocationToken<?> revocationToken)	This method builds an XmlRevocation from the given RevocationToken
protected XmlOrphanCertificateToken	buildXmlOrphanCertificateToken(CertificateToken certificateToken)	This method builds an XmlOrphanCertificateToken from the given CertificateToken
protected XmlOrphanTokens	buildXmlOrphanTokens()	Builds a list of XmlOrphanTokens
DiagnosticDataBuilder	defaultDigestAlgorithm(DigestAlgorithm digestAlgorithm)	This method allows to set the default DigestAlgorithm which will be used for tokens' DigestAlgoAndValue calculation
protected Collection<CertificateToken>	getUsedCertificatesByCertificateRef(CertificateRef certificateRef)	Returns used certificate by the certificateRef
protected XmlBasicSignature	getXmlBasicSignature(Token token)	Gets XmlBasicSignature for a Token
protected XmlCertificateRef	getXmlCertificateRef(CertificateRef ref, CertificateRefOrigin origin)	Builds a XmlCertificateRef from CertificateRef
protected XmlRevocationRef	getXmlCRLRevocationRef(CRLRef crlRef, Set<RevocationRefOrigin> origins)	Builds a XmlRevocationRef from CRLRef
protected XmlDigestAlgoAndValue	getXmlDigestAlgoAndValue(DigestAlgorithm digestAlgo, byte[] digestValue)	Builds a XmlDigestAlgoAndValue for DigestAlgorithm and digestValue
protected XmlDigestAlgoAndValue	getXmlDigestAlgoAndValue(Digest digest)	Builds a XmlDigestAlgoAndValue for Digest
protected List<XmlChainItem>	getXmlForCertificateChain(Token token)	Returns a certificate chain for the token
protected List<XmlChainItem>	getXmlForCertificateChain(Token token, CertificateSource certificateSource)	Returns a certificate chain for the token from the certificateSource
protected List<XmlChainItem>	getXmlForCertificateChain(CertificateValidity certificateValidity, CertificateSource certificateSource)	Builds a certificate chain for a CertificateValidity
protected XmlFoundCertificates	getXmlFoundCertificates(Identifier tokenIdentifier, TokenCertificateSource certificateSource)	Returns found certificates from the source
protected XmlFoundCertificates	getXmlFoundCertificates(TokenCertificateSource certificateSource)	Returns found certificates from the source
protected XmlRevocationRef	getXmlOCSPRevocationRef(OCSPRef ocspRef, Set<RevocationRefOrigin> origins)	Builds a XmlRevocationRef from OCSPRef
protected XmlOrphanCertificate	getXmlOrphanCertificate(CertificateOrigin origin, CertificateToken certificateToken, TokenCertificateSource certificateSource, CertificateToken signingCertificate)	This method builds an XmlOrphanCertificateToken
protected List<XmlRelatedCertificate>	getXmlRelatedCertificateForOrphanReferences(TokenCertificateSource certificateSource)	Returns a list of XmlRelatedCertificates for orphan references within certificateSource
protected <R extends Revocation> List<XmlRevocationRef>	getXmlRevocationRefs(String tokenId, Map<RevocationRef<R>,Set<RevocationRefOrigin>> refsAndOrigins)	Returns a list of XmlRevocationRef for a token with tokenId
protected XmlSignerInfo	getXmlSignerInfo(SignerIdentifier signerIdentifier)	Creates a XmlSignerInfo from SignerIdentifier
protected XmlSigningCertificate	getXmlSigningCertificate(Identifier tokenIdentifier, CertificateValidity certificateValidity)	Gets a signing certificate token for a token with tokenIdentifier
protected void	linkSigningCertificateAndChains(Set<CertificateToken> certificates)	Links the certificates and their certificate chains
protected void	populateCertificateOriginMap(Map<String,XmlRelatedCertificate> relatedCertificatesMap, CertificateOrigin origin, List<CertificateToken> certificateTokens, TokenCertificateSource certificateSource)	Fills the certificates origins map with the given properties
protected void	populateOrphanCertificateOriginMap(Map<String,XmlOrphanCertificate> orphanCertificatesMap, CertificateOrigin origin, List<CertificateToken> certificateTokens, TokenCertificateSource certificateSource, CertificateToken signingCertificate)	Fills the orphan certificate map with the given values
protected XmlRelatedCertificate	populateXmlRelatedCertificatesList(CertificateOrigin origin, CertificateToken cert, TokenCertificateSource certificateSource)	Builds an XmlRelatedCertificate
protected void	populateXmlRelatedCertificatesList(List<XmlRelatedCertificate> relatesCertificates, TokenCertificateSource certificateSource, CertificateToken cert, CertificateRef certificateRef)	Builds an XmlRelatedCertificate and populates the relatesCertificates list
DiagnosticDataBuilder	tokenExtractionStrategy(TokenExtractionStrategy tokenExtractionStrategy)	This method allows to set the TokenExtractionStrategy to follow for the token extraction
DiagnosticDataBuilder	tokenIdentifierProvider(TokenIdentifierProvider identifierProvider)	This method allows to set the TokenIdentifierProvider for identifiers generation
DiagnosticDataBuilder	usedCertificates(Set<CertificateToken> usedCertificates)	This method allows to set the used certificates
DiagnosticDataBuilder	usedRevocations(Set<RevocationToken<?>> 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)	Verifies the reference against a certificate token

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<?>> usedRevocations

The revocation used during the validation process

allCertificateSources

protected ListCertificateSource allCertificateSources

The list of all certificate sources

validationDate

protected Date validationDate

The validation time

tokenExtractionStrategy

protected TokenExtractionStrategy tokenExtractionStrategy

The token extraction strategy

defaultDigestAlgorithm

protected DigestAlgorithm defaultDigestAlgorithm

The digest algorithm to use for digest computation

identifierProvider

protected TokenIdentifierProvider identifierProvider

Generates ids for the tokens

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

tlInfoMap

protected Map<String,TLInfo> tlInfoMap

The cached map of trusted lists with corresponding TLInfo

Constructor Details

DiagnosticDataBuilder

protected DiagnosticDataBuilder()

Default constructor instantiating object with null values

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

usedRevocations

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

This method allows to set the used revocation data

Parameters:

usedRevocations - the used revocation data

Returns:

the builder

allCertificateSources

public DiagnosticDataBuilder allCertificateSources(ListCertificateSource allCertificateSources)

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

Parameters:

allCertificateSources - 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

tokenIdentifierProvider

public DiagnosticDataBuilder tokenIdentifierProvider(TokenIdentifierProvider identifierProvider)

This method allows to set the TokenIdentifierProvider for identifiers generation

Parameters:

identifierProvider - TokenIdentifierProvider 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

linkSigningCertificateAndChains

protected void linkSigningCertificateAndChains(Set<CertificateToken> certificates)

Links the certificates and their certificate chains

Parameters:

certificates - a set of CertificateTokens

buildXmlOrphanTokens

protected XmlOrphanTokens buildXmlOrphanTokens()

Builds a list of XmlOrphanTokens

Returns:

XmlOrphanTokens

getXmlSignerInfo

protected XmlSignerInfo getXmlSignerInfo(SignerIdentifier signerIdentifier)

Creates a XmlSignerInfo from SignerIdentifier

Parameters:

signerIdentifier - SignerIdentifier

Returns:

XmlSignerInfo

buildDetachedXmlRevocation

protected XmlRevocation buildDetachedXmlRevocation(RevocationToken<?> revocationToken)

This method builds an XmlRevocation from the given RevocationToken

Parameters:

revocationToken - RevocationToken

Returns:

XmlRevocation

getXmlRevocationRefs

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

Returns a list of XmlRevocationRef for a token with tokenId

Type Parameters:

R - Revocation

Parameters:

tokenId - String

refsAndOrigins - a map of RevocationRefs and their RevocationRefOrigins

Returns:

a list of XmlRevocationRefs

getXmlCRLRevocationRef

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

Builds a XmlRevocationRef from CRLRef

Parameters:

crlRef - CRLRef

origins - a set of RevocationRefOrigins

Returns:

XmlRevocationRef

getXmlOCSPRevocationRef

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

Builds a XmlRevocationRef from OCSPRef

Parameters:

ocspRef - OCSPRef

origins - a set of RevocationRefOrigins

Returns:

XmlRevocationRef

getXmlForCertificateChain

protected List<XmlChainItem> getXmlForCertificateChain(Token token)

Returns a certificate chain for the token

Parameters:

token - Token

Returns:

a list of XmlChainItem

getXmlForCertificateChain

protected List<XmlChainItem> getXmlForCertificateChain(Token token,
 CertificateSource certificateSource)

Returns a certificate chain for the token from the certificateSource

Parameters:

token - Token

certificateSource - CertificateSource

Returns:

a list of XmlChainItem

getXmlForCertificateChain

protected List<XmlChainItem> getXmlForCertificateChain(CertificateValidity certificateValidity,
 CertificateSource certificateSource)

Builds a certificate chain for a CertificateValidity

Parameters:

certificateValidity - CertificateValidity

certificateSource - CertificateSource

Returns:

a list of XmlChainItem

getXmlSigningCertificate

protected XmlSigningCertificate getXmlSigningCertificate(Identifier tokenIdentifier,
 CertificateValidity certificateValidity)

Gets a signing certificate token for a token with tokenIdentifier

Parameters:

tokenIdentifier - Identifier

certificateValidity - CertificateValidity

Returns:

XmlSigningCertificate

getXmlFoundCertificates

protected XmlFoundCertificates getXmlFoundCertificates(TokenCertificateSource certificateSource)

Returns found certificates from the source

Parameters:

certificateSource - TokenCertificateSource

Returns:

XmlFoundCertificates

getXmlFoundCertificates

protected XmlFoundCertificates getXmlFoundCertificates(Identifier tokenIdentifier,
 TokenCertificateSource certificateSource)

Returns found certificates from the source

Parameters:

tokenIdentifier - Identifier of the token

certificateSource - TokenCertificateSource

Returns:

XmlFoundCertificates

populateCertificateOriginMap

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

Fills the certificates origins map with the given properties

Parameters:

relatedCertificatesMap - a map to fill

origin - CertificateOrigin

certificateTokens - a list of CertificateTokens

certificateSource - TokenCertificateSource

populateXmlRelatedCertificatesList

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

Builds an XmlRelatedCertificate

Parameters:

origin - CertificateOrigin

cert - CertificateToken

certificateSource - TokenCertificateSource

Returns:

XmlRelatedCertificate

populateXmlRelatedCertificatesList

protected void populateXmlRelatedCertificatesList(List<XmlRelatedCertificate> relatesCertificates,
 TokenCertificateSource certificateSource,
 CertificateToken cert,
 CertificateRef certificateRef)

Builds an XmlRelatedCertificate and populates the relatesCertificates list

Parameters:

relatesCertificates - a list of created earlier XmlRelatedCertificate

certificateSource - TokenCertificateSource

cert - CertificateToken

certificateRef - CertificateRef

getXmlCertificateRef

protected XmlCertificateRef getXmlCertificateRef(CertificateRef ref,
 CertificateRefOrigin origin)

Builds a XmlCertificateRef from CertificateRef

Parameters:

ref - XmlCertificateRef

origin - CertificateRefOrigin

Returns:

XmlCertificateRef

populateOrphanCertificateOriginMap

protected void populateOrphanCertificateOriginMap(Map<String,XmlOrphanCertificate> orphanCertificatesMap,
 CertificateOrigin origin,
 List<CertificateToken> certificateTokens,
 TokenCertificateSource certificateSource,
 CertificateToken signingCertificate)

Fills the orphan certificate map with the given values

Parameters:

orphanCertificatesMap - a map to fill

origin - CertificateOrigin

certificateTokens - a list of CertificateTokens

certificateSource - TokenCertificateSource

signingCertificate - CertificateToken

getXmlOrphanCertificate

protected XmlOrphanCertificate getXmlOrphanCertificate(CertificateOrigin origin,
 CertificateToken certificateToken,
 TokenCertificateSource certificateSource,
 CertificateToken signingCertificate)

This method builds an XmlOrphanCertificateToken

Parameters:

origin - CertificateOrigin

certificateToken - CertificateToken

certificateSource - TokenCertificateSource

signingCertificate - CertificateToken

Returns:

XmlOrphanCertificateToken

buildXmlOrphanCertificateToken

protected XmlOrphanCertificateToken buildXmlOrphanCertificateToken(CertificateToken certificateToken)

This method builds an XmlOrphanCertificateToken from the given CertificateToken

Parameters:

certificateToken - CertificateToken

Returns:

XmlOrphanCertificateToken

getXmlRelatedCertificateForOrphanReferences

protected List<XmlRelatedCertificate> getXmlRelatedCertificateForOrphanReferences(TokenCertificateSource certificateSource)

Returns a list of XmlRelatedCertificates for orphan references within certificateSource

Parameters:

certificateSource - TokenCertificateSource

Returns:

a list of XmlRelatedCertificates

getUsedCertificatesByCertificateRef

protected Collection<CertificateToken> getUsedCertificatesByCertificateRef(CertificateRef certificateRef)

Returns used certificate by the certificateRef

Parameters:

certificateRef - CertificateRef

Returns:

a collection of CertificateTokens

verifyAgainstCertificateToken

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

Verifies the reference against a certificate token

Parameters:

xmlCertificateRef - XmlCertificateRef

ref - CertificateRef

signingCertificate - CertificateToken

getXmlBasicSignature

protected XmlBasicSignature getXmlBasicSignature(Token token)

Gets XmlBasicSignature for a Token

Parameters:

token - Token

Returns:

XmlBasicSignature

buildDetachedXmlCertificate

protected XmlCertificate buildDetachedXmlCertificate(CertificateToken certToken)

This method builds an XmlCertificate from the given CertificateToken

Parameters:

certToken - CertificateToken

Returns:

XmlCertificate

getXmlDigestAlgoAndValue

protected XmlDigestAlgoAndValue getXmlDigestAlgoAndValue(Digest digest)

Builds a XmlDigestAlgoAndValue for Digest

Parameters:

digest - Digest

Returns:

XmlDigestAlgoAndValue

getXmlDigestAlgoAndValue

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

Builds a XmlDigestAlgoAndValue for DigestAlgorithm and digestValue

Parameters:

digestAlgo - DigestAlgorithm

digestValue - digest value bytes

Returns:

XmlDigestAlgoAndValue