001/* PolicyNode.java -- a single node in a policy tree 002 Copyright (C) 2003 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package java.security.cert; 040 041import java.util.Iterator; 042import java.util.Set; 043 044/** 045 * @since 1.4 046 */ 047public interface PolicyNode 048{ 049 050 /** 051 * Get the iterator of the child nodes of this node. The returned 052 * iterator is (naturally) unmodifiable. 053 * 054 * @return An iterator over the child nodes. 055 */ 056 Iterator<? extends PolicyNode> getChildren(); 057 058 /** 059 * Get the depth of this node within the tree, starting at 0 for the 060 * root node. 061 * 062 * @return The depth of this node. 063 */ 064 int getDepth(); 065 066 /** 067 * Returns a set of policies (string OIDs) that will satisfy this 068 * node's policy. The root node should always return the singleton set 069 * with the element "any-policy". 070 * 071 * @return The set of expected policies. 072 */ 073 Set<String> getExpectedPolicies(); 074 075 /** 076 * Returns the parent node of this node, or null if this is the root 077 * node. 078 * 079 * @return The parent node, or null. 080 */ 081 PolicyNode getParent(); 082 083 /** 084 * Returns a set of {@link PolicyQualifierInfo} objects that qualify 085 * the valid policy of this node. The root node should always return 086 * the empty set. 087 * 088 * @return The set of {@link PolicyQualifierInfo} objects. 089 */ 090 Set<? extends PolicyQualifierInfo> getPolicyQualifiers(); 091 092 /** 093 * Get the policy OID this node represents. The root node should return 094 * the special value "any-policy". 095 * 096 * @return The policy of this node. 097 */ 098 String getValidPolicy(); 099 100 /** 101 * Return the criticality flag of this policy node. Nodes who return 102 * true for this method should be considered critical. The root node 103 * is never critical. 104 * 105 * @return The criticality flag. 106 */ 107 boolean isCritical(); 108}