PKIXCertPathBuilderResult

AI-generated Key Takeaways

• PKIXCertPathBuilderResult represents a successfully built and validated certification path using the PKIX algorithm.

• It contains the certification path, trust anchor, policy tree, and subject public key.

• The getCertPath() method returns the built and validated certification path, while getTrustAnchor() provides the trust anchor used.

• Methods in this class are not thread-safe and require synchronization for concurrent access by multiple threads.

• Instances of this class are created by the build method of CertPathBuilder objects implementing the PKIX algorithm.

public class PKIXCertPathBuilderResult extends PKIXCertPathValidatorResult
implements CertPathBuilderResult

This class represents the successful result of the PKIX certification path builder algorithm. All certification paths that are built and returned using this algorithm are also validated according to the PKIX certification path validation algorithm.

Instances of PKIXCertPathBuilderResult are returned by the build method of CertPathBuilder objects implementing the PKIX algorithm.

All PKIXCertPathBuilderResult objects contain the certification path constructed by the build algorithm, the valid policy tree and subject public key resulting from the build algorithm, and a TrustAnchor describing the certification authority (CA) that served as a trust anchor for the certification path.

Concurrent Access

Unless otherwise specified, the methods defined in this class are not thread-safe. Multiple threads that need to access a single object concurrently should synchronize amongst themselves and provide the necessary locking. Multiple threads each manipulating separate objects need not synchronize.

See Also

• CertPathBuilderResult

Public Constructor Summary

PKIXCertPathBuilderResult(CertPath certPath, TrustAnchor trustAnchor, PolicyNode policyTree, PublicKey subjectPublicKey) Creates an instance of PKIXCertPathBuilderResult containing the specified parameters.

Public Method Summary

CertPath	getCertPath() Returns the built and validated certification path.
String	toString() Return a printable representation of this PKIXCertPathBuilderResult.

Inherited Method Summary

From class java.security.cert.PKIXCertPathValidatorResult

Object	clone() Returns a copy of this object.
PolicyNode	getPolicyTree() Returns the root node of the valid policy tree resulting from the PKIX certification path validation algorithm.
PublicKey	getPublicKey() Returns the public key of the subject (target) of the certification path, including any inherited public key parameters if applicable.
TrustAnchor	getTrustAnchor() Returns the TrustAnchor describing the CA that served as a trust anchor for the certification path.
String	toString() Return a printable representation of this PKIXCertPathValidatorResult.

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.

From interface java.security.cert.CertPathValidatorResult

abstract Object

clone() Makes a copy of this CertPathValidatorResult.

From interface java.security.cert.CertPathBuilderResult

abstract Object	clone() Makes a copy of this CertPathBuilderResult.
abstract CertPath	getCertPath() Returns the built certification path.

Public Constructors

public PKIXCertPathBuilderResult (CertPath certPath, TrustAnchor trustAnchor, PolicyNode policyTree, PublicKey subjectPublicKey)

Creates an instance of PKIXCertPathBuilderResult containing the specified parameters.

Parameters

certPath	the validated CertPath
trustAnchor	a TrustAnchor describing the CA that served as a trust anchor for the certification path
policyTree	the immutable valid policy tree, or null if there are no valid policies
subjectPublicKey	the public key of the subject

Throws

NullPointerException	if the certPath, trustAnchor or subjectPublicKey parameters are null

Public Methods

public CertPath getCertPath ()

Returns the built and validated certification path. The CertPath object does not include the trust anchor. Instead, use the getTrustAnchor() method to obtain the TrustAnchor that served as the trust anchor for the certification path.

Returns

• the built and validated CertPath (never null)

public String toString ()

Return a printable representation of this PKIXCertPathBuilderResult.

Returns

• a String describing the contents of this PKIXCertPathBuilderResult