jdk/src/share/classes/java/security/cert/CertPathValidatorSpi.java
author juh
Tue, 25 Jun 2013 14:31:29 -0700
changeset 18551 882a3948c6e6
parent 12860 9ffbd4e43413
child 19828 b4f91bc595fe
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: 12860
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.InvalidAlgorithmParameterException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * The <i>Service Provider Interface</i> (<b>SPI</b>)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * for the {@link CertPathValidator CertPathValidator} class. All
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    34
 * {@code CertPathValidator} implementations must include a class (the
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    35
 * SPI class) that extends this class ({@code CertPathValidatorSpi})
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * and implements all of its methods. In general, instances of this class
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    37
 * should only be accessed through the {@code CertPathValidator} class.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * For details, see the Java Cryptography Architecture.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <b>Concurrent Access</b>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * Instances of this class need not be protected against concurrent
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * access from multiple threads. Threads that need to access a single
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    44
 * {@code CertPathValidatorSpi} instance concurrently should synchronize
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * amongst themselves and provide the necessary locking before calling the
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    46
 * wrapping {@code CertPathValidator} object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <p>
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    48
 * However, implementations of {@code CertPathValidatorSpi} may still
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * encounter concurrency issues, since multiple threads each
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    50
 * manipulating a different {@code CertPathValidatorSpi} instance need not
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * synchronize.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * @since       1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 * @author      Yassir Elley
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
public abstract class CertPathValidatorSpi {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * The default constructor.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    public CertPathValidatorSpi() {}
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Validates the specified certification path using the specified
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * algorithm parameter set.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * <p>
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    67
     * The {@code CertPath} specified must be of a type that is
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * supported by the validation algorithm, otherwise an
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    69
     * {@code InvalidAlgorithmParameterException} will be thrown. For
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    70
     * example, a {@code CertPathValidator} that implements the PKIX
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    71
     * algorithm validates {@code CertPath} objects of type X.509.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     *
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    73
     * @param certPath the {@code CertPath} to be validated
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     * @param params the algorithm parameters
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
     * @return the result of the validation algorithm
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    76
     * @exception CertPathValidatorException if the {@code CertPath}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     * does not validate
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
     * @exception InvalidAlgorithmParameterException if the specified
18551
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    79
     * parameters or the type of the specified {@code CertPath} are
882a3948c6e6 8017325: Cleanup of the javadoc <code> tag in java.security.cert
juh
parents: 12860
diff changeset
    80
     * inappropriate for this {@code CertPathValidator}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    public abstract CertPathValidatorResult
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
        engineValidate(CertPath certPath, CertPathParameters params)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
        throws CertPathValidatorException, InvalidAlgorithmParameterException;
12860
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    85
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    86
    /**
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    87
     * Returns a {@code CertPathChecker} that this implementation uses to
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    88
     * check the revocation status of certificates. A PKIX implementation
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    89
     * returns objects of type {@code PKIXRevocationChecker}.
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    90
     *
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    91
     * <p>The primary purpose of this method is to allow callers to specify
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    92
     * additional input parameters and options specific to revocation checking.
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    93
     * See the class description of {@code CertPathValidator} for an example.
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    94
     *
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    95
     * <p>This method was added to version 1.8 of the Java Platform Standard
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    96
     * Edition. In order to maintain backwards compatibility with existing
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    97
     * service providers, this method cannot be abstract and by default throws
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    98
     * an {@code UnsupportedOperationException}.
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
    99
     *
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   100
     * @throws UnsupportedOperationException if this method is not supported
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   101
     * @since 1.8
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   102
     */
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   103
    public CertPathChecker engineGetRevocationChecker() {
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   104
        throw new UnsupportedOperationException();
9ffbd4e43413 6854712: Revocation checking enhancements (JEP-124)
mullan
parents: 5506
diff changeset
   105
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
}