FileDocCategorySizeDatePackage
CertStoreSpi.javaAPI DocJava SE 5 API5138Fri Aug 26 14:57:16 BST 2005java.security.cert

CertStoreSpi

public abstract class CertStoreSpi extends Object
The Service Provider Interface (SPI) for the {@link CertStore 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.

version
1.7 12/19/03
since
1.4
author
Steve Hanna

Fields Summary
Constructors Summary
public CertStoreSpi(CertStoreParameters params)
The sole constructor.

param
params the initialization parameters (may be null)
throws
InvalidAlgorithmParameterException if the initialization parameters are inappropriate for this CertStoreSpi
Methods Summary
public abstract java.util.CollectionengineGetCRLs(java.security.cert.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.

param
selector A CRLSelector used to select which CRLs should be returned. Specify null to return all CRLs (if supported).
return
A Collection of CRLs that match the specified selector (never null)
throws
CertStoreException if an exception occurs

public abstract java.util.CollectionengineGetCertificates(java.security.cert.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.
param
selector A CertSelector used to select which
Certificates should be returned. Specify null
to return all Certificates (if supported).
return
A Collection of Certificates that
match the specified selector (never null)
throws
CertStoreException if an exception occurs