OpenJDK 1.23 · java.security.cert.CertPathBuilder · APIdia, the JavaDoc alternative

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.

Modifier and Type	Field and Description
private final String	algorithm
private final CertPathBuilderSpi	builderSpi
private static final String	CPB_TYPE
private final Provider	provider

Access	Constructor and Description
protected	CertPathBuilder(CertPathBuilderSpi the provider implementation builderSpi, Provider the provider provider, String the algorithm name algorithm) Creates a `CertPathBuilder` object of the given algorithm, and encapsulates the given provider implementation (SPI object) in it.

Method Summary

Modifier and Type	Method and Description
public final CertPathBuilderResult	Returns: the result of the build algorithm build(CertPathParameters the algorithm parameters params) Attempts to build a certification path using the specified algorithm parameter set.
public final String	Returns: the name of the algorithm of this `CertPathBuilder` getAlgorithm() Returns the name of the algorithm of this `CertPathBuilder`.
public static final String	Returns: the default `CertPathBuilder` type as specified by the `certpathbuilder.type` security property, or the string "PKIX" if no such property exists. getDefaultType() 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	Returns: a `CertPathBuilder` object that implements the specified algorithm getInstance(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. algorithm) Returns a `CertPathBuilder` object that implements the specified algorithm.
public static CertPathBuilder	Returns: a `CertPathBuilder` object that implements the specified algorithm getInstance(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. algorithm, String the name of the provider. provider) Returns a `CertPathBuilder` object that implements the specified algorithm.
public static CertPathBuilder	Returns: a `CertPathBuilder` object that implements the specified algorithm getInstance(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. algorithm, Provider the provider. provider) Returns a `CertPathBuilder` object that implements the specified algorithm.
public final Provider	Returns: the provider of this `CertPathBuilder` getProvider() Returns the provider of this `CertPathBuilder`.
public final CertPathChecker	Returns: a `CertPathChecker` getRevocationChecker() Returns a `CertPathChecker` that the encapsulated `CertPathBuilderSpi` implementation uses to check the revocation status of certificates.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

algorithm	back to summary
private final String algorithm

builderSpi	back to summary
private final CertPathBuilderSpi builderSpi

CPB_TYPE	back to summary
private static final String CPB_TYPE

provider	back to summary
private final Provider provider

Constructor Detail

CertPathBuilder back to summary

CertPathBuilder	back to summary
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:CertPathBuilderSpi the provider implementation provider:Provider the provider algorithm:String the algorithm name

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:CertPathBuilderSpi: the provider implementation
provider:Provider: the provider
algorithm:String: the algorithm name

Method Detail

build back to summary

build	back to summary
public final CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException 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 Exceptions 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 CertPathBuilderResult build(CertPathParameters params) throws CertPathBuilderException, InvalidAlgorithmParameterException

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

Exceptions

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 back to summary

getAlgorithm	back to summary
public final String getAlgorithm() Returns the name of the algorithm of this `CertPathBuilder`. Returns:String the name of the algorithm of this `CertPathBuilder`

public final String getAlgorithm()

Returns the name of the algorithm of this CertPathBuilder.

Returns:String: the name of the algorithm of this CertPathBuilder

getDefaultType back to summary

getDefaultType	back to summary
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:String the default `CertPathBuilder` type as specified by the `certpathbuilder.type` security property, or the string "PKIX" if no such property exists. See Also `security properties`

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:String: the default CertPathBuilder type as specified by the certpathbuilder.type security property, or the string "PKIX" if no such property exists.
See Also: security properties

getInstance back to summary

getInstance	back to summary
public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException 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. Implementation Note The JDK Reference Implementation additionally uses the `jdk.security.provider.preferred` `Security` property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned by `Security.getProviders()`. 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. Returns:CertPathBuilder a `CertPathBuilder` object that implements the specified algorithm Exceptions NoSuchAlgorithmException: if no `Provider` supports a `CertPathBuilderSpi` implementation for the specified algorithm NullPointerException: if `algorithm` is `null` See Also `java.security.Provider`

public static CertPathBuilder getInstance(String algorithm) throws NoSuchAlgorithmException

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.

Implementation Note

The JDK Reference Implementation additionally uses the jdk.security.provider.preferred Security property to determine the preferred provider order for the specified algorithm. This may be different from the order of providers returned by Security.getProviders().

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.

Returns:CertPathBuilder

a CertPathBuilder object that implements the specified algorithm

Exceptions

NoSuchAlgorithmException:: if no Provider supports a CertPathBuilderSpi implementation for the specified algorithm
NullPointerException:: if algorithm is null

See Also

java.security.Provider

getInstance back to summary

getInstance	back to summary
public static CertPathBuilder getInstance(String algorithm, String provider) throws NoSuchAlgorithmException, NoSuchProviderException 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. Returns:CertPathBuilder a `CertPathBuilder` object that implements the specified algorithm Exceptions 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 NullPointerException: if `algorithm` is `null` See Also `java.security.Provider`

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

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.

Returns:CertPathBuilder

a CertPathBuilder object that implements the specified algorithm

Exceptions

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
NullPointerException:: if algorithm is null

See Also

java.security.Provider

getInstance back to summary

getInstance	back to summary
public static CertPathBuilder getInstance(String algorithm, Provider provider) throws NoSuchAlgorithmException 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. Returns:CertPathBuilder a `CertPathBuilder` object that implements the specified algorithm Exceptions NoSuchAlgorithmException: if a `CertPathBuilderSpi` implementation for the specified algorithm is not available from the specified `Provider` object IllegalArgumentException: if the `provider` is `null` NullPointerException: if `algorithm` is `null` See Also `java.security.Provider`

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

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.

Returns:CertPathBuilder

a CertPathBuilder object that implements the specified algorithm

Exceptions

NoSuchAlgorithmException:: if a CertPathBuilderSpi implementation for the specified algorithm is not available from the specified Provider object
IllegalArgumentException:: if the provider is null
NullPointerException:: if algorithm is null

See Also

java.security.Provider

getProvider back to summary

getProvider	back to summary
public final Provider getProvider() Returns the provider of this `CertPathBuilder`. Returns:Provider the provider of this `CertPathBuilder`

public final Provider getProvider()

Returns the provider of this CertPathBuilder.

Returns:Provider: the provider of this CertPathBuilder

getRevocationChecker back to summary

getRevocationChecker	back to summary
public final 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` Exceptions UnsupportedOperationException: if the service provider does not support this method Since 1.8

public final 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

Exceptions

UnsupportedOperationException:: if the service provider does not support this method

Since

1.8

public Class CertPathBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail