libjava/java/security/cert/PKIXCertPathValidatorResult.java

   1 /* PKIXCertPathValidatorResult.java -- PKIX cert path builder result
   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 import java.security.PublicKey;
  42
  43 /**
  44  * Results returned by the {@link
  45  * CertPathValidator#validate(java.security.cert.CertPath,java.security.cert.CertPathParameters)}
  46  * method for PKIX {@link CertPathValidator}s.
  47  *
  48  * @see CertPathValidator
  49  */
  50 public class PKIXCertPathValidatorResult implements CertPathValidatorResult
  51 {
  52
  53   // Fields.
  54   // ------------------------------------------------------------------------
  55
  56   /** The trust anchor. */
  57   private final TrustAnchor trustAnchor;
  58
  59   /** The root node of the policy tree. */
  60   private final PolicyNode policyTree;
  61
  62   /** The subject's public key. */
  63   private final PublicKey subjectPublicKey;
  64
  65   // Constructor.
  66   // ------------------------------------------------------------------------
  67
  68   /**
  69    * Creates a new PKIXCertPathValidatorResult.
  70    *
  71    * @param trustAnchor      The trust anchor.
  72    * @param policyTree       The root node of the policy tree.
  73    * @param subjectPublicKey The public key.
  74    * @throws NullPointerException If either <i>trustAnchor</i> or
  75    *         <i>subjectPublicKey</i> is null.
  76    */
  77   public PKIXCertPathValidatorResult(TrustAnchor trustAnchor,
  78                                      PolicyNode policyTree,
  79                                      PublicKey subjectPublicKey)
  80   {
  81     if (trustAnchor == null || subjectPublicKey == null)
  82       throw new NullPointerException();
  83     this.trustAnchor = trustAnchor;
  84     this.policyTree = policyTree;
  85     this.subjectPublicKey = subjectPublicKey;
  86   }
  87
  88   // Instance methods.
  89   // ------------------------------------------------------------------------
  90
  91   /**
  92    * Returns the trust anchor.
  93    *
  94    * @return The trust anchor.
  95    */
  96   public TrustAnchor getTrustAnchor()
  97   {
  98     return trustAnchor;
  99   }
 100
 101   /**
 102    * Returns the root node of the policy tree.
 103    *
 104    * @return The root node of the policy tree.
 105    */
 106   public PolicyNode getPolicyTree()
 107   {
 108     return policyTree;
 109   }
 110
 111   /**
 112    * Returns the subject public key.
 113    *
 114    * @return The subject public key.
 115    */
 116   public PublicKey getPublicKey()
 117   {
 118     return subjectPublicKey;
 119   }
 120
 121   /**
 122    * Returns a copy of this object.
 123    *
 124    * @return The copy.
 125    */
 126   public Object clone()
 127   {
 128     return new PKIXCertPathValidatorResult(trustAnchor, policyTree,
 129                                            subjectPublicKey);
 130   }
 131
 132   /**
 133    * Returns a printable string representation of this result.
 134    *
 135    * @return A printable string representation of this result.
 136    */
 137   public String toString()
 138   {
 139     return "[ Trust Anchor=" + trustAnchor + "; Policy Tree="
 140       + policyTree + "; Subject Public Key=" + subjectPublicKey + " ]";
 141   }
 142 }