1 /*
2 * Copyright 2000-2001 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.security.cert;
27
28 import java.security.PublicKey;
29
30 /**
31 * This class represents the successful result of the PKIX certification
32 * path builder algorithm. All certification paths that are built and
33 * returned using this algorithm are also validated according to the PKIX
34 * certification path validation algorithm.
35 *
36 * <p>Instances of <code>PKIXCertPathBuilderResult</code> are returned by
37 * the <code>build</code> method of <code>CertPathBuilder</code>
38 * objects implementing the PKIX algorithm.
39 *
40 * <p>All <code>PKIXCertPathBuilderResult</code> objects contain the
41 * certification path constructed by the build algorithm, the
42 * valid policy tree and subject public key resulting from the build
43 * algorithm, and a <code>TrustAnchor</code> describing the certification
44 * authority (CA) that served as a trust anchor for the certification path.
45 * <p>
46 * <b>Concurrent Access</b>
47 * <p>
48 * Unless otherwise specified, the methods defined in this class are not
49 * thread-safe. Multiple threads that need to access a single
50 * object concurrently should synchronize amongst themselves and
51 * provide the necessary locking. Multiple threads each manipulating
52 * separate objects need not synchronize.
53 *
54 * @see CertPathBuilderResult
55 *
56 * @since 1.4
57 * @author Anne Anderson
58 */
59 public class PKIXCertPathBuilderResult extends PKIXCertPathValidatorResult
60 implements CertPathBuilderResult {
61
62 private CertPath certPath;
63
64 /**
65 * Creates an instance of <code>PKIXCertPathBuilderResult</code>
66 * containing the specified parameters.
67 *
68 * @param certPath the validated <code>CertPath</code>
69 * @param trustAnchor a <code>TrustAnchor</code> describing the CA that
70 * served as a trust anchor for the certification path
71 * @param policyTree the immutable valid policy tree, or <code>null</code>
72 * if there are no valid policies
73 * @param subjectPublicKey the public key of the subject
74 * @throws NullPointerException if the <code>certPath</code>,
75 * <code>trustAnchor</code> or <code>subjectPublicKey</code> parameters
76 * are <code>null</code>
77 */
78 public PKIXCertPathBuilderResult(CertPath certPath,
79 TrustAnchor trustAnchor, PolicyNode policyTree,
80 PublicKey subjectPublicKey)
81 {
82 super(trustAnchor, policyTree, subjectPublicKey);
83 if (certPath == null)
84 throw new NullPointerException("certPath must be non-null");
85 this.certPath = certPath;
86 }
87
88 /**
89 * Returns the built and validated certification path. The
90 * <code>CertPath</code> object does not include the trust anchor.
91 * Instead, use the {@link #getTrustAnchor() getTrustAnchor()} method to
92 * obtain the <code>TrustAnchor</code> that served as the trust anchor
93 * for the certification path.
94 *
95 * @return the built and validated <code>CertPath</code> (never
96 * <code>null</code>)
97 */
98 public CertPath getCertPath() {
99 return certPath;
100 }
101
102 /**
103 * Return a printable representation of this
104 * <code>PKIXCertPathBuilderResult</code>.
105 *
106 * @return a <code>String</code> describing the contents of this
107 * <code>PKIXCertPathBuilderResult</code>
108 */
109 public String toString() {
110 StringBuffer sb = new StringBuffer();
111 sb.append("PKIXCertPathBuilderResult: [\n");
112 sb.append(" Certification Path: " + certPath + "\n");
113 sb.append(" Trust Anchor: " + getTrustAnchor().toString() + "\n");
114 sb.append(" Policy Tree: " + String.valueOf(getPolicyTree()) + "\n");
115 sb.append(" Subject Public Key: " + getPublicKey() + "\n");
116 sb.append("]");
117 return sb.toString();
118 }
119 }
Save This Page