001/* PKIXCertPathValidatorResult.java -- PKIX cert path builder result
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.security.PublicKey;
042
043/**
044 * Results returned by the {@link
045 * CertPathValidator#validate(java.security.cert.CertPath,java.security.cert.CertPathParameters)}
046 * method for PKIX {@link CertPathValidator}s.
047 *
048 * @see CertPathValidator
049 */
050public class PKIXCertPathValidatorResult implements CertPathValidatorResult
051{
052
053  // Fields.
054  // ------------------------------------------------------------------------
055
056  /** The trust anchor. */
057  private final TrustAnchor trustAnchor;
058
059  /** The root node of the policy tree. */
060  private final PolicyNode policyTree;
061
062  /** The subject's public key. */
063  private final PublicKey subjectPublicKey;
064
065  // Constructor.
066  // ------------------------------------------------------------------------
067
068  /**
069   * Creates a new PKIXCertPathValidatorResult.
070   *
071   * @param trustAnchor      The trust anchor.
072   * @param policyTree       The root node of the policy tree.
073   * @param subjectPublicKey The public key.
074   * @throws NullPointerException If either <i>trustAnchor</i> or
075   *         <i>subjectPublicKey</i> is null.
076   */
077  public PKIXCertPathValidatorResult(TrustAnchor trustAnchor,
078                                     PolicyNode policyTree,
079                                     PublicKey subjectPublicKey)
080  {
081    if (trustAnchor == null || subjectPublicKey == null)
082      throw new NullPointerException();
083    this.trustAnchor = trustAnchor;
084    this.policyTree = policyTree;
085    this.subjectPublicKey = subjectPublicKey;
086  }
087
088  // Instance methods.
089  // ------------------------------------------------------------------------
090
091  /**
092   * Returns the trust anchor.
093   *
094   * @return The trust anchor.
095   */
096  public TrustAnchor getTrustAnchor()
097  {
098    return trustAnchor;
099  }
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}