1/*
2 *  Licensed to the Apache Software Foundation (ASF) under one or more
3 *  contributor license agreements.  See the NOTICE file distributed with
4 *  this work for additional information regarding copyright ownership.
5 *  The ASF licenses this file to You under the Apache License, Version 2.0
6 *  (the "License"); you may not use this file except in compliance with
7 *  the License.  You may obtain a copy of the License at
8 *
9 *     http://www.apache.org/licenses/LICENSE-2.0
10 *
11 *  Unless required by applicable law or agreed to in writing, software
12 *  distributed under the License is distributed on an "AS IS" BASIS,
13 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 *  See the License for the specific language governing permissions and
15 *  limitations under the License.
16 */
17
18package javax.net.ssl;
19
20import java.security.Principal;
21
22/**
23 * The abstract extension for the {@code X509KeyManager} interface.
24 */
25public abstract class X509ExtendedKeyManager implements X509KeyManager {
26
27    /**
28     * To be used by subclasses only.
29     * <p>
30     * Creates a new {@code X509ExtendedKeyManager} instance.
31     */
32    protected X509ExtendedKeyManager() {
33    }
34
35    /**
36     * Chooses an alias for the client side of an SSL connection to authenticate
37     * it with the specified public key type and certificate issuers.
38     *
39     * @param keyType
40     *            the list of public key algorithm names.
41     * @param issuers
42     *            the list of certificate issuers, or {@code null} if any issuer
43     *            will do.
44     * @param engine
45     *            the {@code SSLEngine} for the connection, or {@code null} if
46     *            no engine is predefined.
47     * @return the alias name of a matching key or {@code null} if there are no
48     *         matches.
49     */
50    public String chooseEngineClientAlias(String[] keyType,
51            Principal[] issuers, SSLEngine engine) {
52        return null;
53    }
54
55    /**
56     * Chooses an alias for the server side of an SSL connection to authenticate
57     * it with the specified public key type and certificate issuers.
58     *
59     * @param keyType
60     *            the list of public key algorithm names.
61     * @param issuers
62     *            the list of certificate issuers, or {@code null} if any issuer
63     *            will do.
64     * @param engine
65     *            the {@code SSLEngine} for the connection, or {@code null} if
66     *            no engine is predefined.
67     * @return the alias name of a matching key or {@code null} if there are no
68     *         matches.
69     */
70    public String chooseEngineServerAlias(String keyType, Principal[] issuers,
71            SSLEngine engine) {
72        return null;
73    }
74
75}
76