APIdia Launch Partner
Top Description Fields Constructors Methods
java.security.cert

public Class PKIXCertPathBuilderResult

extends PKIXCertPathValidatorResult
implements CertPathBuilderResult
Class Inheritance
All Implemented Interfaces
java.security.cert.CertPathBuilderResult, java.lang.Cloneable
Known Direct Subclasses
sun.security.provider.certpath.SunCertPathBuilderResult
Imports
java.security.PublicKey
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.

Author
Anne Anderson
Since
1.4
See Also
CertPathBuilderResult

Field Summary

Modifier and TypeField and Description
private final CertPath
certPath

Constructor Summary

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

Creates an instance of PKIXCertPathBuilderResult containing the specified parameters.

Method Summary

Modifier and TypeMethod and Description
public CertPath

Returns:

the built and validated CertPath (never null)
getCertPath()

Implements java.security.cert.CertPathBuilderResult.getCertPath.

Returns the built and validated certification path.

public String

Returns:

a String describing the contents of this PKIXCertPathBuilderResult
toString()

Overrides java.security.cert.PKIXCertPathValidatorResult.toString.

Return a printable representation of this PKIXCertPathBuilderResult.

Inherited from java.security.cert.PKIXCertPathValidatorResult:
clonegetPolicyTreegetPublicKeygetTrustAnchor

Field Detail

certPathback to summary
private final CertPath certPath

Constructor Detail

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

Creates an instance of PKIXCertPathBuilderResult containing the specified parameters.

Parameters
certPath:CertPath

the validated CertPath

trustAnchor:TrustAnchor

a TrustAnchor describing the CA that served as a trust anchor for the certification path

policyTree:PolicyNode

the immutable valid policy tree, or null if there are no valid policies

subjectPublicKey:PublicKey

the public key of the subject

Exceptions
NullPointerException:
if the certPath, trustAnchor or subjectPublicKey parameters are null

Method Detail

getCertPathback to summary
public CertPath getCertPath()

Implements java.security.cert.CertPathBuilderResult.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:CertPath

the built and validated CertPath (never null)

toStringback to summary
public String toString()

Overrides java.security.cert.PKIXCertPathValidatorResult.toString.

Return a printable representation of this PKIXCertPathBuilderResult.

Returns:String

a String describing the contents of this PKIXCertPathBuilderResult