001    /* X509ExtendedKeyManager.java -- 
002       Copyright (C) 2006  Free Software Foundation, Inc.
003    
004    This file is a part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2 of the License, or (at
009    your option) any later version.
010    
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; if not, write to the Free Software
018    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
019    USA
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version.  */
037    
038    
039    package javax.net.ssl;
040    
041    import java.security.Principal;
042    
043    /**
044     * An extended {@link X509KeyManager} for use with {@link SSLEngine}.
045     *
046     * @since 1.5
047     * @author Casey Marshall (csm@gnu.org)
048     */
049    public abstract class X509ExtendedKeyManager implements X509KeyManager
050    {
051    
052      /**
053       * Default constructor.
054       */
055      protected X509ExtendedKeyManager ()
056      {
057      }
058    
059      /**
060       * Return a client alias given a list of key types, a list of
061       * allowable issuers, and the SSLEngine being used.
062       *
063       * <p>This implementation always returns <code>null</code>.
064       *
065       * @param keyTypes The list of desired key types.
066       * @param issuers The list of desired key issuers.
067       * @param engine This client's SSLEngine.
068       * @return A key alias that matches the given parameters, or
069       * <code>null</code> if the parameters were not matched.
070       */
071      public String chooseEngineClientAlias (final String[] keyTypes,
072                                             final Principal[] issuers,
073                                             final SSLEngine engine)
074      {
075        return null;
076      }
077    
078      /**
079       * Return a server alias given a key type, a list of allowable
080       * issuers, and the SSLEngine being used.
081       *
082       * <p>This implementation always returns <code>null</code>.
083       *
084       * @param keyType The desired key type.
085       * @param issuers The list of desired key issuers.
086       * @param engine The server's SSLEngine.
087       * @return A key alias that matches the given parameters, or
088       * <code>null</code> if the parameters were not matched.
089       */
090      public String chooseEngineServerAlias (final String keyType,
091                                             final Principal[] issuers,
092                                             final SSLEngine engine)
093      {
094        return null;
095      }
096    }