This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.security.cert
class PKIXCertPathValidatorResult

java.lang.Object extended by java.security.cert.PKIXCertPathValidatorResult
All Implemented Interfaces:
CertPathValidatorResult
Direct Known Subclasses:
PKIXCertPathBuilderResult

Most common way to construct:

CertPathValidator cpv = …;
CertPath certPath = …;
PKIXParameters params = …;

PKIXCertPathValidatorResult result = (PKIXCertPathValidatorResult)cpv.validate(certPath, params);

Based on 14 examples


public class PKIXCertPathValidatorResult
extends Object
implements CertPathValidatorResult

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

Instances of PKIXCertPathValidatorResult are returned by the {@link CertPathValidator#validate 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.


Constructor Summary
PKIXCertPathValidatorResult(TrustAnchor trustAnchor, PolicyNode policyTree, PublicKey subjectPublicKey)

          Creates an instance of PKIXCertPathValidatorResult containing the specified parameters.
 
Method Summary
 Object

          Returns a copy of this object.
 PolicyNode

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

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

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

          Return a printable representation of this PKIXCertPathValidatorResult.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PKIXCertPathValidatorResult

public PKIXCertPathValidatorResult(TrustAnchor trustAnchor,
                                   PolicyNode policyTree,
                                   PublicKey subjectPublicKey)
Creates an instance of PKIXCertPathValidatorResult containing the specified parameters.

Parameters:
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
Method Detail

clone

public Object clone()
Returns a copy of this object.

Overrides:
clone in class Object
Returns:
the copy

getPolicyTree

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 {@link PolicyNode#getParent PolicyNode.getParent} and {@link PolicyNode#getChildren PolicyNode.getChildren} methods.

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

getPublicKey

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

Returns:
the public key of the subject (never null)

getTrustAnchor

public TrustAnchor getTrustAnchor()
Returns the TrustAnchor describing the CA that served as a trust anchor for the certification path.

Returns:
the TrustAnchor (never null)

toString

public String toString()
Return a printable representation of this PKIXCertPathValidatorResult.

Overrides:
toString in class Object
Returns:
a String describing the contents of this PKIXCertPathValidatorResult


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.