Skip to content

Most visited

Recently visited

navigation

CertPathBuilder

public class CertPathBuilder
extends Object

java.lang.Object
   ↳ java.security.cert.CertPathBuilder


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:

Summary

Protected constructors

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 methods

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.

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.

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 methods

From class java.lang.Object

Protected constructors

CertPathBuilder

Added in API level 1
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 CertPathBuilderSpi: the provider implementation
provider Provider: the provider
algorithm String: the algorithm name

Public methods

build

Added in API level 1
CertPathBuilderResult build (CertPathParameters params)

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

Parameters
params CertPathParameters: the algorithm parameters
Returns
CertPathBuilderResult 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

getAlgorithm

Added in API level 1
String getAlgorithm ()

Returns the name of the algorithm of this CertPathBuilder.

Returns
String the name of the algorithm of this CertPathBuilder

getDefaultType

Added in API level 1
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
String the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.

See also:

getInstance

Added in API level 1
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 String: 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
CertPathBuilder a CertPathBuilder object that implements the specified algorithm.
Throws
NoSuchAlgorithmException if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm.

See also:

getInstance

Added in API level 1
CertPathBuilder getInstance (String algorithm, 
                String provider)

Returns a CertPathBuilder object that implements the specified algorithm.

A new CertPathBuilder object encapsulating the CertPathBuilderSpi implementation from the specified provider is returned. The specified provider must be registered in the security provider list.

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

Parameters
algorithm String: 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.
provider String: the name of the provider.
Returns
CertPathBuilder a CertPathBuilder object that implements the specified algorithm.
Throws
NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified provider.
NoSuchProviderException if the specified provider is not registered in the security provider list.
IllegalArgumentException if the provider is null or empty.

See also:

getInstance

Added in API level 1
CertPathBuilder getInstance (String algorithm, 
                Provider provider)

Returns a CertPathBuilder object that implements the specified algorithm.

A new CertPathBuilder object encapsulating the CertPathBuilderSpi implementation from the specified Provider object is returned. Note that the specified Provider object does not have to be registered in the provider list.

Parameters
algorithm String: 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.
provider Provider: the provider.
Returns
CertPathBuilder a CertPathBuilder object that implements the specified algorithm.
Throws
NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object.
IllegalArgumentException if the provider is null.

See also:

getProvider

Added in API level 1
Provider getProvider ()

Returns the provider of this CertPathBuilder.

Returns
Provider the provider of this CertPathBuilder

getRevocationChecker

Added in API level 24
CertPathChecker getRevocationChecker ()

Returns a CertPathChecker that the encapsulated CertPathBuilderSpi implementation uses to check the revocation status of certificates. A PKIX implementation returns objects of type PKIXRevocationChecker. Each invocation of this method returns a new instance of CertPathChecker.

The primary purpose of this method is to allow callers to specify additional input parameters and options specific to revocation checking. See the class description for an example.

Returns
CertPathChecker a CertPathChecker
Throws
UnsupportedOperationException if the service provider does not support this method
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.