libjava/java/security/cert/PolicyNode.java

   1 /* PolicyNode.java -- a single node in a policy tree
   2    Copyright (C) 2003 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.security.cert;
  40
  41 public interface PolicyNode
  42 {
  43
  44   /**
  45    * Get the iterator of the child nodes of this node. The returned
  46    * iterator is (naturally) unmodifiable.
  47    *
  48    * @return An iterator over the child nodes.
  49    */
  50   java.util.Iterator getChildren();
  51
  52   /**
  53    * Get the depth of this node within the tree, starting at 0 for the
  54    * root node.
  55    *
  56    * @return The depth of this node.
  57    */
  58   int getDepth();
  59
  60   /**
  61    * Returns a set of policies (string OIDs) that will satisfy this
  62    * node's policy. The root node should always return the singleton set
  63    * with the element "any-policy".
  64    *
  65    * @return The set of expected policies.
  66    */
  67   java.util.Set getExpectedPolicies();
  68
  69   /**
  70    * Returns the parent node of this node, or null if this is the root
  71    * node.
  72    *
  73    * @return The parent node, or null.
  74    */
  75   PolicyNode getParent();
  76
  77   /**
  78    * Returns a set of {@link PolicyQualifierInfo} objects that qualify
  79    * the valid policy of this node. The root node should always return
  80    * the empty set.
  81    *
  82    * @return The set of {@link PolicyQualifierInfo} objects.
  83    */
  84   java.util.Set getPolicyQualifiers();
  85
  86   /**
  87    * Get the policy OID this node represents. The root node should return
  88    * the special value "any-policy".
  89    *
  90    * @return The policy of this node.
  91    */
  92   String getValidPolicy();
  93
  94   /**
  95    * Return the criticality flag of this policy node. Nodes who return
  96    * true for this method should be considered critical. The root node
  97    * is never critical.
  98    *
  99    * @return The criticality flag.
 100    */
 101   boolean isCritical();
 102 }