001/* KeyManagerFactorySpi.java -- SPI for key manager factories.
002   Copyright (C) 2004 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.net.ssl;
040
041import java.security.InvalidAlgorithmParameterException;
042import java.security.KeyStore;
043import java.security.KeyStoreException;
044import java.security.NoSuchAlgorithmException;
045import java.security.UnrecoverableKeyException;
046
047/**
048 * The <i>Service Provider Interface</i> (<b>SPI</b>) for key manager
049 * factories.
050 *
051 * @author Casey Marshall (rsdio@metastatic.org)
052 */
053public abstract class KeyManagerFactorySpi
054{
055
056  // Constructor.
057  // ------------------------------------------------------------------
058
059  public KeyManagerFactorySpi()
060  {
061    super();
062  }
063
064  // Abstract methods.
065  // ------------------------------------------------------------------
066
067  /**
068   * Engine method for retrieving this factory's key managers.
069   *
070   * @return The key managers.
071   */
072  protected abstract KeyManager[] engineGetKeyManagers();
073
074  /**
075   * Engine method for initializing this factory with some
076   * algorithm-specific parameters.
077   *
078   * @param params The factory parameters.
079   * @throws InvalidAlgorithmParameterException If the supplied parameters
080   *   are inappropriate for this instance.
081   */
082  protected abstract void engineInit(ManagerFactoryParameters params)
083    throws InvalidAlgorithmParameterException;
084
085  /**
086   * Engine method for initializing this factory with a key store and a
087   * password for private keys. Either parameter may be <code>null</code>,
088   * in which case some default parameters (possibly derived from system
089   * properties) should be used.
090   *
091   * @param store The key store.
092   * @param passwd The private key password.
093   * @throws KeyStoreException If the key store cannot be accessed.
094   * @throws NoSuchAlgorithmException If some of the data from the key
095   *   store cannot be retrieved.
096   * @throws UnrecoverableKeyException If a private key cannot be retrieved,
097   *   likely from a wrong password.
098   */
099  protected abstract void engineInit(KeyStore store, char[] passwd)
100    throws KeyStoreException, NoSuchAlgorithmException,
101           UnrecoverableKeyException;
102}