# CertStore

public class **CertStore** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
A class for retrieving `Certificate`s and `CRL`s
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 `Certificate`s and `CRL`s by calling its
`https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getCertificates(java.security.cert.CertSelector)` and
`https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getCRLs(java.security.cert.CRLSelector)` methods.


Unlike a `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/KeyStore.html`, 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:

| Algorithm | Supported API Levels |
|---|---|
| Collection | 1+ |

This type is described in the [CertStore section](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertStore) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#CertStore(java.security.cert.CertStoreSpi,%20java.security.Provider,%20java.lang.String,%20java.security.cert.CertStoreParameters))([CertStoreSpi](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreSpi.html) storeSpi, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params) Creates a `CertStore` object of the given type, and encapsulates the given provider implementation (SPI object) in it. |

### Public Method Summary

|---|---|
| final [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [CRL](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CRL.html)\> | [getCRLs](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getCRLs(java.security.cert.CRLSelector))([CRLSelector](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CRLSelector.html) selector) Returns a `Collection` of `CRL`s that match the specified selector. |
| final [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) | [getCertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getCertStoreParameters())() Returns the parameters used to initialize this `CertStore`. |
| final [Collection](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/Certificate.html)\> | [getCertificates](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getCertificates(java.security.cert.CertSelector))([CertSelector](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertSelector.html) selector) Returns a `Collection` of `Certificate`s that match the specified selector. |
| final static [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getDefaultType](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getDefaultType())() Returns the default `CertStore` type as specified by the `certstore.type` security property, or the string "LDAP" if no such property exists. |
| static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getInstance(java.lang.String,%20java.security.cert.CertStoreParameters))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params) Returns a `CertStore` object that implements the specified `CertStore` type and is initialized with the specified parameters. |
| static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getInstance(java.lang.String,%20java.security.cert.CertStoreParameters,%20java.security.Provider))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider) Returns a `CertStore` object that implements the specified `CertStore` type. |
| static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html) | [getInstance](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getInstance(java.lang.String,%20java.security.cert.CertStoreParameters,%20java.lang.String))([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) provider) Returns a `CertStore` object that implements the specified `CertStore` type. |
| final [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) | [getProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getProvider())() Returns the provider of this `CertStore`. |
| final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [getType](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html#getType())() Returns the type of this `CertStore`. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Protected Constructors

#### protected
**CertStore**
([CertStoreSpi](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreSpi.html) storeSpi, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) 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](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [CRL](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CRL.html)\>
**getCRLs**
([CRLSelector](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CRLSelector.html) selector)

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


For some `CertStore` types, the resulting
`Collection` may not contain **all** of the
`CRL`s 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 `CRL`s it is looking for.


Some `CertStore` implementations (especially LDAP
`CertStore`s) 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 `CRL`s should be returned. Specify `null` to return all `CRL`s (if supported). |
|---|---|

##### Returns

- A `Collection` of `CRL`s that match the specified selector (never `null`)

##### Throws

| [CertStoreException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreException.html) | if an exception occurs |
|---|---|

#### public final [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html)
**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](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/Collection.html)\<? extends [Certificate](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/Certificate.html)\>
**getCertificates**
([CertSelector](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertSelector.html) selector)

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


For some `CertStore` types, the resulting
`Collection` may not contain **all** of the
`Certificate`s 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 `Certificate`s it is looking for.


Some `CertStore` implementations (especially LDAP
`CertStore`s) 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 `Certificate`s should be returned. Specify `null` to return all `Certificate`s (if supported). |
|---|---|

##### Returns

- A `Collection` of `Certificate`s that match the specified selector (never `null`)

##### Throws

| [CertStoreException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreException.html) | if an exception occurs |
|---|---|

#### public static final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getDefaultType**
()

Returns the default `CertStore` type as specified by the
`certstore.type` security property, or the string
"LDAP" if no such property exists.

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 to the
desired type.

##### Returns

- the default `CertStore` type as specified by the `certstore.type` security property, or the string "LDAP" if no such property exists.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html`

#### public static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params)

Returns a `CertStore` object that implements the specified
`CertStore` type and is initialized with the specified
parameters.

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.

Note that the list of registered providers may be retrieved via
the `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders()` method.

The `CertStore` that is returned is initialized with the
specified `CertStoreParameters`. The type of parameters
needed may vary between different types of `CertStore`s.
Note that the specified `CertStoreParameters` object is
cloned.

##### Parameters

| type | the name of the requested `CertStore` type. See the CertStore section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertStore) for information about standard types. |
| params | the initialization parameters (may be `null`). |
|---|---|

##### Returns

- a `CertStore` object that implements the specified `CertStore` type.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if no Provider supports a CertStoreSpi implementation for the specified type. |
| [InvalidAlgorithmParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidAlgorithmParameterException.html) | if the specified initialization parameters are inappropriate for this `CertStore`. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params, [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html) provider)

Returns a `CertStore` object that implements the specified
`CertStore` type.

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 `CertStore`s.
Note that the specified `CertStoreParameters` object is
cloned.

##### Parameters

| type | the requested `CertStore` type. See the CertStore section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertStore) for information about standard types. |
| params | the initialization parameters (may be `null`). |
| provider | the provider. |
|---|---|

##### Returns

- a `CertStore` object that implements the specified type.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if a CertStoreSpi implementation for the specified type is not available from the specified Provider object. |
| [InvalidAlgorithmParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidAlgorithmParameterException.html) | if the specified initialization parameters are inappropriate for this `CertStore` |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the `provider` is null. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public static [CertStore](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStore.html)
**getInstance**
([String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) type, [CertStoreParameters](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/cert/CertStoreParameters.html) params, [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) provider)

Returns a `CertStore` object that implements the specified
`CertStore` type.

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 `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Security.html#getProviders()` method.

The `CertStore` that is returned is initialized with the
specified `CertStoreParameters`. The type of parameters
needed may vary between different types of `CertStore`s.
Note that the specified `CertStoreParameters` object is
cloned.

##### Parameters

| type | the requested `CertStore` type. See the CertStore section in the [Java Cryptography Architecture Standard Algorithm Name Documentation](https://developers.google.com/j2objc/javadoc/jre/technotes/guides/security/StandardNames.html#CertStore) for information about standard types. |
| params | the initialization parameters (may be `null`). |
| provider | the name of the provider. |
|---|---|

##### Returns

- a `CertStore` object that implements the specified type.

##### Throws

| [NoSuchAlgorithmException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchAlgorithmException.html) | if a CertStoreSpi implementation for the specified type is not available from the specified provider. |
| [InvalidAlgorithmParameterException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/InvalidAlgorithmParameterException.html) | if the specified initialization parameters are inappropriate for this `CertStore`. |
| [NoSuchProviderException](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/NoSuchProviderException.html) | if the specified provider is not registered in the security provider list. |
| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | if the `provider` is null or empty. |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html`

#### public final [Provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/security/Provider.html)
**getProvider**
()

Returns the provider of this `CertStore`.

##### Returns

- the provider of this `CertStore`

#### public final [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html)
**getType**
()

Returns the type of this `CertStore`.

##### Returns

- the type of this `CertStore`