author | juh |
Tue, 25 Jun 2013 14:31:29 -0700 | |
changeset 18551 | 882a3948c6e6 |
parent 5506 | 202f599c92aa |
child 24969 | afa6934dd8e8 |
permissions | -rw-r--r-- |
2 | 1 |
/* |
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
2 |
* Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. |
2 | 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 |
|
5506 | 7 |
* published by the Free Software Foundation. Oracle designates this |
2 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5506 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
2 | 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 |
* |
|
5506 | 21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
2 | 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 |
* |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
36 |
* <p>Instances of {@code PKIXCertPathBuilderResult} are returned by |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
37 |
* the {@code build} method of {@code CertPathBuilder} |
2 | 38 |
* objects implementing the PKIX algorithm. |
39 |
* |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
40 |
* <p>All {@code PKIXCertPathBuilderResult} objects contain the |
2 | 41 |
* certification path constructed by the build algorithm, the |
42 |
* valid policy tree and subject public key resulting from the build |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
43 |
* algorithm, and a {@code TrustAnchor} describing the certification |
2 | 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 |
/** |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
65 |
* Creates an instance of {@code PKIXCertPathBuilderResult} |
2 | 66 |
* containing the specified parameters. |
67 |
* |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
68 |
* @param certPath the validated {@code CertPath} |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
69 |
* @param trustAnchor a {@code TrustAnchor} describing the CA that |
2 | 70 |
* served as a trust anchor for the certification path |
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
71 |
* @param policyTree the immutable valid policy tree, or {@code null} |
2 | 72 |
* if there are no valid policies |
73 |
* @param subjectPublicKey the public key of the subject |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
74 |
* @throws NullPointerException if the {@code certPath}, |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
75 |
* {@code trustAnchor} or {@code subjectPublicKey} parameters |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
76 |
* are {@code null} |
2 | 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 |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
90 |
* {@code CertPath} object does not include the trust anchor. |
2 | 91 |
* Instead, use the {@link #getTrustAnchor() getTrustAnchor()} method to |
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
92 |
* obtain the {@code TrustAnchor} that served as the trust anchor |
2 | 93 |
* for the certification path. |
94 |
* |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
95 |
* @return the built and validated {@code CertPath} (never |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
96 |
* {@code null}) |
2 | 97 |
*/ |
98 |
public CertPath getCertPath() { |
|
99 |
return certPath; |
|
100 |
} |
|
101 |
||
102 |
/** |
|
103 |
* Return a printable representation of this |
|
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
104 |
* {@code PKIXCertPathBuilderResult}. |
2 | 105 |
* |
18551
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
106 |
* @return a {@code String} describing the contents of this |
882a3948c6e6
8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents:
5506
diff
changeset
|
107 |
* {@code PKIXCertPathBuilderResult} |
2 | 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 |
} |