1/*
2 * Copyright (c) 2012, Oracle and/or its affiliates. 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.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 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.
24 */
25
26package java.security.cert;
27
28/**
29 * <p>Performs one or more checks on each {@code Certificate} of a
30 * {@code CertPath}.
31 *
32 * <p>A {@code CertPathChecker} implementation is typically created to extend
33 * a certification path validation algorithm. For example, an implementation
34 * may check for and process a critical private extension of each certificate
35 * in a certification path.
36 *
37 * @since 1.8
38 */
39public interface CertPathChecker {
40
41    /**
42     * Initializes the internal state of this {@code CertPathChecker}.
43     *
44     * <p>The {@code forward} flag specifies the order that certificates will
45     * be passed to the {@link #check check} method (forward or reverse).
46     *
47     * @param forward the order that certificates are presented to the
48     *        {@code check} method. If {@code true}, certificates are
49     *        presented from target to trust anchor (forward); if
50     *        {@code false}, from trust anchor to target (reverse).
51     * @throws CertPathValidatorException if this {@code CertPathChecker} is
52     *         unable to check certificates in the specified order
53     */
54    void init(boolean forward) throws CertPathValidatorException;
55
56    /**
57     * Indicates if forward checking is supported. Forward checking refers
58     * to the ability of the {@code CertPathChecker} to perform its checks
59     * when certificates are presented to the {@code check} method in the
60     * forward direction (from target to trust anchor).
61     *
62     * @return {@code true} if forward checking is supported, {@code false}
63     *         otherwise
64     */
65    boolean isForwardCheckingSupported();
66
67    /**
68     * Performs the check(s) on the specified certificate using its internal
69     * state. The certificates are presented in the order specified by the
70     * {@code init} method.
71     *
72     * @param cert the {@code Certificate} to be checked
73     * @throws CertPathValidatorException if the specified certificate does
74     *         not pass the check
75     */
76    void check(Certificate cert) throws CertPathValidatorException;
77}
78