CertStore

public class CertStore extends Object

A class for retrieving Certificates and CRLs from a repository.

This class uses a provider-based architecture. To create a CertStore, call one of the static getInstance methods, passing in the type of CertStore desired, any applicable initialization parameters and optionally the name of the provider desired.

Once the CertStore has been created, it can be used to retrieve Certificates and CRLs by calling its getCertificates and getCRLs methods.

Unlike a KeyStore, which provides access to a cache of private keys and trusted certificates, a CertStore is designed to provide access to a potentially vast repository of untrusted certificates and CRLs. For example, an LDAP implementation of CertStore provides access to certificates and CRLs stored in one or more directories using the LDAP protocol and the schema as defined in the RFC service attribute.

Android provides the following CertStore types:

Name Supported (API Levels)
Collection 1+
This type is described in the CertStore section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Concurrent Access

All public methods of CertStore objects must be thread-safe. That is, multiple threads may concurrently invoke these methods on a single CertStore 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.

The static methods of this class are also guaranteed to be thread-safe. Multiple threads may concurrently invoke the static methods defined in this class with no ill effects.

Protected Constructor Summary

CertStore(CertStoreSpi storeSpi, Provider provider, String type, CertStoreParameters params)
Creates a CertStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.

Public Method Summary

final Collection<? extends CRL>
getCRLs(CRLSelector selector)
Returns a Collection of CRLs that match the specified selector.
final CertStoreParameters
getCertStoreParameters()
Returns the parameters used to initialize this CertStore.
final Collection<? extends Certificate>
getCertificates(CertSelector selector)
Returns a Collection of Certificates that match the specified selector.
final static String
getDefaultType()
Returns the default CertStore type as specified in the Java security properties file, or the string "LDAP" if no such property exists.
static CertStore
getInstance(String type, CertStoreParameters params)
Returns a CertStore object that implements the specified CertStore type and is initialized with the specified parameters.
static CertStore
getInstance(String type, CertStoreParameters params, Provider provider)
Returns a CertStore object that implements the specified CertStore type.
static CertStore
getInstance(String type, CertStoreParameters params, String provider)
Returns a CertStore object that implements the specified CertStore type.
final Provider
getProvider()
Returns the provider of this CertStore.
final String
getType()
Returns the type of this CertStore.

Inherited Method Summary

Protected Constructors

protected CertStore (CertStoreSpi storeSpi, Provider provider, String type, CertStoreParameters params)

Creates a CertStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.

Parameters
storeSpi the provider implementation
provider the provider
type the type
params the initialization parameters (may be null)

Public Methods

public final Collection<? extends CRL> getCRLs (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 A CRLSelector used to select which CRLs should be returned. Specify null to return all CRLs (if supported).
Returns
  • A Collection of CRLs that match the specified selector (never null)
Throws
CertStoreException if an exception occurs

public final CertStoreParameters getCertStoreParameters ()

Returns the parameters used to initialize this CertStore. Note that the CertStoreParameters object is cloned before it is returned.

Returns
  • the parameters used to initialize this CertStore (may be null)

public final Collection<? extends Certificate> getCertificates (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 A CertSelector used to select which Certificates should be returned. Specify null to return all Certificates (if supported).
Returns
    <