001/* KeyPairGeneratorSpi.java --- Key Pair Generator SPI Class
002   Copyright (C) 1999, 2002 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
038package java.security;
039import java.security.spec.AlgorithmParameterSpec;
040
041/**
042   KeyPairGeneratorSpi is the interface used to generate key pairs
043   for security algorithms.
044
045   @author Mark Benvenuto
046 */
047public abstract class KeyPairGeneratorSpi
048{
049  /**
050     Constructs a new KeyPairGeneratorSpi
051   */
052  public KeyPairGeneratorSpi()
053  {
054  }
055
056  /**
057     Initialize the KeyPairGeneratorSpi with the specified
058     key size and source of randomness
059
060     @param keysize size of the key to generate
061     @param random A SecureRandom source of randomness  
062   */
063  public abstract void initialize(int keysize, SecureRandom random);
064
065  /**
066     Initialize the KeyPairGeneratorSpi with the specified
067     AlgorithmParameterSpec and source of randomness
068
069     This is a concrete method. It may be overridden by the provider
070     and if the AlgorithmParameterSpec class is invalid
071     throw InvalidAlgorithmParameterException. By default this
072     method just throws UnsupportedOperationException.
073
074     @param params A AlgorithmParameterSpec to intialize with
075     @param random A SecureRandom source of randomness  
076
077     @throws InvalidAlgorithmParameterException
078   */
079  public void initialize(AlgorithmParameterSpec params, SecureRandom random)
080    throws InvalidAlgorithmParameterException
081  {
082    throw new java.lang.UnsupportedOperationException();
083  }
084
085  /**
086     Generates a KeyPair according the rules for the algorithm.
087     Unless intialized, algorithm defaults will be used. It 
088     creates a unique key pair each time.
089
090     @return a key pair
091   */
092  public abstract KeyPair generateKeyPair();
093
094  /**
095   * We override clone here to make it accessible for use by
096   * DummyKeyPairGenerator.
097   */
098  protected Object clone() throws CloneNotSupportedException
099  {
100    return super.clone();
101  }
102}