java.lang.Object java.security.cert.CertStore
public class CertStore
A class for retrieving Certificates and CRLs from a repository.
This class uses a provider-based
architecture.
architecture, as described in the Java Cryptography 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. See Appendix A in the Java Certification Path API Programmer's Guide for more information about standard CertStore types.
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.
Constructor Summary | |
---|---|
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. |
Method Summary | |
---|---|
Collection <? extends Certificate > |
getCertificates
(
CertSelector
selector) Returns a Collection of Certificates that match the specified selector. |
CertStoreParameters |
getCertStoreParameters
() Returns the parameters used to initialize this CertStore. |
Collection <? extends CRL > |
getCRLs
(
CRLSelector
selector) Returns a Collection of CRLs that match the specified selector. |
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
Returns a CertStore object that implements the specified CertStore type. |
static CertStore |
getInstance
(
String
type,
CertStoreParameters
params,
String
Returns a CertStore object that implements the specified CertStore type. |
Provider |
getProvider
() Returns the provider of this CertStore. |
String |
getType
() Returns the type of this CertStore. |
Methods inherited from class java.lang. Object |
---|
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait |
Constructor Detail |
---|
protected CertStore(CertStoreSpi storeSpi, Provider provider, String type, CertStoreParameters params)
Method Detail |
---|
public final Collection<? extends Certificate> getCertificates(CertSelector selector) throws CertStoreException
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.
public final Collection<? extends CRL> getCRLs(CRLSelector selector) throws CertStoreException
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.
public static CertStore getInstance(String type, CertStoreParameters params) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException
This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertStore object encapsulating the CertStoreSpi implementation from the first Provider that supports the specified type is returned.
If the default provider package provides an implementation of the specified CertStore type, an instance of CertStore containing that implementation is returned. If the requested type is not available in the default package, other packages are searched.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
The CertStore that is returned is initialized with the specified CertStoreParameters. The type of parameters needed may vary between different types of CertStores. Note that the specified CertStoreParameters object is cloned.
public static CertStore getInstance(String type, CertStoreParameters params, String provider) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, NoSuchProviderException
A new CertStore object encapsulating the CertStoreSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.
Note that the list of registered providers may be retrieved via the Security.getProviders() method.
The CertStore that is returned is initialized with the specified CertStoreParameters. The type of parameters needed may vary between different types of CertStores. Note that the specified CertStoreParameters object is cloned.
public static CertStore getInstance(String type, CertStoreParameters params, Provider provider) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException
A new CertStore object encapsulating the CertStoreSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.
The CertStore that is returned is initialized with the specified CertStoreParameters. The type of parameters needed may vary between different types of CertStores. Note that the specified CertStoreParameters object is cloned.
public final CertStoreParameters getCertStoreParameters()
public final String getType()
public final Provider getProvider()
public static final String getDefaultType()
The default CertStore type can be used by applications that do not want to use a hard-coded type when calling one of the getInstance methods, and want to provide a default CertStore type in case a user does not specify its own.
The default CertStore type can be changed by setting the value of the "certstore.type" security property (in the Java security properties file) to the desired type.