PKIXCertPathValidatorResult (Java Platform SE 6) (original) (raw)

java.security.cert

Class PKIXCertPathValidatorResult

java.lang.Object java.security.cert.PKIXCertPathValidatorResult

All Implemented Interfaces:

Cloneable, CertPathValidatorResult

Direct Known Subclasses:

PKIXCertPathBuilderResult

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 [validate](../../../java/security/cert/CertPathValidator.html#validate%28java.security.cert.CertPath, java.security.cert.CertPathParameters%29) 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.

Since:

1.4

See Also:

CertPathValidatorResult

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

Throws:

[NullPointerException](../../../java/lang/NullPointerException.html "class in java.lang") - if the subjectPublicKey ortrustAnchor parameters are 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)

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 thePolicyNode.getParent and 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)

clone

public Object clone()

Returns a copy of this object.

Specified by:

[clone](../../../java/security/cert/CertPathValidatorResult.html#clone%28%29) in interface [CertPathValidatorResult](../../../java/security/cert/CertPathValidatorResult.html "interface in java.security.cert")

Overrides:

[clone](../../../java/lang/Object.html#clone%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

the copy

See Also:

Cloneable

toString

public String toString()

Return a printable representation of this PKIXCertPathValidatorResult.

Overrides:

[toString](../../../java/lang/Object.html#toString%28%29) in class [Object](../../../java/lang/Object.html "class in java.lang")

Returns:

a String describing the contents of thisPKIXCertPathValidatorResult

Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

Scripting on this page tracks web page traffic, but does not change the content in any way.