libcore/luni/src/main/java/javax/net/ssl/X509ExtendedKeyManager.java

   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
  18 package javax.net.ssl;
  19
  20 import java.security.Principal;
  21
  22 /**
  23  * The abstract extension for the {@code X509KeyManager} interface.
  24  */
  25 public 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         super();
  34     }
  35
  36     /**
  37      * Chooses an alias for the client side of an SSL connection to authenticate
  38      * it with the specified public key type and certificate issuers.
  39      *
  40      * @param keyType
  41      *            the list of public key algorithm names.
  42      * @param issuers
  43      *            the list of certificate issuers, or {@code null} if any issuer
  44      *            will do.
  45      * @param engine
  46      *            the {@code SSLEngine} for the connection, or {@code null} if
  47      *            no engine is predefined.
  48      * @return the alias name of a matching key or {@code null} if there are no
  49      *         matches.
  50      */
  51     public String chooseEngineClientAlias(String[] keyType,
  52             Principal[] issuers, SSLEngine engine) {
  53         return null;
  54     }
  55
  56     /**
  57      * Chooses an alias for the server side of an SSL connection to authenticate
  58      * it with the specified public key type and certificate issuers.
  59      *
  60      * @param keyType
  61      *            the list of public key algorithm names.
  62      * @param issuers
  63      *            the list of certificate issuers, or {@code null} if any issuer
  64      *            will do.
  65      * @param engine
  66      *            the {@code SSLEngine} for the connection, or {@code null} if
  67      *            no engine is predefined.
  68      * @return the alias name of a matching key or {@code null} if there are no
  69      *         matches.
  70      */
  71     public String chooseEngineServerAlias(String keyType, Principal[] issuers,
  72             SSLEngine engine) {
  73         return null;
  74     }
  75
  76 }