Skip to content

Most visited

Recently visited

navigation
Added in API level 1

CertStoreSpi

public abstract class CertStoreSpi
extends Object

java.lang.Object
   ↳ java.security.cert.CertStoreSpi


The Service Provider Interface (SPI) for the CertStore class. All CertStore implementations must include a class (the SPI class) that extends this class (CertStoreSpi), provides a constructor with a single argument of type CertStoreParameters, and implements all of its methods. In general, instances of this class should only be accessed through the CertStore class. For details, see the Java Cryptography Architecture.

Concurrent Access

The public methods of all CertStoreSpi objects must be thread-safe. That is, multiple threads may concurrently invoke these methods on a single CertStoreSpi object (or more than one) with no ill effects. This allows a CertPathBuilder to search for a CRL while simultaneously searching for further certificates, for instance.

Simple CertStoreSpi implementations will probably ensure thread safety by adding a synchronized keyword to their engineGetCertificates and engineGetCRLs methods. More sophisticated ones may allow truly concurrent access.

Summary

Public constructors

CertStoreSpi(CertStoreParameters params)

The sole constructor.

Public methods

abstract Collection<? extends CRL> engineGetCRLs(CRLSelector selector)

Returns a Collection of CRLs that match the specified selector.

abstract Collection<? extends Certificate> engineGetCertificates(CertSelector selector)

Returns a Collection of Certificates that match the specified selector.

Inherited methods

From class java.lang.Object

Public constructors

CertStoreSpi

Added in API level 1
CertStoreSpi (CertStoreParameters params)

The sole constructor.

Parameters
params CertStoreParameters: the initialization parameters (may be null)
Throws
InvalidAlgorithmParameterException if the initialization parameters are inappropriate for this CertStoreSpi

Public methods

engineGetCRLs

Added in API level 1
Collection<? extends CRL> engineGetCRLs (CRLSelector selector)

Returns a Collection of CRLs that match the specified selector. If no CRLs match the selector, an empty Collection will be returned.

For some CertStore types, the resulting Collection may not contain all of the CRLs that match the selector. For instance, an LDAP CertStore may not search all entries in the directory. Instead, it may just search entries that are likely to contain the CRLs it is looking for.

Some CertStore implementations (especially LDAP CertStores) may throw a CertStoreException unless a non-null CRLSelector is provided that includes specific criteria that can be used to find the CRLs. Issuer names and/or the certificate to be checked are especially useful.

Parameters
selector CRLSelector: A CRLSelector used to select which CRLs should be returned. Specify null to return all CRLs (if supported).
Returns
Collection<? extends CRL> A Collection of CRLs that match the specified selector (never null)
Throws
CertStoreException if an exception occurs

engineGetCertificates

Added in API level 1
Collection<? extends Certificate> engineGetCertificates (CertSelector selector)

Returns a Collection of Certificates that match the specified selector. If no Certificates match the selector, an empty Collection will be returned.

For some CertStore types, the resulting Collection may not contain all of the Certificates that match the selector. For instance, an LDAP CertStore may not search all entries in the directory. Instead, it may just search entries that are likely to contain the Certificates it is looking for.

Some CertStore implementations (especially LDAP CertStores) may throw a CertStoreException unless a non-null CertSelector is provided that includes specific criteria that can be used to find the certificates. Issuer and/or subject names are especially useful criteria.

Parameters
selector CertSelector: A CertSelector used to select which Certificates should be returned. Specify null to return all Certificates (if supported).
Returns
Collection<? extends Certificate> A Collection of Certificates that match the specified selector (never null)
Throws
CertStoreException if an exception occurs
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.