CertPathBuilderSpi

AI-generated Key Takeaways

• CertPathBuilderSpi is a Service Provider Interface for the CertPathBuilder class, requiring all CertPathBuilder implementations to extend it.

• Instances of CertPathBuilderSpi are not inherently thread-safe and require external synchronization for concurrent access.

• CertPathBuilderSpi provides methods for building certification paths (engineBuild) and for obtaining revocation checkers (engineGetRevocationChecker).

• The engineGetRevocationChecker method allows customization of revocation checking and may throw an UnsupportedOperationException for backwards compatibility with older providers.

public abstract class CertPathBuilderSpi extends Object

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

CertPathBuilderSpi() The default constructor.

Public Method Summary

abstract CertPathBuilderResult	engineBuild(CertPathParameters params) Attempts to build a certification path using the specified algorithm parameter set.
CertPathChecker	engineGetRevocationChecker() Returns a CertPathChecker that this implementation uses to check the revocation status of certificates.

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 ()

The default constructor.

Public Methods

public abstract CertPathBuilderResult engineBuild (CertPathParameters params)

Attempts to build a certification path using the specified algorithm parameter set.

Parameters

params	the algorithm parameters

Returns

• the result of the build algorithm

Throws

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

Throws

UnsupportedOperationException	if this method is not supported