Added in API level 1

CertPathBuilder

open class CertPathBuilder
kotlin.Any
   ↳ 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);

Every implementation of the Java platform is required to support the following standard CertPathBuilder algorithm:

  • PKIX
This algorithm is described in the CertPathBuilder section of the Java Security Standard Algorithm Names Specification. Consult the release documentation for your implementation to see if any other algorithms are supported.

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.

Summary

Protected constructors
CertPathBuilder(builderSpi: CertPathBuilderSpi!, provider: Provider!, algorithm: String!)

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

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

Returns the name of the algorithm of this CertPathBuilder.
static String!

Returns the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.
open static CertPathBuilder!
getInstance(algorithm: String!)

Returns a CertPathBuilder object that implements the specified algorithm.
open static CertPathBuilder!
getInstance(algorithm: String!, provider: String!)

Returns a CertPathBuilder object that implements the specified algorithm.
open static CertPathBuilder!
getInstance(algorithm: String!, provider: Provider!)

Returns a CertPathBuilder object that implements the specified algorithm.
Provider!

Returns the provider of this CertPathBuilder.
CertPathChecker!

Returns a CertPathChecker that the encapsulated CertPathBuilderSpi implementation uses to check the revocation status of certificates.

Protected constructors

CertPathBuilder

Added in API level 1
protected CertPathBuilder(
    builderSpi: CertPathBuilderSpi!, 
    provider: Provider!, 
    algorithm: String!)

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
fun build(params: CertPathParameters!): CertPathBuilderResult!

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

Parameters
params CertPathParameters!: the algorithm parameters
Return
CertPathBuilderResult! the result of the build algorithm
Exceptions
java.security.cert.CertPathBuilderException if the builder is unable to construct a certification path that satisfies the specified parameters
java.security.InvalidAlgorithmParameterException if the specified parameters are inappropriate for this CertPathBuilder

getAlgorithm

Added in API level 1
fun getAlgorithm(): String!

Returns the name of the algorithm of this CertPathBuilder.

Return
String! the name of the algorithm of this CertPathBuilder

getDefaultType

Added in API level 1
static fun getDefaultType(): String!

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.

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

getInstance

Added in API level 1
open static fun getInstance(algorithm: String!): CertPathBuilder!

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 Security Standard Algorithm Names Specification for information about standard algorithm names.
Return
CertPathBuilder! a CertPathBuilder object that implements the specified algorithm
Exceptions
java.security.NoSuchAlgorithmException if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm
java.lang.NullPointerException if algorithm is null

getInstance

Added in API level 1
open static fun getInstance(
    algorithm: String!, 
    provider: String!
): CertPathBuilder!

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 Security Standard Algorithm Names Specification for information about standard algorithm names.
provider String!: the name of the provider.
Return
CertPathBuilder! a CertPathBuilder object that implements the specified algorithm
Exceptions
java.lang.IllegalArgumentException if the provider is null or empty
java.security.NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified provider
java.security.NoSuchProviderException if the specified provider is not registered in the security provider list
java.lang.NullPointerException if algorithm is null

getInstance

Added in API level 1
open static fun getInstance(
    algorithm: String!, 
    provider: Provider!
): CertPathBuilder!

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 Security Standard Algorithm Names Specification for information about standard algorithm names.
provider Provider!: the provider.
Return
CertPathBuilder! a CertPathBuilder object that implements the specified algorithm
Exceptions
java.lang.IllegalArgumentException if the provider is null
java.security.NoSuchAlgorithmException if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object
java.lang.NullPointerException if algorithm is null

getProvider

Added in API level 1
fun getProvider(): Provider!

Returns the provider of this CertPathBuilder.

Return
Provider! the provider of this CertPathBuilder

getRevocationChecker

Added in API level 24
fun getRevocationChecker(): CertPathChecker!

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.

Return
CertPathChecker! a CertPathChecker
Exceptions
java.lang.UnsupportedOperationException if the service provider does not support this method