gomp-20050608-branch/libjava/classpath/javax/net/ssl/KeyManagerFactorySpi.java

   1 /* KeyManagerFactorySpi.java -- SPI for key manager factories.
   2    Copyright (C) 2004 Free Software Foundation, Inc.
   3
   4 This file is 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, or (at your option)
   9 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; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 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.InvalidAlgorithmParameterException;
  42 import java.security.KeyStore;
  43 import java.security.KeyStoreException;
  44 import java.security.NoSuchAlgorithmException;
  45 import java.security.UnrecoverableKeyException;
  46
  47 /**
  48  * The <i>Service Provider Interface</i> (<b>SPI</b>) for key manager
  49  * factories.
  50  *
  51  * @author Casey Marshall (rsdio@metastatic.org)
  52  */
  53 public abstract class KeyManagerFactorySpi
  54 {
  55
  56   // Constructor.
  57   // ------------------------------------------------------------------
  58
  59   public KeyManagerFactorySpi()
  60   {
  61     super();
  62   }
  63
  64   // Abstract methods.
  65   // ------------------------------------------------------------------
  66
  67   /**
  68    * Engine method for retrieving this factory's key managers.
  69    *
  70    * @return The key managers.
  71    */
  72   protected abstract KeyManager[] engineGetKeyManagers();
  73
  74   /**
  75    * Engine method for initializing this factory with some
  76    * algorithm-specific parameters.
  77    *
  78    * @param params The factory parameters.
  79    * @throws InvalidAlgorithmParameterException If the supplied parameters
  80    *   are inappropriate for this instance.
  81    */
  82   protected abstract void engineInit(ManagerFactoryParameters params)
  83     throws InvalidAlgorithmParameterException;
  84
  85   /**
  86    * Engine method for initializing this factory with a key store and a
  87    * password for private keys. Either parameter may be <code>null</code>,
  88    * in which case some default parameters (possibly derived from system
  89    * properties) should be used.
  90    *
  91    * @param store The key store.
  92    * @param passwd The private key password.
  93    * @throws KeyStoreException If the key store cannot be accessed.
  94    * @throws NoSuchAlgorithmException If some of the data from the key
  95    *   store cannot be retrieved.
  96    * @throws UnrecoverableKeyException If a private key cannot be retrieved,
  97    *   likely from a wrong password.
  98    */
  99   protected abstract void engineInit(KeyStore store, char[] passwd)
 100     throws KeyStoreException, NoSuchAlgorithmException,
 101            UnrecoverableKeyException;
 102 }