jdk/src/share/classes/java/security/cert/PKIXCertPathBuilderResult.java
author juh
Tue, 25 Jun 2013 14:31:29 -0700
changeset 18551 882a3948c6e6
parent 5506 202f599c92aa
child 24969 afa6934dd8e8
permissions -rw-r--r--
8017325: Cleanup of the javadoc <code> tag in java.security.cert Summary: Convert javadoc <code>...</code> and <tt>...</tt> tags to {@code ...} Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     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
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.security.cert;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.security.PublicKey;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * This class represents the successful result of the PKIX certification
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * path builder algorithm. All certification paths that are built and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * returned using this algorithm are also validated according to the PKIX
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * certification path validation algorithm.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * objects implementing the PKIX algorithm.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * certification path constructed by the build algorithm, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * authority (CA) that served as a trust anchor for the certification path.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * <b>Concurrent Access</b>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * Unless otherwise specified, the methods defined in this class are not
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * thread-safe. Multiple threads that need to access a single
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * object concurrently should synchronize amongst themselves and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * provide the necessary locking. Multiple threads each manipulating
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * separate objects need not synchronize.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * @see CertPathBuilderResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 * @since       1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @author      Anne Anderson
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
public class PKIXCertPathBuilderResult extends PKIXCertPathValidatorResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    implements CertPathBuilderResult {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    private CertPath certPath;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * containing the specified parameters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * if there are no valid policies
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    public PKIXCertPathBuilderResult(CertPath certPath,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
        TrustAnchor trustAnchor, PolicyNode policyTree,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
        PublicKey subjectPublicKey)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
        super(trustAnchor, policyTree, subjectPublicKey);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
        if (certPath == null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
            throw new NullPointerException("certPath must be non-null");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
        this.certPath = certPath;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * for the certification path.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
    public CertPath getCertPath() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
        return certPath;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   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
90ce3da70b43 Initial load
duke
parents:
diff changeset
   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
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
    public String toString() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
        StringBuffer sb = new StringBuffer();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
        sb.append("PKIXCertPathBuilderResult: [\n");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
        sb.append("  Certification Path: " + certPath + "\n");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
        sb.append("  Trust Anchor: " + getTrustAnchor().toString() + "\n");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
        sb.append("  Policy Tree: " + String.valueOf(getPolicyTree()) + "\n");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
        sb.append("  Subject Public Key: " + getPublicKey() + "\n");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
        sb.append("]");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
        return sb.toString();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
}