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

public Class PKIXCertPathValidatorResult

extends Object
implements CertPathValidatorResult
Class Inheritance
All Implemented Interfaces
java.security.cert.CertPathValidatorResult, java.lang.Cloneable
Known Direct Subclasses
java.security.cert.PKIXCertPathBuilderResult
Imports
java.security.PublicKey

This class represents the successful result of the PKIX certification path validation algorithm.

Instances of PKIXCertPathValidatorResult are returned by the validate method of CertPathValidator objects implementing the PKIX algorithm.

All PKIXCertPathValidatorResult objects contain the valid policy tree and subject public key resulting from the validation algorithm, as well as 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.

Authors
Yassir Elley, Sean Mullan
Since
1.4
See Also
CertPathValidatorResult

Field Summary

Modifier and TypeField and Description
private final PolicyNode
private final PublicKey
private final TrustAnchor

Constructor Summary

AccessConstructor and Description
public
PKIXCertPathValidatorResult(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 PKIXCertPathValidatorResult containing the specified parameters.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

the copy
clone
()

Overrides java.lang.Object.clone.

Implements java.security.cert.CertPathValidatorResult.clone.

Returns a copy of this object.

public PolicyNode

Returns:

the root node of the valid policy tree, or null if there are no valid policies
getPolicyTree
()

Returns the root node of the valid policy tree resulting from the PKIX certification path validation algorithm.

public PublicKey

Returns:

the public key of the subject (never null)
getPublicKey
()

Returns the public key of the subject (target) of the certification path, including any inherited public key parameters if applicable.

public TrustAnchor

Returns:

the TrustAnchor (never null)
getTrustAnchor
()

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

public String

Returns:

a String describing the contents of this PKIXCertPathValidatorResult
toString
()

Overrides java.lang.Object.toString.

Return a printable representation of this PKIXCertPathValidatorResult.

Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

policyTreeback to summary
private final PolicyNode policyTree
subjectPublicKeyback to summary
private final PublicKey subjectPublicKey
trustAnchorback to summary
private final TrustAnchor trustAnchor

Constructor Detail

PKIXCertPathValidatorResultback to summary
public PKIXCertPathValidatorResult(TrustAnchor trustAnchor, PolicyNode policyTree, PublicKey subjectPublicKey)

Creates an instance of PKIXCertPathValidatorResult containing the specified parameters.

Parameters
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 subjectPublicKey or trustAnchor parameters are null

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Implements java.security.cert.CertPathValidatorResult.clone.

Returns a copy of this object.

Returns:Object

the copy

getPolicyTreeback to summary
public PolicyNode getPolicyTree()

Returns the root node of the valid policy tree resulting from the PKIX certification path validation algorithm. The PolicyNode object that is returned and any objects that it returns through public methods are immutable.

Most applications will not need to examine the valid policy tree. They can achieve their policy processing goals by setting the policy-related parameters in PKIXParameters. However, more sophisticated applications, especially those that process policy qualifiers, may need to traverse the valid policy tree using the PolicyNode.getParent and PolicyNode.getChildren methods.

Returns:PolicyNode

the root node of the valid policy tree, or null if there are no valid policies

getPublicKeyback to summary
public PublicKey getPublicKey()

Returns the public key of the subject (target) of the certification path, including any inherited public key parameters if applicable.

Returns:PublicKey

the public key of the subject (never null)

getTrustAnchorback to summary
public TrustAnchor getTrustAnchor()

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

Returns:TrustAnchor

the TrustAnchor (never null)

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Return a printable representation of this PKIXCertPathValidatorResult.

Returns:String

a String describing the contents of this PKIXCertPathValidatorResult