Stay organized with collections
Save and categorize content based on your preferences.
CertPathChecker
interface CertPathChecker
Known Indirect Subclasses
| PKIXRevocationChecker |
A PKIXCertPathChecker for checking the revocation status of certificates with the PKIX algorithm.
|
|
Performs one or more checks on each Certificate of a CertPath.
A CertPathChecker implementation is typically created to extend a certification path validation algorithm. For example, an implementation may check for and process a critical private extension of each certificate in a certification path.
Summary
| Public methods |
| abstract Unit |
Performs the check(s) on the specified certificate using its internal state.
|
| abstract Unit |
Initializes the internal state of this CertPathChecker.
|
| abstract Boolean |
Indicates if forward checking is supported.
|
Public methods
check
abstract fun check(cert: Certificate!): Unit
Performs the check(s) on the specified certificate using its internal state. The certificates are presented in the order specified by the init method.
| Parameters |
cert |
Certificate!: the Certificate to be checked |
| Exceptions |
java.security.cert.CertPathValidatorException |
if the specified certificate does not pass the check |
init
abstract fun init(forward: Boolean): Unit
Initializes the internal state of this CertPathChecker.
The forward flag specifies the order that certificates will be passed to the check method (forward or reverse).
| Parameters |
forward |
Boolean: the order that certificates are presented to the check method. If true, certificates are presented from target to trust anchor (forward); if false, from trust anchor to target (reverse). |
| Exceptions |
java.security.cert.CertPathValidatorException |
if this CertPathChecker is unable to check certificates in the specified order |
isForwardCheckingSupported
abstract fun isForwardCheckingSupported(): Boolean
Indicates if forward checking is supported. Forward checking refers to the ability of the CertPathChecker to perform its checks when certificates are presented to the check method in the forward direction (from target to trust anchor).
| Return |
Boolean |
true if forward checking is supported, false otherwise |
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,["# CertPathChecker\n\nAdded in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nCertPathChecker\n===============\n\n```\ninterface CertPathChecker\n```\n\n|-----------------------------------------|\n| [java.security.cert.CertPathChecker](#) |\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Direct Subclasses [PKIXCertPathChecker](/reference/kotlin/java/security/cert/PKIXCertPathChecker) |---------------------------------------------------------------------------------|-----------------------------------------------------------------------------| | [PKIXCertPathChecker](/reference/kotlin/java/security/cert/PKIXCertPathChecker) | An abstract class that performs one or more checks on an `X509Certificate`. | |\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Indirect Subclasses [PKIXRevocationChecker](/reference/kotlin/java/security/cert/PKIXRevocationChecker) |-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | [PKIXRevocationChecker](/reference/kotlin/java/security/cert/PKIXRevocationChecker) | A `PKIXCertPathChecker` for checking the revocation status of certificates with the PKIX algorithm. | |\n\nPerforms one or more checks on each `Certificate` of a `CertPath`.\n\nA `CertPathChecker` implementation is typically created to extend a certification path validation algorithm. For example, an implementation may check for and process a critical private extension of each certificate in a certification path.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [check](#check(java.security.cert.Certificate))`(`cert:` `[Certificate](/reference/kotlin/java/security/cert/Certificate)!`)` Performs the check(s) on the specified certificate using its internal state. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [init](#init(kotlin.Boolean))`(`forward:` `[Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)`)` Initializes the internal state of this `CertPathChecker`. |\n| abstract [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [isForwardCheckingSupported](#isForwardCheckingSupported())`()` Indicates if forward checking is supported. |\n\nPublic methods\n--------------\n\n### check\n\nAdded in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun check(cert: Certificate!): Unit\n```\n\nPerforms the check(s) on the specified certificate using its internal state. The certificates are presented in the order specified by the `init` method.\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------|\n| `cert` | [Certificate](/reference/kotlin/java/security/cert/Certificate)!: the `Certificate` to be checked |\n\n| Exceptions ||\n|-------------------------------------------------|------------------------------------------------------|\n| `java.security.cert.CertPathValidatorException` | if the specified certificate does not pass the check |\n\n### init\n\nAdded in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun init(forward: Boolean): Unit\n```\n\nInitializes the internal state of this `CertPathChecker`.\n\nThe `forward` flag specifies the order that certificates will be passed to the [check](#check(java.security.cert.Certificate)) method (forward or reverse).\n\n| Parameters ||\n|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `forward` | [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html): the order that certificates are presented to the `check` method. If `true`, certificates are presented from target to trust anchor (forward); if `false`, from trust anchor to target (reverse). |\n\n| Exceptions ||\n|-------------------------------------------------|----------------------------------------------------------------------------------|\n| `java.security.cert.CertPathValidatorException` | if this `CertPathChecker` is unable to check certificates in the specified order |\n\n### isForwardCheckingSupported\n\nAdded in [API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun isForwardCheckingSupported(): Boolean\n```\n\nIndicates if forward checking is supported. Forward checking refers to the ability of the `CertPathChecker` to perform its checks when certificates are presented to the `check` method in the forward direction (from target to trust anchor).\n\n| Return ||\n|------------------------------------------------------------------------------------|------------------------------------------------------------|\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | `true` if forward checking is supported, `false` otherwise |"]]
