java.security.cert

Class CertStore

java.lang.Object

java.security.cert.CertStore

public class CertStore
extends java.lang.Object

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

Since:

1.4

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CertStore(CertStoreSpi storeSpi, java.security.Provider provider, java.lang.String type, CertStoreParameters params) Create a new CertStore.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.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.
java.util.Collection<? extends CRL>	getCRLs(CRLSelector selector) Get a collection of certificate revocation lists from this CertStore, optionally filtered by the specified CRLSelector.
static java.lang.String	getDefaultType() Returns the default certificate store type.
static CertStore	getInstance(java.lang.String type, CertStoreParameters params) Returns an instance of the given certificate store type from the first installed provider.
static CertStore	getInstance(java.lang.String type, CertStoreParameters params, java.security.Provider provider) Returns an instance of the given certificate store type from a given provider.
static CertStore	getInstance(java.lang.String type, CertStoreParameters params, java.lang.String provider) Returns an instance of the given certificate store type from a named provider.
java.security.Provider	getProvider() Return the provider of this implementation.
java.lang.String	getType() Return the type of certificate store this instance represents.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CertStore

protected CertStore(CertStoreSpi storeSpi,
         java.security.Provider provider,
         java.lang.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

getDefaultType

public static final java.lang.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(java.lang.String type,
                    CertStoreParameters params)
                             throws java.security.InvalidAlgorithmParameterException,
                                    java.security.NoSuchAlgorithmException

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:

java.security.InvalidAlgorithmParameterException - If the instance rejects the specified parameters.

java.security.NoSuchAlgorithmException - If no installed provider implements the specified CertStore.

java.lang.IllegalArgumentException - if type is null or is an empty string.

getInstance

public static CertStore getInstance(java.lang.String type,
                    CertStoreParameters params,
                    java.lang.String provider)
                             throws java.security.InvalidAlgorithmParameterException,
                                    java.security.NoSuchAlgorithmException,
                                    java.security.NoSuchProviderException

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:

java.security.InvalidAlgorithmParameterException - If the instance rejects the specified parameters.

java.security.NoSuchAlgorithmException - If the specified provider does not implement the specified CertStore.

java.security.NoSuchProviderException - If no provider named provider is installed.

java.lang.IllegalArgumentException - if either type or provider is null, or if type is an empty string.

getInstance

public static CertStore getInstance(java.lang.String type,
                    CertStoreParameters params,
                    java.security.Provider provider)
                             throws java.security.InvalidAlgorithmParameterException,
                                    java.security.NoSuchAlgorithmException

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:

java.security.InvalidAlgorithmParameterException - If the instance rejects the specified parameters.

java.security.NoSuchAlgorithmException - If the specified provider does not implement the specified CertStore.

java.lang.IllegalArgumentException - if either type or provider is null, or if type is an empty string.

getType

public final java.lang.String getType()

Return the type of certificate store this instance represents.

Returns:

The CertStore type.

getProvider

public final java.security.Provider getProvider()

Return the provider of this implementation.

Returns:

The provider.

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.

getCertificates

public final java.util.Collection<? extends Certificate> getCertificates(CertSelector selector)
                                                                  throws CertStoreException

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.

getCRLs

public final java.util.Collection<? extends CRL> getCRLs(CRLSelector selector)
                                                  throws CertStoreException

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.