Stay organized with collections
Save and categorize content based on your preferences.
CertPathBuilderSpi
abstract class CertPathBuilderSpi
The Service Provider Interface (SPI) for the CertPathBuilder class. All CertPathBuilder implementations must include a class (the SPI class) that extends this class (CertPathBuilderSpi) and implements all of its methods. In general, instances of this class should only be accessed through the CertPathBuilder class. For details, see the Java Cryptography Architecture.
Concurrent Access
Instances of this class need not be protected against concurrent access from multiple threads. Threads that need to access a single CertPathBuilderSpi instance concurrently should synchronize amongst themselves and provide the necessary locking before calling the wrapping CertPathBuilder object.
However, implementations of CertPathBuilderSpi may still encounter concurrency issues, since multiple threads each manipulating a different CertPathBuilderSpi instance need not synchronize.
Summary
| Public constructors |
|
The default constructor.
|
| Public methods |
| abstract CertPathBuilderResult! |
Attempts to build a certification path using the specified algorithm parameter set.
|
| open CertPathChecker! |
Returns a CertPathChecker that this implementation uses to check the revocation status of certificates.
|
Public constructors
CertPathBuilderSpi
CertPathBuilderSpi()
The default constructor.
Public methods
engineBuild
abstract fun engineBuild(params: CertPathParameters!): CertPathBuilderResult!
Attempts to build a certification path using the specified algorithm parameter set.
| 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 |
engineGetRevocationChecker
open fun engineGetRevocationChecker(): CertPathChecker!
Returns a CertPathChecker that this implementation uses to check the revocation status of certificates. A PKIX implementation returns objects of type PKIXRevocationChecker.
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 of CertPathBuilder for an example.
This method was added to version 1.8 of the Java Platform Standard Edition. In order to maintain backwards compatibility with existing service providers, this method cannot be abstract and by default throws an UnsupportedOperationException.
| Return |
CertPathChecker! |
a CertPathChecker that this implementation uses to check the revocation status of certificates |
| Exceptions |
java.lang.UnsupportedOperationException |
if this method is not supported |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# CertPathBuilderSpi\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCertPathBuilderSpi\n==================\n\n```\nabstract class CertPathBuilderSpi\n```\n\n|---|--------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.cert.CertPathBuilderSpi](#) |\n\nThe *Service Provider Interface* (**SPI** ) for the [CertPathBuilder](/reference/kotlin/java/security/cert/CertPathBuilder) class. All `CertPathBuilder` implementations must include a class (the SPI class) that extends this class (`CertPathBuilderSpi`) and implements all of its methods. In general, instances of this class should only be accessed through the `CertPathBuilder` class. For details, see the Java Cryptography Architecture.\n\n**Concurrent Access**\n\nInstances of this class need not be protected against concurrent access from multiple threads. Threads that need to access a single `CertPathBuilderSpi` instance concurrently should synchronize amongst themselves and provide the necessary locking before calling the wrapping `CertPathBuilder` object.\n\nHowever, implementations of `CertPathBuilderSpi` may still encounter concurrency issues, since multiple threads each manipulating a different `CertPathBuilderSpi` instance need not synchronize.\n\nSummary\n-------\n\n| Public constructors ||\n|--------------------------------------------------------------------------|---|\n| [CertPathBuilderSpi](#CertPathBuilderSpi())`()` The default constructor. |\n\n| Public methods ||\n|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [CertPathBuilderResult](/reference/kotlin/java/security/cert/CertPathBuilderResult)! | [engineBuild](#engineBuild(java.security.cert.CertPathParameters))`(`params:` `[CertPathParameters](/reference/kotlin/java/security/cert/CertPathParameters)!`)` Attempts to build a certification path using the specified algorithm parameter set. |\n| open [CertPathChecker](/reference/kotlin/java/security/cert/CertPathChecker)! | [engineGetRevocationChecker](#engineGetRevocationChecker())`()` Returns a `CertPathChecker` that this implementation uses to check the revocation status of certificates. |\n\nPublic constructors\n-------------------\n\n### CertPathBuilderSpi\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nCertPathBuilderSpi()\n```\n\nThe default constructor.\n\nPublic methods\n--------------\n\n### engineBuild\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun engineBuild(params: CertPathParameters!): CertPathBuilderResult!\n```\n\nAttempts to build a certification path using the specified algorithm parameter set.\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------|\n| `params` | [CertPathParameters](/reference/kotlin/java/security/cert/CertPathParameters)!: the algorithm parameters |\n\n| Return ||\n|--------------------------------------------------------------------------------------|-----------------------------------|\n| [CertPathBuilderResult](/reference/kotlin/java/security/cert/CertPathBuilderResult)! | the result of the build algorithm |\n\n| Exceptions ||\n|----------------------------------------------------|----------------------------------------------------------------------------------------------------|\n| `java.security.cert.CertPathBuilderException` | if the builder is unable to construct a certification path that satisfies the specified parameters |\n| `java.security.InvalidAlgorithmParameterException` | if the specified parameters are inappropriate for this `CertPathBuilder` |\n\n### engineGetRevocationChecker\n\nAdded in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nopen fun engineGetRevocationChecker(): CertPathChecker!\n```\n\nReturns a `CertPathChecker` that this implementation uses to check the revocation status of certificates. A PKIX implementation returns objects of type `PKIXRevocationChecker`.\n\nThe primary purpose of this method is to allow callers to specify additional input parameters and options specific to revocation checking. See the class description of `CertPathBuilder` for an example.\n\nThis method was added to version 1.8 of the Java Platform Standard Edition. In order to maintain backwards compatibility with existing service providers, this method cannot be abstract and by default throws an `UnsupportedOperationException`.\n\n| Return ||\n|--------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| [CertPathChecker](/reference/kotlin/java/security/cert/CertPathChecker)! | a `CertPathChecker` that this implementation uses to check the revocation status of certificates |\n\n| Exceptions ||\n|-------------------------------------------|---------------------------------|\n| `java.lang.UnsupportedOperationException` | if this method is not supported |"]]
