java.security.cert

Class CertStore

public class CertStore extends Object

A CertStore is a read-only repository for certificates and certificate revocation lists.

Since: 1.4

Constructor Summary
protected	CertStore(CertStoreSpi storeSpi, Provider provider, String type, CertStoreParameters params) Create a new CertStore.

Method Summary
Collection<? extends Certificate>	getCertificates(CertSelector selector) Get a collection of certificates from this CertStore, optionally filtered by the specified CertSelector.
CertStoreParameters	getCertStoreParameters() Get the parameters this instance was created with, if any.
Collection<? extends CRL>	getCRLs(CRLSelector selector) Get a collection of certificate revocation lists from this CertStore, optionally filtered by the specified CRLSelector.
static String	getDefaultType() Returns the default certificate store type.
static CertStore	getInstance(String type, CertStoreParameters params) Returns an instance of the given certificate store type from the first installed provider.
static CertStore	getInstance(String type, CertStoreParameters params, String provider) Returns an instance of the given certificate store type from a named provider.
static CertStore	getInstance(String type, CertStoreParameters params, Provider provider) Returns an instance of the given certificate store type from a given provider.
Provider	getProvider() Return the provider of this implementation.
String	getType() Return the type of certificate store this instance represents.

Constructor Detail

CertStore

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

Create a new CertStore.

Parameters: storeSpi The underlying implementation. provider The provider of this implementation. type The type of CertStore this class represents. params The parameters used to initialize this instance, if any.

Method Detail

getCertificates

public final Collection<? extends Certificate> getCertificates(CertSelector selector)

Get a collection of certificates from this CertStore, optionally filtered by the specified CertSelector. The Collection returned may be empty, but will never be null.

Implementations may not allow a null argument, even if no filtering is desired.

Parameters: selector The certificate selector.

Returns: The collection of certificates.

Throws: CertStoreException If the certificates cannot be retrieved.

getCertStoreParameters

public final CertStoreParameters getCertStoreParameters()

Get the parameters this instance was created with, if any. The parameters will be cloned before they are returned.

Returns: The parameters, or null.

getCRLs

public final Collection<? extends CRL> getCRLs(CRLSelector selector)

Get a collection of certificate revocation lists from this CertStore, optionally filtered by the specified CRLSelector. The Collection returned may be empty, but will never be null.

Implementations may not allow a null argument, even if no filtering is desired.

Parameters: selector The certificate selector.

Returns: The collection of certificate revocation lists.

Throws: CertStoreException If the CRLs cannot be retrieved.

getDefaultType

public static final String getDefaultType()

Returns the default certificate store type.

This value can be set at run-time via the security property "certstore.type"; if not specified than the default type will be "LDAP".

Returns: The default CertStore type.

getInstance

public static CertStore getInstance(String type, CertStoreParameters params)

Returns an instance of the given certificate store type from the first installed provider.

Parameters: type The type of CertStore to create. params The parameters to initialize this cert store with.

Returns: The new instance.

Throws: InvalidAlgorithmParameterException If the instance rejects the specified parameters. NoSuchAlgorithmException If no installed provider implements the specified CertStore. IllegalArgumentException if type is null or is an empty string.

getInstance

public static CertStore getInstance(String type, CertStoreParameters params, String provider)

Returns an instance of the given certificate store type from a named provider.

Parameters: type The type of CertStore to create. params The parameters to initialize this cert store with. provider The name of the provider to use.

Returns: The new instance.

Throws: InvalidAlgorithmParameterException If the instance rejects the specified parameters. NoSuchAlgorithmException If the specified provider does not implement the specified CertStore. NoSuchProviderException If no provider named provider is installed. IllegalArgumentException if either type or provider is null, or if type is an empty string.

getInstance

public static CertStore getInstance(String type, CertStoreParameters params, Provider provider)

Returns an instance of the given certificate store type from a given provider.

Parameters: type The type of CertStore to create. params The parameters to initialize this cert store with. provider The provider to use.

Returns: The new instance.

Throws: InvalidAlgorithmParameterException If the instance rejects the specified parameters. NoSuchAlgorithmException If the specified provider does not implement the specified CertStore. IllegalArgumentException if either type or provider is null, or if type is an empty string.

getProvider

public final Provider getProvider()

Return the provider of this implementation.

Returns: The provider.

getType

public final String getType()

Return the type of certificate store this instance represents.

Returns: The CertStore type.