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

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

build

public final CertPathBuilderResult build(CertPathParameters params)

Builds a certificate path. The {@link 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.

UNKNOWN: The certificate path result.

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)

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)

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)

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.