com.entrust.toolkit.x509.certstore

Class CertificateGraph

java.lang.Object

com.entrust.toolkit.x509.certstore.CertificateStore

com.entrust.toolkit.x509.certstore.CertificateGraph

public class CertificateGraph
extends CertificateStore

Represents a certificate graph, which holds all certificates that are added to the memory cache.

CertificateGraph is a singleton (see Design Patterns by E. Gamma et al.).

Method Summary

Modifier and Type	Method and Description
boolean	addCertificate(X509Certificate cert) Adds a certificate to the graph and connects it to all issuers and all subjects.
void	clear() Removes all certificates from the CertificateGraph singleton.
CertificateSet	findCerts(GeneralName location) Generalized version of findCerts.
CertificateSet	findCerts(java.security.Principal dn) Returns all certificates for the entity specified in dn.
X509Certificate[]	getCertificates() This method returns all certificates that are currently in the certificate graph.
int	getTotalNumberOfCertificates() This method returns the total number of certificates in the certificate graph.
static CertificateGraph	Graph() Returns the Certificate Graph.
void	removeCertificate(X509Certificate cert) Removes a certificate from the graph.

Methods inherited from class com.entrust.toolkit.x509.certstore.CertificateStore

find

Methods inherited from class java.lang.Object

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

Method Detail

findCerts

public CertificateSet findCerts(java.security.Principal dn)

Returns all certificates for the entity specified in dn. If no certificate is found, this method returns null.

Specified by:

findCerts in class CertificateStore

Parameters:

dn - the distinguished name of the key owner

Returns:

the certificates of dn or null if no certificates for dn are found in this CertificateStore

Since:

7.0

findCerts

public CertificateSet findCerts(GeneralName location)
                         throws CertificationException

Generalized version of findCerts. In this case, only proceed if the GeneralName is an instance of the Principal class, otherwise return null because certificates cannot be found by this class.

Overrides:

findCerts in class CertificateStore

Parameters:

location - The GeneralName. It must represent a type of java.security.Principal or this check cannot be done.

Returns:

the certificates belonging to location, or null if no certificates for location are found in this CertificateStore

Throws:

CertificationException - if there is a problem finding the certificates.

addCertificate

public boolean addCertificate(X509Certificate cert)

Adds a certificate to the graph and connects it to all issuers and all subjects.

Parameters:

cert - the certificate to add

Returns:

true if the certificate was added

removeCertificate

public void removeCertificate(X509Certificate cert)

Removes a certificate from the graph.

Parameters:

cert - the certificate to remove

Graph

public static CertificateGraph Graph()

Returns the Certificate Graph. To ensure that there is only one certificate graph, the constructor is private. Use this method to get the certificate graph.

Returns:

the unique certificate graph

clear

public void clear()

Removes all certificates from the CertificateGraph singleton.

Note

This method might be useful when testing certificate validation, but your production code should never invoke it.

After the Toolkit has completed a certificate validation, the CertificateGraph singleton contains certificates collected while path finding. When testing certificate validations, this methods lets you create new CertVerifier objects that initialize from an empty Certificate Graph.

In any case, when this method is invoked, all CertVerifier and CollectionCS objects are immediately invalidated. Never call it while a certificate validation is in progress or a user is logged in.

See Also:

CertVerifier

getTotalNumberOfCertificates

public int getTotalNumberOfCertificates()

This method returns the total number of certificates in the certificate graph.

Returns:

The total number of certificates in the graph.

getCertificates

public X509Certificate[] getCertificates()

This method returns all certificates that are currently in the certificate graph.

Returns:

All certificates in the graph.