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

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

Method Summary

Collection
extends CRL> getCRLs(CRLSelector selector)
Get a collection of certificate revocation lists from this CertStore, optionally filtered by the specified CRLSelector.
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.
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.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

extends CRL> getCRLs

public final Collectionextends 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.

extends Certificate> getCertificates

public final Collectionextends 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.

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.

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)
            throws InvalidAlgorithmParameterException,
                   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:
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)
            throws InvalidAlgorithmParameterException,
                   NoSuchAlgorithmException,
                   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:
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)
            throws InvalidAlgorithmParameterException,
                   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:
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.

CertStore -- stores and retrieves certificates. Copyright (C) 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.