Package eu.europa.esig.dss.spi.x509

Class ListCertificateSource

java.lang.Object

eu.europa.esig.dss.spi.x509.ListCertificateSource

All Implemented Interfaces:

CertificateSource, Serializable

public class ListCertificateSource
extends Object
implements CertificateSource

This class operates on several CertificateSource with the composite design pattern.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ListCertificateSource()	Default constructor
ListCertificateSource(CertificateSource certificateSource)	This constructor allows to instantiate an object of the class with one CertificateSource
ListCertificateSource(List<CertificateSource> certificateSources)	This constructor allows to instantiate an object of the class with a list of CertificateSource

Method Summary

Modifier and Type	Method	Description
void	add(CertificateSource certificateSource)	This method allows to add a certificate source to the list
void	addAll(ListCertificateSource listCertificateSource)	Allows to add a list of embedded certificate sources to the list of certificate sources
void	addAll(List<CertificateSource> certificateSources)	Allows to add a list of certificate sources
CertificateToken	addCertificate(CertificateToken certificate)	This method allows to manually add any certificate to the source.
boolean	areAllCertSourcesTrusted()	Checks if the ListCertificateSource contains only trusted CertificateSources
boolean	containsTrustedCertSources()	This method verifies if the current list of certificate sources contains a trusted certificate source
Set<CertificateToken>	findTokensFromCertRef(CertificateRef certificateRef)	Returns Set of CertificateTokens for the provided CertificateRef
Set<CertificateToken>	getByCertificateDigest(Digest digest)	This method returns the found CertificateToken from all CertificateSource for the given Digest.
Set<CertificateToken>	getByPublicKey(PublicKey publicKey)	This method returns the found CertificateToken from all CertificateSource for the given PublicKey.
Set<CertificateToken>	getBySignerIdentifier(SignerIdentifier signerIdentifier)	This method returns the Set of certificates with the CertificateIdentifier
Set<CertificateToken>	getBySki(byte[] ski)	This method returns the found CertificateToken from all CertificateSource for the given subject key identifier (SHA-1 of the public key).
Set<CertificateToken>	getBySubject(X500PrincipalHelper subject)	This method returns the found CertificateToken from all CertificateSource for the given X500PrincipalHelper.
List<CertificateToken>	getCertificates()	Retrieves the unmodifiable list of all certificate tokens from this source.
CertificateSourceType	getCertificateSourceType()	This method returns the certificate source type associated to the implementation class.
Set<CertificateSourceType>	getCertificateSourceType(CertificateToken certificateToken)	This method return the different CertificateSourceType where the certificate is found
List<CertificateSourceEntity>	getEntities()	Returns a list of certificates grouped by their public keys
int	getNumberOfCertificates()	This method returns the number of found CertificateToken in all sources
int	getNumberOfEntities()	This method returns the number of found CertificateSourceEntity in all sources
int	getNumberOfSources()	This method returns the number of set CertificateSources
List<CertificateSource>	getSources()	Returns an unmodifiable list of embedded CertificateSources
boolean	isAllSelfSigned()	This method checks in all sources if all embedded certificate are self-signed
boolean	isCertificateSourceEqual(CertificateSource certificateSource)	This method checks if the current and the given CertificateSources contain the same certificate tokens
boolean	isCertificateSourceEquivalent(CertificateSource certificateSource)	This method checks if the current and the given CertificateSources contain the same public keys
boolean	isEmpty()	This method checks if the embed sources is empty
boolean	isKnown(CertificateToken certificateToken)	This method checks if a given certificate is known in the current source
boolean	isTrusted(CertificateToken certificateToken)	This method checks in all sources in the given certificate is trusted

Methods inherited from class java.lang.Object

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

Constructor Details

ListCertificateSource

public ListCertificateSource()

Default constructor

ListCertificateSource

public ListCertificateSource(CertificateSource certificateSource)

This constructor allows to instantiate an object of the class with one CertificateSource

Parameters:

certificateSource - CertificateSource

ListCertificateSource

public ListCertificateSource(List<CertificateSource> certificateSources)

This constructor allows to instantiate an object of the class with a list of CertificateSource

Parameters:

certificateSources - a list of CertificateSource

Method Details

addAll

public void addAll(ListCertificateSource listCertificateSource)

Allows to add a list of embedded certificate sources to the list of certificate sources

Parameters:

listCertificateSource - ListCertificateSource

addAll

public void addAll(List<CertificateSource> certificateSources)

Allows to add a list of certificate sources

Parameters:

certificateSources - a list of CertificateSources to add

add

public void add(CertificateSource certificateSource)

This method allows to add a certificate source to the list

Parameters:

certificateSource - CertificateSource

getSources

public List<CertificateSource> getSources()

Returns an unmodifiable list of embedded CertificateSources

Returns:

a list of CertificateSources

isEmpty

public boolean isEmpty()

This method checks if the embed sources is empty

Returns:

true if no source has been added

areAllCertSourcesTrusted

public boolean areAllCertSourcesTrusted()

Checks if the ListCertificateSource contains only trusted CertificateSources

Returns:

TRUE if all embedded CertificateSources are trusted, FALSE otherwise

containsTrustedCertSources

public boolean containsTrustedCertSources()

This method verifies if the current list of certificate sources contains a trusted certificate source

Returns:

TRUE if the list certificate source contains a trusted certificate source, FALSE otherwise

addCertificate

public CertificateToken addCertificate(CertificateToken certificate)

Description copied from interface: CertificateSource

This method allows to manually add any certificate to the source. The type of the source is automatically set par each specific implementation.

Specified by:

addCertificate in interface CertificateSource

Parameters:

certificate - the certificate you have to trust

Returns:

the corresponding certificate token

getCertificateSourceType

public CertificateSourceType getCertificateSourceType()

Description copied from interface: CertificateSource

This method returns the certificate source type associated to the implementation class.

Specified by:

getCertificateSourceType in interface CertificateSource

Returns:

the certificate origin

getCertificates

public List<CertificateToken> getCertificates()

Description copied from interface: CertificateSource

Retrieves the unmodifiable list of all certificate tokens from this source.

Specified by:

getCertificates in interface CertificateSource

Returns:

all certificates from this source

isTrusted

public boolean isTrusted(CertificateToken certificateToken)

This method checks in all sources in the given certificate is trusted

Specified by:

isTrusted in interface CertificateSource

Parameters:

certificateToken - the CertificateToken to be checked

Returns:

true if the certificate is trusted

isKnown

public boolean isKnown(CertificateToken certificateToken)

Description copied from interface: CertificateSource

This method checks if a given certificate is known in the current source

Specified by:

isKnown in interface CertificateSource

Parameters:

certificateToken - the certificate to be tested

Returns:

true if the certificate is part of the current source

isAllSelfSigned

public boolean isAllSelfSigned()

This method checks in all sources if all embedded certificate are self-signed

Specified by:

isAllSelfSigned in interface CertificateSource

Returns:

true if all certificates from all sources are self-signed

isCertificateSourceEqual

public boolean isCertificateSourceEqual(CertificateSource certificateSource)

Description copied from interface: CertificateSource

This method checks if the current and the given CertificateSources contain the same certificate tokens

Specified by:

isCertificateSourceEqual in interface CertificateSource

Parameters:

certificateSource - CertificateSource to compare

Returns:

TRUE if both certificate sources contains the same certificate tokens, FALSE otherwise

isCertificateSourceEquivalent

public boolean isCertificateSourceEquivalent(CertificateSource certificateSource)

Description copied from interface: CertificateSource

This method checks if the current and the given CertificateSources contain the same public keys

Specified by:

isCertificateSourceEquivalent in interface CertificateSource

Parameters:

certificateSource - CertificateSource to compare

Returns:

TRUE if both certificate sources contains the same public keys, FALSE otherwise

getCertificateSourceType

public Set<CertificateSourceType> getCertificateSourceType(CertificateToken certificateToken)

This method return the different CertificateSourceType where the certificate is found

Parameters:

certificateToken - the CertificateToken to be found

Returns:

a Set with the different sources

getByPublicKey

public Set<CertificateToken> getByPublicKey(PublicKey publicKey)

This method returns the found CertificateToken from all CertificateSource for the given PublicKey.

Specified by:

getByPublicKey in interface CertificateSource

Parameters:

publicKey - the PublicKey to find in the sources

Returns:

a Set of found CertificateToken

getBySki

public Set<CertificateToken> getBySki(byte[] ski)

This method returns the found CertificateToken from all CertificateSource for the given subject key identifier (SHA-1 of the public key).

Specified by:

getBySki in interface CertificateSource

Parameters:

ski - the subject key identifier to find in the sources

Returns:

a Set of found CertificateToken

findTokensFromCertRef

public Set<CertificateToken> findTokensFromCertRef(CertificateRef certificateRef)

Description copied from interface: CertificateSource

Returns Set of CertificateTokens for the provided CertificateRef

Specified by:

findTokensFromCertRef in interface CertificateSource

Parameters:

certificateRef - a CertificateRef

Returns:

Set of CertificateTokens

getEntities

public List<CertificateSourceEntity> getEntities()

Description copied from interface: CertificateSource

Returns a list of certificates grouped by their public keys

Specified by:

getEntities in interface CertificateSource

Returns:

a list of CertificateSourceEntitys

getBySubject

public Set<CertificateToken> getBySubject(X500PrincipalHelper subject)

This method returns the found CertificateToken from all CertificateSource for the given X500PrincipalHelper.

Specified by:

getBySubject in interface CertificateSource

Parameters:

subject - the X500PrincipalHelper to find in the sources

Returns:

a Set of found CertificateToken

getBySignerIdentifier

public Set<CertificateToken> getBySignerIdentifier(SignerIdentifier signerIdentifier)

Description copied from interface: CertificateSource

This method returns the Set of certificates with the CertificateIdentifier

Specified by:

getBySignerIdentifier in interface CertificateSource

Parameters:

signerIdentifier - the certificate identifier to match

Returns:

If no match is found then an empty set is returned.

getByCertificateDigest

public Set<CertificateToken> getByCertificateDigest(Digest digest)

This method returns the found CertificateToken from all CertificateSource for the given Digest.

Specified by:

getByCertificateDigest in interface CertificateSource

Parameters:

digest - the Digest to find in the sources

Returns:

a Set of found CertificateToken

getNumberOfSources

public int getNumberOfSources()

This method returns the number of set CertificateSources

Returns:

the number of found CertificateSource

getNumberOfCertificates

public int getNumberOfCertificates()

This method returns the number of found CertificateToken in all sources

Returns:

the number of found CertificateToken

getNumberOfEntities

public int getNumberOfEntities()

This method returns the number of found CertificateSourceEntity in all sources

Returns:

the number of found CertificateSourceEntity