author | juh |
Mon, 09 Sep 2013 10:52:56 -0700 | |
changeset 19828 | b4f91bc595fe |
parent 18551 | 882a3948c6e6 |
permissions | -rw-r--r-- |
2 | 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 | 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.InvalidAlgorithmParameterException; |
|
29 |
||
30 |
/** |
|
31 |
* |
|
32 |
* The <i>Service Provider Interface</i> (<b>SPI</b>) |
|
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 | 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 | 38 |
* For details, see the Java Cryptography Architecture. |
39 |
* <p> |
|
40 |
* <b>Concurrent Access</b> |
|
41 |
* <p> |
|
42 |
* Instances of this class need not be protected against concurrent |
|
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 | 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 | 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 | 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 | 51 |
* synchronize. |
52 |
* |
|
53 |
* @since 1.4 |
|
54 |
* @author Yassir Elley |
|
55 |
*/ |
|
56 |
public abstract class CertPathValidatorSpi { |
|
57 |
||
58 |
/** |
|
59 |
* The default constructor. |
|
60 |
*/ |
|
61 |
public CertPathValidatorSpi() {} |
|
62 |
||
63 |
/** |
|
64 |
* Validates the specified certification path using the specified |
|
65 |
* algorithm parameter set. |
|
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 | 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 | 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 | 74 |
* @param params the algorithm parameters |
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 | 77 |
* does not validate |
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 | 81 |
*/ |
82 |
public abstract CertPathValidatorResult |
|
83 |
engineValidate(CertPath certPath, CertPathParameters params) |
|
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 |
* |
19828 | 100 |
* @return a {@code CertPathChecker} that this implementation uses to |
101 |
* check the revocation status of certificates |
|
12860
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
102 |
* @throws UnsupportedOperationException if this method is not supported |
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
103 |
* @since 1.8 |
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
104 |
*/ |
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
105 |
public CertPathChecker engineGetRevocationChecker() { |
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
106 |
throw new UnsupportedOperationException(); |
9ffbd4e43413
6854712: Revocation checking enhancements (JEP-124)
mullan
parents:
5506
diff
changeset
|
107 |
} |
2 | 108 |
} |