FileDocCategorySizeDatePackage
PKIXCertPathValidatorResult.javaAPI DocJava SE 6 API5166Tue Jun 10 00:25:48 BST 2008java.security.cert

PKIXCertPathValidatorResult

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.

see
CertPathValidatorResult
version
1.10 11/17/05
since
1.4
author
Yassir Elley
author
Sean Mullan

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

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

	if (subjectPublicKey == null)
	    throw new NullPointerException("subjectPublicKey must be non-null");
	if (trustAnchor == null)
	    throw new NullPointerException("trustAnchor must be non-null");
        this.trustAnchor = trustAnchor;
	this.policyTree = policyTree;
        this.subjectPublicKey = subjectPublicKey;
    
Methods Summary
public java.lang.Objectclone()
Returns a copy of this object.

return
the copy

        try {
            return super.clone();
        } catch (CloneNotSupportedException e) {
            /* Cannot happen */
            throw new InternalError(e.toString());
        }
    
public java.security.cert.PolicyNodegetPolicyTree()
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.

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

	return policyTree;
    
public java.security.PublicKeygetPublicKey()
Returns the public key of the subject (target) of the certification path, including any inherited public key parameters if applicable.

return
the public key of the subject (never null)

	return subjectPublicKey;
    
public java.security.cert.TrustAnchorgetTrustAnchor()
Returns the TrustAnchor describing the CA that served as a trust anchor for the certification path.

return
the TrustAnchor (never null)

	return trustAnchor;
    
public java.lang.StringtoString()
Return a printable representation of this PKIXCertPathValidatorResult.

return
a String describing the contents of this PKIXCertPathValidatorResult

        StringBuffer sb = new StringBuffer();
	sb.append("PKIXCertPathValidatorResult: [\n");
        sb.append("  Trust Anchor: " + trustAnchor.toString() + "\n");
        sb.append("  Policy Tree: " + String.valueOf(policyTree) + "\n");
        sb.append("  Subject Public Key: " + subjectPublicKey + "\n");
        sb.append("]");
        return sb.toString();