Stay organized with collections
Save and categorize content based on your preferences.
CertPathValidatorSpi
abstract class CertPathValidatorSpi
The Service Provider Interface (SPI) for the CertPathValidator class. All CertPathValidator implementations must include a class (the SPI class) that extends this class (CertPathValidatorSpi) and implements all of its methods. In general, instances of this class should only be accessed through the CertPathValidator 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 CertPathValidatorSpi instance concurrently should synchronize amongst themselves and provide the necessary locking before calling the wrapping CertPathValidator object.
However, implementations of CertPathValidatorSpi may still encounter concurrency issues, since multiple threads each manipulating a different CertPathValidatorSpi instance need not synchronize.
Summary
| Public constructors |
|
The default constructor.
|
| Public methods |
| open CertPathChecker! |
Returns a CertPathChecker that this implementation uses to check the revocation status of certificates.
|
| abstract CertPathValidatorResult! |
Validates the specified certification path using the specified algorithm parameter set.
|
Public constructors
CertPathValidatorSpi
CertPathValidatorSpi()
The default constructor.
Public methods
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 CertPathValidator 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 |
engineValidate
abstract fun engineValidate(
certPath: CertPath!,
params: CertPathParameters!
): CertPathValidatorResult!
Validates the specified certification path using the specified algorithm parameter set.
The CertPath specified must be of a type that is supported by the validation algorithm, otherwise an InvalidAlgorithmParameterException will be thrown. For example, a CertPathValidator that implements the PKIX algorithm validates CertPath objects of type X.509.
| Exceptions |
java.security.cert.CertPathValidatorException |
if the CertPath does not validate |
java.security.InvalidAlgorithmParameterException |
if the specified parameters or the type of the specified CertPath are inappropriate for this CertPathValidator |
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.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# CertPathValidatorSpi\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCertPathValidatorSpi\n====================\n\n```\nabstract class CertPathValidatorSpi\n```\n\n|---|----------------------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.security.cert.CertPathValidatorSpi](#) |\n\nThe *Service Provider Interface* (**SPI** ) for the [CertPathValidator](/reference/kotlin/java/security/cert/CertPathValidator) class. All `CertPathValidator` implementations must include a class (the SPI class) that extends this class (`CertPathValidatorSpi`) and implements all of its methods. In general, instances of this class should only be accessed through the `CertPathValidator` 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 `CertPathValidatorSpi` instance concurrently should synchronize amongst themselves and provide the necessary locking before calling the wrapping `CertPathValidator` object.\n\nHowever, implementations of `CertPathValidatorSpi` may still encounter concurrency issues, since multiple threads each manipulating a different `CertPathValidatorSpi` instance need not synchronize.\n\nSummary\n-------\n\n| Public constructors ||\n|------------------------------------------------------------------------------|---|\n| [CertPathValidatorSpi](#CertPathValidatorSpi())`()` The default constructor. |\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\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| abstract [CertPathValidatorResult](/reference/kotlin/java/security/cert/CertPathValidatorResult)! | [engineValidate](#engineValidate(java.security.cert.CertPath,%20java.security.cert.CertPathParameters))`(`certPath:` `[CertPath](/reference/kotlin/java/security/cert/CertPath)!`, `params:` `[CertPathParameters](/reference/kotlin/java/security/cert/CertPathParameters)!`)` Validates the specified certification path using the specified algorithm parameter set. |\n\nPublic constructors\n-------------------\n\n### CertPathValidatorSpi\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nCertPathValidatorSpi()\n```\n\nThe default constructor.\n\nPublic methods\n--------------\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 `CertPathValidator` 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 |\n\n### engineValidate\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun engineValidate(\n certPath: CertPath!, \n params: CertPathParameters!\n): CertPathValidatorResult!\n```\n\nValidates the specified certification path using the specified algorithm parameter set.\n\nThe `CertPath` specified must be of a type that is supported by the validation algorithm, otherwise an `InvalidAlgorithmParameterException` will be thrown. For example, a `CertPathValidator` that implements the PKIX algorithm validates `CertPath` objects of type X.509.\n\n| Parameters ||\n|------------|----------------------------------------------------------------------------------------------------------|\n| `certPath` | [CertPath](/reference/kotlin/java/security/cert/CertPath)!: the `CertPath` to be validated |\n| `params` | [CertPathParameters](/reference/kotlin/java/security/cert/CertPathParameters)!: the algorithm parameters |\n\n| Return ||\n|------------------------------------------------------------------------------------------|----------------------------------------|\n| [CertPathValidatorResult](/reference/kotlin/java/security/cert/CertPathValidatorResult)! | the result of the validation algorithm |\n\n| Exceptions ||\n|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|\n| `java.security.cert.CertPathValidatorException` | if the `CertPath` does not validate |\n| `java.security.InvalidAlgorithmParameterException` | if the specified parameters or the type of the specified `CertPath` are inappropriate for this `CertPathValidator` |"]]
