CertPathBuilder

public class CertPathBuilder extends Object

A class for building certification paths (also known as certificate chains).

This class uses a provider-based architecture. To create a CertPathBuilder, call one of the static getInstance methods, passing in the algorithm name of the CertPathBuilder desired and optionally the name of the provider desired.

Once a CertPathBuilder object has been created, certification paths can be constructed by calling the build method and passing it an algorithm-specific set of parameters. If successful, the result (including the CertPath that was built) is returned in an object that implements the CertPathBuilderResult interface.

The getRevocationChecker() method allows an application to specify additional algorithm-specific parameters and options used by the CertPathBuilder when checking the revocation status of certificates. Here is an example demonstrating how it is used with the PKIX algorithm:

 CertPathBuilder cpb = CertPathBuilder.getInstance("PKIX");
 PKIXRevocationChecker rc = (PKIXRevocationChecker)cpb.getRevocationChecker();
 rc.setOptions(EnumSet.of(Option.PREFER_CRLS));
 params.addCertPathChecker(rc);
 CertPathBuilderResult cpbr = cpb.build(params);
 

Android provides the following CertPathBuilder algorithms:

Name Supported (API Levels)
PKIX 1+
This algorithm is described in the CertPathBuilder section of the Java Cryptography Architecture Standard Algorithm Name Documentation.

Concurrent Access

The static methods of this class are guaranteed to be thread-safe. Multiple threads may concurrently invoke the static methods defined in this class with no ill effects.

However, this is not true for the non-static methods defined by this class. Unless otherwise documented by a specific provider, threads that need to access a single CertPathBuilder instance concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating a different CertPathBuilder instance need not synchronize.

See Also

Protected Constructor Summary

CertPathBuilder(CertPathBuilderSpi builderSpi, Provider provider, String algorithm)
Creates a CertPathBuilder object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.

Public Method Summary

final CertPathBuilderResult
build(CertPathParameters params)
Attempts to build a certification path using the specified algorithm parameter set.
final String
getAlgorithm()
Returns the name of the algorithm of this CertPathBuilder.
final static String
getDefaultType()
Returns the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.
static CertPathBuilder
getInstance(String algorithm)
Returns a CertPathBuilder object that implements the specified algorithm.
static CertPathBuilder
getInstance(String algorithm, String provider)
Returns a CertPathBuilder object that implements the specified algorithm.
static CertPathBuilder
getInstance(String algorithm, Provider provider)
Returns a CertPathBuilder object that implements the specified algorithm.
final Provider
getProvider()
Returns the provider of this CertPathBuilder.
final CertPathChecker
getRevocationChecker()
Returns a CertPathChecker that the encapsulated CertPathBuilderSpi implementation uses to check the revocation status of certificates.

Inherited Method Summary

Protected Constructors

protected CertPathBuilder (CertPathBuilderSpi builderSpi, Provider provider, String algorithm)

Creates a CertPathBuilder object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.

Parameters
builderSpi the provider implementation
provider the provider
algorithm the algorithm name

Public Methods

public final CertPathBuilderResult build (CertPathParameters params)

Attempts to build a certification path using the specified algorithm parameter set.

Parameters
params the algorithm parameters
Returns
  • the result of the build algorithm
Throws
CertPathBuilderException if the builder is unable to construct a certification path that satisfies the specified parameters
InvalidAlgorithmParameterException if the specified parameters are inappropriate for this CertPathBuilder

public final String getAlgorithm ()

Returns the name of the algorithm of this CertPathBuilder.

Returns
  • the name of the algorithm of this CertPathBuilder

public static final String getDefaultType ()

Returns the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.

The default CertPathBuilder type can be used by applications that do not want to use a hard-coded type when calling one of the getInstance methods, and want to provide a default type in case a user does not specify its own.

The default CertPathBuilder type can be changed by setting the value of the certpathbuilder.type security property to the desired type.

Returns
  • the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.

public static CertPathBuilder getInstance (String algorithm)

Returns a CertPathBuilder object that implements the specified algorithm.

This method traverses the list of registered security Providers, starting with the most preferred Provider. A new CertPathBuilder object encapsulating the CertPathBuilderSpi implementation from the first Provider that supports the specified algorithm is returned.

Note that the list of registered providers may be retrieved via the Security.getProviders() method.

Parameters
algorithm the name of the requested CertPathBuilder algorithm. See the CertPathBuilder section in the Java Cryptography Architecture Standard Algorithm Name Documentation for information about standard algorithm names.
Returns
  • a CertPathBuilder object that implements the specified algorithm.
Throws
NoSuchAlgorithmException if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm.
See Also