java.security.cert
Class CertPathBuilder

java.lang.Object
  java.security.cert.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

protected

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) Get an instance of a named CertPathBuilder, from the first provider that implements it.
static CertPathBuilder	getInstance(String algorithm, Provider provider) Get an instance of a named CertPathBuilder from the specified provider.
static CertPathBuilder	getInstance(String algorithm, String provider) Get an instance of a named CertPathBuilder from the named provider.
Provider	getProvider() Return the provider of this instance's implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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

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

getInstance

public static CertPathBuilder getInstance(String algorithm,
                                          String provider)
                                   throws NoSuchAlgorithmException,
                                          NoSuchProviderException

Get an instance of a named CertPathBuilder from the named provider.

Parameters:

algorithm - The name of the CertPathBuilder to create.

provider - The name of the provider from which to get the implementation.

Returns:

The new instance.

Throws:

NoSuchAlgorithmException - If no installed provider implements the named algorithm.

NoSuchProviderException - If the named provider does not exist.

getInstance

public static CertPathBuilder getInstance(String algorithm,
                                          Provider provider)
                                   throws NoSuchAlgorithmException

Get an instance of a named CertPathBuilder from the specified provider.

Parameters:

algorithm - The name of the CertPathBuilder to create.

provider - The provider from which to get the implementation.

Returns:

The new instance.

Throws:

NoSuchAlgorithmException - If no installed provider implements the named algorithm.

IllegalArgumentException - If provider in null.

getAlgorithm

public final String getAlgorithm()

Return the name of this CertPathBuilder algorithm.

Returns:

The algorithm name.

getProvider

public final Provider getProvider()

Return the provider of this instance's implementation.

Returns:

The provider.

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.

Returns:

The certificate path result.

Throws:

CertPathBuilderException - If the certificate path cannot be built.

InvalidAlgorithmParameterException - If the implementation rejects the specified parameters.