APIdia Launch Partner
Top Description Fields Constructors Methods
java.security.cert

public Class CertStore

extends Object
Class Inheritance
Known Direct Subclasses
sun.security.provider.certpath.URICertStore.UCS, sun.security.provider.certpath.ssl.SSLServerCertStore.CS
Imports
java.security.InvalidAlgorithmParameterException, .NoSuchAlgorithmException, .NoSuchProviderException, .Provider, .Security, java.util.Collection, .Objects, sun.security.jca.*, .GetInstance.Instance

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.

Every implementation of the Java platform is required to support the following standard CertStore type:

This type is described in the CertStore section of the Java Security Standard Algorithm Names Specification. Consult the release documentation for your implementation to see if any other types are supported.

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.

Author
Sean Mullan, Steve Hanna
Since
1.4
External Specification
Java Security Standard Algorithm Names

Field Summary

Modifier and TypeField and Description
private static final String
private CertStoreParameters
private final Provider
private final CertStoreSpi
private final String

Constructor Summary

AccessConstructor and Description
protected
CertStore(CertStoreSpi
the provider implementation
storeSpi
,
Provider
the provider
provider
,
String
the type
type
,
CertStoreParameters
the initialization parameters (may be null)
params
)

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

Method Summary

Modifier and TypeMethod and Description
public final Collection<? extends Certificate>

Returns:

A Collection of Certificates that match the specified selector (never null)
getCertificates
(CertSelector
A CertSelector used to select which Certificates should be returned. Specify null to return all Certificates (if supported).
selector
)

Returns a Collection of Certificates that match the specified selector.

public final CertStoreParameters

Returns:

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

Returns the parameters used to initialize this CertStore.

public final Collection<? extends CRL>

Returns:

A Collection of CRLs that match the specified selector (never null)
getCRLs
(CRLSelector
A CRLSelector used to select which CRLs should be returned. Specify null to return all CRLs (if supported).
selector
)

Returns a Collection of CRLs that match the specified selector.

public static final String

Returns:

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

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

public static CertStore

Returns:

a CertStore object that implements the specified CertStore type
getInstance
(String
the name of the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.
type
,
CertStoreParameters
the initialization parameters (may be null).
params
)

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

public static CertStore

Returns:

a CertStore object that implements the specified type
getInstance
(String
the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.
type
,
CertStoreParameters
the initialization parameters (may be null).
params
,
String
the name of the provider.
provider
)

Returns a CertStore object that implements the specified CertStore type.

public static CertStore

Returns:

a CertStore object that implements the specified type
getInstance
(String
the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.
type
,
CertStoreParameters
the initialization parameters (may be null).
params
,
Provider
the provider.
provider
)

Returns a CertStore object that implements the specified CertStore type.

public final Provider

Returns:

the provider of this CertStore
getProvider
()

Returns the provider of this CertStore.

public final String

Returns:

the type of this CertStore
getType
()

Returns the type of this CertStore.

private static CertStore
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CERTSTORE_TYPEback to summary
private static final String CERTSTORE_TYPE
paramsback to summary
private CertStoreParameters params
providerback to summary
private final Provider provider
storeSpiback to summary
private final CertStoreSpi storeSpi
typeback to summary
private final String type

Constructor Detail

CertStoreback to 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.

Parameters
storeSpi:CertStoreSpi

the provider implementation

provider:Provider

the provider

type:String

the type

params:CertStoreParameters

the initialization parameters (may be null)

Method Detail

getCertificatesback to summary
public final Collection<? extends Certificate> getCertificates(CertSelector selector) throws 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:CertSelector

A CertSelector used to select which Certificates should be returned. Specify null to return all Certificates (if supported).

Returns:Collection<? extends Certificate>

A Collection of Certificates that match the specified selector (never null)

Exceptions
CertStoreException:
if an exception occurs
getCertStoreParametersback to summary
public final CertStoreParameters getCertStoreParameters()

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

Returns:CertStoreParameters

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

getCRLsback to summary
public final Collection<? extends CRL> getCRLs(CRLSelector selector) throws 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:CRLSelector

A CRLSelector used to select which CRLs should be returned. Specify null to return all CRLs (if supported).

Returns:Collection<? extends CRL>

A Collection of CRLs that match the specified selector (never null)

Exceptions
CertStoreException:
if an exception occurs
getDefaultTypeback to summary
public static final String 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:String

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

See Also
security properties
getInstanceback to summary
public static CertStore getInstance(String type, CertStoreParameters params) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException

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 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.

Implementation Note

The JDK Reference Implementation additionally uses the jdk.security.provider.preferred Security property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned by Security.getProviders().

Parameters
type:String

the name of the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.

params:CertStoreParameters

the initialization parameters (may be null).

Returns:CertStore

a CertStore object that implements the specified CertStore type

Exceptions
InvalidAlgorithmParameterException:
if the specified initialization parameters are inappropriate for this CertStore
NoSuchAlgorithmException:
if no Provider supports a CertStoreSpi implementation for the specified type
NullPointerException:
if type is null
External Specification
Java Security Standard Algorithm Names
See Also
java.security.Provider
getInstanceback to summary
public static CertStore getInstance(String type, CertStoreParameters params, String provider) throws InvalidAlgorithmParameterException, NoSuchAlgorithmException, NoSuchProviderException

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 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.

Parameters
type:String

the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.

params:CertStoreParameters

the initialization parameters (may be null).

provider:String

the name of the provider.

Returns:CertStore

a CertStore object that implements the specified type

Exceptions
InvalidAlgorithmParameterException:
if the specified initialization parameters are inappropriate for this CertStore
NoSuchAlgorithmException:
if a CertStoreSpi implementation for the specified type is not available from the specified provider
NoSuchProviderException:
if the specified provider is not registered in the security provider list
IllegalArgumentException:
if the provider is null or empty
NullPointerException:
if type is null
External Specification
Java Security Standard Algorithm Names
See Also
java.security.Provider
getInstanceback to summary
public static CertStore getInstance(String type, CertStoreParameters params, Provider provider) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException

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

Parameters
type:String

the requested CertStore type. See the CertStore section in the Java Security Standard Algorithm Names Specification for information about standard types.

params:CertStoreParameters

the initialization parameters (may be null).

provider:Provider

the provider.

Returns:CertStore

a CertStore object that implements the specified type

Exceptions
NoSuchAlgorithmException:
if a CertStoreSpi implementation for the specified type is not available from the specified Provider object
InvalidAlgorithmParameterException:
if the specified initialization parameters are inappropriate for this CertStore
IllegalArgumentException:
if the provider is null
NullPointerException:
if type is null
External Specification
Java Security Standard Algorithm Names
See Also
java.security.Provider
getProviderback to summary
public final Provider getProvider()

Returns the provider of this CertStore.

Returns:Provider

the provider of this CertStore

getTypeback to summary
public final String getType()

Returns the type of this CertStore.

Returns:String

the type of this CertStore

handleExceptionback to summary
private static CertStore handleException(NoSuchAlgorithmException e) throws NoSuchAlgorithmException, InvalidAlgorithmParameterException