Source for javax.net.ssl.X509ExtendedKeyManager

   1: /* X509ExtendedKeyManager.java -- 
   2:    Copyright (C) 2006  Free Software Foundation, Inc.
   3: 
   4: This file is a part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2 of the License, or (at
   9: your option) any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; if not, write to the Free Software
  18: Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19: USA
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version.  */
  37: 
  38: 
  39: package javax.net.ssl;
  40: 
  41: import java.security.Principal;
  42: 
  43: /**
  44:  * An extended {@link X509KeyManager} for use with {@link SSLEngine}.
  45:  *
  46:  * @since 1.5
  47:  * @author Casey Marshall (csm@gnu.org)
  48:  */
  49: public abstract class X509ExtendedKeyManager implements X509KeyManager
  50: {
  51: 
  52:   /**
  53:    * Default constructor.
  54:    */
  55:   protected X509ExtendedKeyManager ()
  56:   {
  57:   }
  58: 
  59:   /**
  60:    * Return a client alias given a list of key types, a list of
  61:    * allowable issuers, and the SSLEngine being used.
  62:    *
  63:    * <p>This implementation always returns <code>null</code>.
  64:    *
  65:    * @param keyTypes The list of desired key types.
  66:    * @param issuers The list of desired key issuers.
  67:    * @param engine This client's SSLEngine.
  68:    * @return A key alias that matches the given parameters, or
  69:    * <code>null</code> if the parameters were not matched.
  70:    */
  71:   public String chooseEngineClientAlias (final String[] keyTypes,
  72:                                          final Principal[] issuers,
  73:                                          final SSLEngine engine)
  74:   {
  75:     return null;
  76:   }
  77: 
  78:   /**
  79:    * Return a server alias given a key type, a list of allowable
  80:    * issuers, and the SSLEngine being used.
  81:    *
  82:    * <p>This implementation always returns <code>null</code>.
  83:    *
  84:    * @param keyType The desired key type.
  85:    * @param issuers The list of desired key issuers.
  86:    * @param engine The server's SSLEngine.
  87:    * @return A key alias that matches the given parameters, or
  88:    * <code>null</code> if the parameters were not matched.
  89:    */
  90:   public String chooseEngineServerAlias (final String keyType,
  91:                                          final Principal[] issuers,
  92:                                          final SSLEngine engine)
  93:   {
  94:     return null;
  95:   }
  96: }