java.security.cert

Class CertPathBuilder


public class CertPathBuilder
extends Object

This class builds certificate paths (also called certificate chains), which can be used to establish trust for a particular certificate by building a path from a trusted certificate (a trust anchor) to the untrusted certificate.
See Also:
CertPath

Constructor Summary

CertPathBuilder(CertPathBuilderSpi cpbSpi, Provider provider, String algorithm)
Creates a new CertPathBuilder.

Method Summary

CertPathBuilderResult
build(CertPathParameters params)
Builds a certificate path.
String
getAlgorithm()
Return the name of this CertPathBuilder algorithm.
static String
getDefaultType()
Get the default cert path builder type.
static CertPathBuilder
getInstance(String algorithm)
Returns an instance of a named CertPathBuilder from the first provider that implements it.
static CertPathBuilder
getInstance(String algorithm, String provider)
Returns an instance of a named CertPathBuilder from a named provider.
static CertPathBuilder
getInstance(String algorithm, Provider provider)
Returns an instance of a named CertPathBuilder from the specified provider.
Provider
getProvider()
Return the provider of this instance's implementation.

Methods inherited from class java.lang.Object

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

Constructor Details

CertPathBuilder

protected CertPathBuilder(CertPathBuilderSpi cpbSpi,
                          Provider provider,
                          String algorithm)
Creates a new CertPathBuilder.
Parameters:
cpbSpi - The underlying implementation.
provider - The provider of the implementation.
algorithm - This implementation's name.

Method Details

build

public final CertPathBuilderResult build(CertPathParameters params)
            throws CertPathBuilderException,
                   InvalidAlgorithmParameterException
Builds a certificate path. The CertPathParameters parameter passed to this method is implementation-specific, but in general should contain some number of certificates and some number of trusted certificates (or "trust anchors").
Parameters:
params - The parameters.
Throws:
CertPathBuilderException - If the certificate path cannot be built.
InvalidAlgorithmParameterException - If the implementation rejects the specified parameters.

getAlgorithm

public final String getAlgorithm()
Return the name of this CertPathBuilder algorithm.
Returns:
The algorithm name.

getDefaultType

public static final String getDefaultType()
Get the default cert path builder type.

This value can be set at run-time by the security property "certpathbuilder.type". If this property is not set, then the value returned is "PKIX".

Returns:
The default CertPathBuilder algorithm.

getInstance

public static CertPathBuilder getInstance(String algorithm)
            throws NoSuchAlgorithmException
Returns an instance of a named CertPathBuilder from the first provider that implements it.
Parameters:
algorithm - The name of the CertPathBuilder to create.
Returns:
The new instance.
Throws:
NoSuchAlgorithmException - If no installed provider implements the named algorithm.
IllegalArgumentException - if algorithm is null or is an empty string.

getInstance

public static CertPathBuilder getInstance(String algorithm,
                                          String provider)
            throws NoSuchAlgorithmException,
                   NoSuchProviderException
Returns an instance of a named CertPathBuilder from a named provider.
Parameters:
algorithm - The name of the CertPathBuilder to create.
provider - The name of the provider to use.
Returns:
The new instance.
Throws:
NoSuchAlgorithmException - If no installed provider implements the named algorithm.
NoSuchProviderException - If the named provider does not exist.
IllegalArgumentException - if either algorithm or provider is null, or if algorithm is an empty string.

getInstance

public static CertPathBuilder getInstance(String algorithm,
                                          Provider provider)
            throws NoSuchAlgorithmException
Returns an instance of a named CertPathBuilder from the specified provider.
Parameters:
algorithm - The name of the CertPathBuilder to create.
provider - The provider to use.
Returns:
The new instance.
Throws:
NoSuchAlgorithmException - If no installed provider implements the named algorithm.
IllegalArgumentException - if either algorithm or provider is null, or if algorithm is an empty string.

getProvider

public final Provider getProvider()
Return the provider of this instance's implementation.
Returns:
The provider.

CertPathBuilder.java -- bulids CertPath objects from 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.