java.security.cert
Class CertStore

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.security.cert.CertStore

public class CertStore
extends Object sample code for java.lang.Object definition code for java.lang.Object

A class for retrieving Certificates and CRLs from a repository.

This class uses a provider-based 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 sample code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector) definition code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector) and getCRLs sample code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector) definition code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector) methods.

Unlike a KeyStore sample code for java.security.KeyStore definition code for java.security.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.

Since:
1.4

Constructor Summary
protected CertStore sample code for java.security.cert.CertStore.CertStore(java.security.cert.CertStoreSpi, java.security.Provider, java.lang.String, java.security.cert.CertStoreParameters) definition code for java.security.cert.CertStore.CertStore(java.security.cert.CertStoreSpi, java.security.Provider, java.lang.String, java.security.cert.CertStoreParameters) (CertStoreSpi sample code for java.security.cert.CertStoreSpi definition code for java.security.cert.CertStoreSpi  storeSpi, Provider sample code for java.security.Provider definition code for java.security.Provider  provider, String sample code for java.lang.String definition code for java.lang.String  type, CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params)
          Creates a CertStore object of the given type, and encapsulates the given provider implementation (SPI object) in it.
 
Method Summary
 Collection sample code for java.util.Collection definition code for java.util.Collection <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > getCertificates sample code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector) definition code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector) (CertSelector sample code for java.security.cert.CertSelector definition code for java.security.cert.CertSelector  selector)
          Returns a Collection of Certificates that match the specified selector.
 CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters getCertStoreParameters sample code for java.security.cert.CertStore.getCertStoreParameters() definition code for java.security.cert.CertStore.getCertStoreParameters() ()
          Returns the parameters used to initialize this CertStore.
 Collection sample code for java.util.Collection definition code for java.util.Collection <? extends CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL > getCRLs sample code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector) definition code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector) (CRLSelector sample code for java.security.cert.CRLSelector definition code for java.security.cert.CRLSelector  selector)
          Returns a Collection of CRLs that match the specified selector.
static String sample code for java.lang.String definition code for java.lang.String getDefaultType sample code for java.security.cert.CertStore.getDefaultType() definition code for java.security.cert.CertStore.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 sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters) (String sample code for java.lang.String definition code for java.lang.String  type, CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params)
          Returns a CertStore object that implements the specified CertStore type and is initialized with the specified parameters.
static CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.security.Provider) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.security.Provider) (String sample code for java.lang.String definition code for java.lang.String  type, CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params, Provider sample code for java.security.Provider definition code for java.security.Provider  provider)
          Returns a CertStore object that implements the specified CertStore type, as supplied by the specified provider and initialized with the specified parameters.
static CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.lang.String) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  type, CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params, String sample code for java.lang.String definition code for java.lang.String  provider)
          Returns a CertStore object that implements the specified CertStore type, as supplied by the specified provider and initialized with the specified parameters.
 Provider sample code for java.security.Provider definition code for java.security.Provider getProvider sample code for java.security.cert.CertStore.getProvider() definition code for java.security.cert.CertStore.getProvider() ()
          Returns the provider of this CertStore.
 String sample code for java.lang.String definition code for java.lang.String getType sample code for java.security.cert.CertStore.getType() definition code for java.security.cert.CertStore.getType() ()
          Returns the type of this CertStore.
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Constructor Detail

CertStore sample code for java.security.cert.CertStore(java.security.cert.CertStoreSpi, java.security.Provider, java.lang.String, java.security.cert.CertStoreParameters) definition code for java.security.cert.CertStore(java.security.cert.CertStoreSpi, java.security.Provider, java.lang.String, java.security.cert.CertStoreParameters)

protected CertStore(CertStoreSpi sample code for java.security.cert.CertStoreSpi definition code for java.security.cert.CertStoreSpi  storeSpi,
                    Provider sample code for java.security.Provider definition code for java.security.Provider  provider,
                    String sample code for java.lang.String definition code for java.lang.String  type,
                    CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.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)
Method Detail

getCertificates sample code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector) definition code for java.security.cert.CertStore.getCertificates(java.security.cert.CertSelector)

public final Collection sample code for java.util.Collection definition code for java.util.Collection <? extends Certificate sample code for java.security.cert.Certificate definition code for java.security.cert.Certificate > getCertificates(CertSelector sample code for java.security.cert.CertSelector definition code for java.security.cert.CertSelector  selector)
                                                        throws CertStoreException sample code for java.security.cert.CertStoreException definition code for java.security.cert.CertStoreException 
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:
A Collection of Certificates that match the specified selector (never null)
Throws:
CertStoreException sample code for java.security.cert.CertStoreException definition code for java.security.cert.CertStoreException - if an exception occurs

getCRLs sample code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector) definition code for java.security.cert.CertStore.getCRLs(java.security.cert.CRLSelector)

public final Collection sample code for java.util.Collection definition code for java.util.Collection <? extends CRL sample code for java.security.cert.CRL definition code for java.security.cert.CRL > getCRLs(CRLSelector sample code for java.security.cert.CRLSelector definition code for java.security.cert.CRLSelector  selector)
                                        throws CertStoreException sample code for java.security.cert.CertStoreException definition code for java.security.cert.CertStoreException 
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 sample code for java.security.cert.CertStoreException definition code for java.security.cert.CertStoreException - if an exception occurs

getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters)

public static CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore  getInstance(String sample code for java.lang.String definition code for java.lang.String  type,
                                    CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params)
                             throws InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException ,
                                    NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException 
Returns a CertStore object that implements the specified CertStore type and is initialized with the specified parameters.

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.

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.

Parameters:
type - the name of the requested CertStore type
params - the initialization parameters (may be null)
Returns:
a CertStore object that implements the specified CertStore type
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested type is not available in the default provider package or any of the other provider packages that were searched
InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException - if the specified initialization parameters are inappropriate for this CertStore

getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.lang.String) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.lang.String)

public static CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore  getInstance(String sample code for java.lang.String definition code for java.lang.String  type,
                                    CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params,
                                    String sample code for java.lang.String definition code for java.lang.String  provider)
                             throws InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException ,
                                    NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException ,
                                    NoSuchProviderException sample code for java.security.NoSuchProviderException definition code for java.security.NoSuchProviderException 
Returns a CertStore object that implements the specified CertStore type, as supplied by the specified provider and initialized with the specified parameters.

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.

Parameters:
type - the requested CertStore type
params - the initialization parameters (may be null)
provider - the name of the provider
Returns:
a CertStore object that implements the specified type, as supplied by the specified provider
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested type is not available from the specified provider
InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException - if the specified initialization parameters are inappropriate for this CertStore
NoSuchProviderException sample code for java.security.NoSuchProviderException definition code for java.security.NoSuchProviderException - if the provider has not been configured
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the provider is null

getInstance sample code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.security.Provider) definition code for java.security.cert.CertStore.getInstance(java.lang.String, java.security.cert.CertStoreParameters, java.security.Provider)

public static CertStore sample code for java.security.cert.CertStore definition code for java.security.cert.CertStore  getInstance(String sample code for java.lang.String definition code for java.lang.String  type,
                                    CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.CertStoreParameters  params,
                                    Provider sample code for java.security.Provider definition code for java.security.Provider  provider)
                             throws NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException ,
                                    InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException 
Returns a CertStore object that implements the specified CertStore type, as supplied by the specified provider and initialized with the specified parameters. Note: the provider doesn't have to be registered.

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.

Parameters:
type - the requested CertStore type
params - the initialization parameters (may be null)
provider - the provider
Returns:
a CertStore object that implements the specified type, as supplied by the specified provider
Throws:
NoSuchAlgorithmException sample code for java.security.NoSuchAlgorithmException definition code for java.security.NoSuchAlgorithmException - if the requested type is not available from the specified provider
InvalidAlgorithmParameterException sample code for java.security.InvalidAlgorithmParameterException definition code for java.security.InvalidAlgorithmParameterException - if the specified initialization parameters are inappropriate for this CertStore
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if the provider is null

getCertStoreParameters sample code for java.security.cert.CertStore.getCertStoreParameters() definition code for java.security.cert.CertStore.getCertStoreParameters()

public final CertStoreParameters sample code for java.security.cert.CertStoreParameters definition code for java.security.cert.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)

getType sample code for java.security.cert.CertStore.getType() definition code for java.security.cert.CertStore.getType()

public final String sample code for java.lang.String definition code for java.lang.String  getType()
Returns the type of this CertStore.

Returns:
the type of this CertStore

getProvider sample code for java.security.cert.CertStore.getProvider() definition code for java.security.cert.CertStore.getProvider()

public final Provider sample code for java.security.Provider definition code for java.security.Provider  getProvider()
Returns the provider of this CertStore.

Returns:
the provider of this CertStore

getDefaultType sample code for java.security.cert.CertStore.getDefaultType() definition code for java.security.cert.CertStore.getDefaultType()

public static final String sample code for java.lang.String definition code for java.lang.String  getDefaultType()
Returns the default CertStore type as specified in the Java security properties file, or the string "LDAP" if no such property exists. The Java security properties file is located in the file named <JAVA_HOME>/lib/security/java.security, where <JAVA_HOME> refers to the directory where the JDK was installed.

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.

Returns:
the default CertStore type as specified in the Java security properties file, or the string "LDAP" if no such property exists.