• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2000, 2013, 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 
26 package java.security.cert;
27 
28 /**
29  * A specification of the result of a certification path builder algorithm.
30  * All results returned by the {@link CertPathBuilder#build
31  * CertPathBuilder.build} method must implement this interface.
32  * <p>
33  * At a minimum, a {@code CertPathBuilderResult} contains the
34  * {@code CertPath} built by the {@code CertPathBuilder} instance.
35  * Implementations of this interface may add methods to return implementation
36  * or algorithm specific information, such as debugging information or
37  * certification path validation results.
38  * <p>
39  * <b>Concurrent Access</b>
40  * <p>
41  * Unless otherwise specified, the methods defined in this interface are not
42  * thread-safe. Multiple threads that need to access a single
43  * object concurrently should synchronize amongst themselves and
44  * provide the necessary locking. Multiple threads each manipulating
45  * separate objects need not synchronize.
46  *
47  * @see CertPathBuilder
48  *
49  * @since       1.4
50  * @author      Sean Mullan
51  */
52 public interface CertPathBuilderResult extends Cloneable {
53 
54     /**
55      * Returns the built certification path.
56      *
57      * @return the certification path (never {@code null})
58      */
getCertPath()59     CertPath getCertPath();
60 
61     /**
62      * Makes a copy of this {@code CertPathBuilderResult}. Changes to the
63      * copy will not affect the original and vice versa.
64      *
65      * @return a copy of this {@code CertPathBuilderResult}
66      */
clone()67     Object clone();
68 }
69