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

PolicyNode

public interface PolicyNode
An immutable valid policy tree node as defined by the PKIX certification path validation algorithm.

One of the outputs of the PKIX certification path validation algorithm is a valid policy tree, which includes the policies that were determined to be valid, how this determination was reached, and any policy qualifiers encountered. This tree is of depth n, where n is the length of the certification path that has been validated.

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, the valid policy tree is available for more sophisticated applications, especially those that process policy qualifiers.

{@link PKIXCertPathValidatorResult#getPolicyTree() PKIXCertPathValidatorResult.getPolicyTree} returns the root node of the valid policy tree. The tree can be traversed using the {@link #getChildren getChildren} and {@link #getParent getParent} methods. Data about a particular node can be retrieved using other methods of PolicyNode.

Concurrent Access

All PolicyNode objects must be immutable and thread-safe. Multiple threads may concurrently invoke the methods defined in this class on a single PolicyNode object (or more than one) with no ill effects. This stipulation applies to all public fields and methods of this class and any added or overridden by subclasses.

version
1.10 11/17/05
since
1.4
author
Sean Mullan

Fields Summary
Constructors Summary
Methods Summary
public java.util.IteratorgetChildren()
Returns an iterator over the children of this node. Any attempts to modify the children of this node through the Iterator's remove method must throw an UnsupportedOperationException.

return
an iterator over the children of this node

public intgetDepth()
Returns the depth of this node in the valid policy tree.

return
the depth of this node (0 for the root node, 1 for its children, and so on)

public java.util.SetgetExpectedPolicies()
Returns the set of expected policies that would satisfy this node's valid policy in the next certificate to be processed.

return
an immutable Set of expected policy String OIDs, or an immutable Set with the single special value "any-policy". For the root node, this method always returns a Set with the single value "any-policy".

public java.security.cert.PolicyNodegetParent()
Returns the parent of this node, or null if this is the root node.

return
the parent of this node, or null if this is the root node

public java.util.SetgetPolicyQualifiers()
Returns the set of policy qualifiers associated with the valid policy represented by this node.

return
an immutable Set of PolicyQualifierInfos. For the root node, this is always an empty Set.

public java.lang.StringgetValidPolicy()
Returns the valid policy represented by this node.

return
the String OID of the valid policy represented by this node, or the special value "any-policy". For the root node, this method always returns the special value "any-policy".

public booleanisCritical()
Returns the criticality indicator of the certificate policy extension in the most recently processed certificate.

return
true if extension marked critical, false otherwise. For the root node, false is always returned.