CertPathBuilderSpi
Stay organized with collections
Save and categorize content based on your preferences.
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.
Public Constructor Summary
Inherited Method Summary
From class
java.lang.Object
|
Object
|
clone()
Creates and returns a copy of this Object.
|
|
boolean
|
equals( Object obj)
Compares this instance with the specified object and indicates if they
are equal.
|
|
void
|
finalize()
Invoked when the garbage collector has detected that this instance is no longer reachable.
|
|
final
Class<?>
|
getClass()
Returns the unique instance of Class that represents this
object's class.
|
|
int
|
hashCode()
Returns an integer hash code for this object.
|
|
final
void
|
notify()
Causes a thread which is waiting on this object's monitor (by means of
calling one of the wait() methods) to be woken up.
|
|
final
void
|
notifyAll()
Causes all threads which are waiting on this object's monitor (by means
of calling one of the wait() methods) to be woken up.
|
|
String
|
toString()
Returns a string containing a concise, human-readable description of this
object.
|
|
final
void
|
wait(long timeout, int nanos)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait(long timeout)
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the
specified timeout expires.
|
|
final
void
|
wait()
Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.
|
Public Constructors
public
CertPathBuilderSpi
()
Public Methods
Attempts to build a certification path using the specified
algorithm parameter set.
Parameters
| params |
the algorithm parameters |
Returns
- the result of the build algorithm
public
CertPathChecker
engineGetRevocationChecker
()
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.
Returns
- a
CertPathChecker that this implementation uses to
check the revocation status of certificates
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-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 2024-07-10 UTC."],[[["\u003cp\u003e\u003ccode\u003eCertPathBuilderSpi\u003c/code\u003e is a Service Provider Interface for the \u003ccode\u003eCertPathBuilder\u003c/code\u003e class, requiring all \u003ccode\u003eCertPathBuilder\u003c/code\u003e implementations to extend it.\u003c/p\u003e\n"],["\u003cp\u003eInstances of \u003ccode\u003eCertPathBuilderSpi\u003c/code\u003e are not inherently thread-safe and require external synchronization for concurrent access.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eCertPathBuilderSpi\u003c/code\u003e provides methods for building certification paths (\u003ccode\u003eengineBuild\u003c/code\u003e) and for obtaining revocation checkers (\u003ccode\u003eengineGetRevocationChecker\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eengineGetRevocationChecker\u003c/code\u003e method allows customization of revocation checking and may throw an \u003ccode\u003eUnsupportedOperationException\u003c/code\u003e for backwards compatibility with older providers.\u003c/p\u003e\n"]]],["`CertPathBuilderSpi` is the Service Provider Interface for `CertPathBuilder`. Implementations must extend this abstract class. Instances are accessed via the `CertPathBuilder` class and are not required to be thread-safe individually but may encounter concurrency issues. Key actions include: `engineBuild`, which attempts to build a certification path with specified parameters, and `engineGetRevocationChecker`, which returns a `CertPathChecker` for certificate revocation status checking. The class includes a default constructor and methods inherited from the Object class.\n"],null,["public abstract class **CertPathBuilderSpi** extends [Object](../../../../reference/java/lang/Object.html) \nThe *Service Provider Interface* (**SPI** )\nfor the [CertPathBuilder](../../../../reference/java/security/cert/CertPathBuilder.html) class. All\n`CertPathBuilder` implementations must include a class (the\nSPI class) that extends this class (`CertPathBuilderSpi`) and\nimplements all of its methods. In general, instances of this class should\nonly be accessed through the `CertPathBuilder` class. For\ndetails, see the Java Cryptography Architecture.\n\n\n**Concurrent Access**\n\n\nInstances of this class need not be protected against concurrent\naccess from multiple threads. Threads that need to access a single\n`CertPathBuilderSpi` instance concurrently should synchronize\namongst themselves and provide the necessary locking before calling the\nwrapping `CertPathBuilder` object.\n\n\nHowever, implementations of `CertPathBuilderSpi` may still\nencounter concurrency issues, since multiple threads each\nmanipulating a different `CertPathBuilderSpi` instance need not\nsynchronize. \n\nPublic Constructor Summary\n\n|---|----------------------------------------------------------------------------------------------------------------------------------------|\n| | [CertPathBuilderSpi](../../../../reference/java/security/cert/CertPathBuilderSpi.html#CertPathBuilderSpi())() The default constructor. |\n\nPublic Method Summary\n\n|-------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [CertPathBuilderResult](../../../../reference/java/security/cert/CertPathBuilderResult.html) | [engineBuild](../../../../reference/java/security/cert/CertPathBuilderSpi.html#engineBuild(java.security.cert.CertPathParameters))([CertPathParameters](../../../../reference/java/security/cert/CertPathParameters.html) params) Attempts to build a certification path using the specified algorithm parameter set. |\n| [CertPathChecker](../../../../reference/java/security/cert/CertPathChecker.html) | [engineGetRevocationChecker](../../../../reference/java/security/cert/CertPathBuilderSpi.html#engineGetRevocationChecker())() Returns a `CertPathChecker` that this implementation uses to check the revocation status of certificates. |\n\nInherited Method Summary \nFrom class [java.lang.Object](../../../../reference/java/lang/Object.html) \n\n|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Object](../../../../reference/java/lang/Object.html) | [clone](../../../../reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |\n| boolean | [equals](../../../../reference/java/lang/Object.html#equals(java.lang.Object))([Object](../../../../reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |\n| void | [finalize](../../../../reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |\n| final [Class](../../../../reference/java/lang/Class.html)\\\u003c?\\\u003e | [getClass](../../../../reference/java/lang/Object.html#getClass())() Returns the unique instance of [Class](../../../../reference/java/lang/Class.html) that represents this object's class. |\n| int | [hashCode](../../../../reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |\n| final void | [notify](../../../../reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| final void | [notifyAll](../../../../reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |\n| [String](../../../../reference/java/lang/String.html) | [toString](../../../../reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |\n| final void | [wait](../../../../reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../../reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |\n| final void | [wait](../../../../reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |\n\nPublic Constructors \n\npublic\n**CertPathBuilderSpi**\n() \nThe default constructor.\n\nPublic Methods \n\npublic abstract [CertPathBuilderResult](../../../../reference/java/security/cert/CertPathBuilderResult.html)\n**engineBuild**\n([CertPathParameters](../../../../reference/java/security/cert/CertPathParameters.html) params) \nAttempts to build a certification path using the specified\nalgorithm parameter set. \n\nParameters\n\n| params | the algorithm parameters |\n|--------|--------------------------|\n\nReturns\n\n- the result of the build algorithm \n\nThrows\n\n| [CertPathBuilderException](../../../../reference/java/security/cert/CertPathBuilderException.html) | if the builder is unable to construct a certification path that satisfies the specified parameters |\n| [InvalidAlgorithmParameterException](../../../../reference/java/security/InvalidAlgorithmParameterException.html) | if the specified parameters are inappropriate for this `CertPathBuilder` |\n|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|\n\npublic [CertPathChecker](../../../../reference/java/security/cert/CertPathChecker.html)\n**engineGetRevocationChecker**\n() \nReturns a `CertPathChecker` that this implementation uses to\ncheck the revocation status of certificates. A PKIX implementation\nreturns objects of type `PKIXRevocationChecker`.\n\nThe primary purpose of this method is to allow callers to specify\nadditional input parameters and options specific to revocation checking.\nSee the class description of `CertPathBuilder` for an example.\n\nThis method was added to version 1.8 of the Java Platform Standard\nEdition. In order to maintain backwards compatibility with existing\nservice providers, this method cannot be abstract and by default throws\nan `UnsupportedOperationException`. \n\nReturns\n\n- a `CertPathChecker` that this implementation uses to check the revocation status of certificates \n\nThrows\n\n| [UnsupportedOperationException](../../../../reference/java/lang/UnsupportedOperationException.html) | if this method is not supported |\n|-----------------------------------------------------------------------------------------------------|---------------------------------|"]]
