001    /* KeyPairGeneratorSpi.java --- Key Pair Generator SPI Class
002       Copyright (C) 1999, 2002 Free Software Foundation, Inc.
003    
004    This file is 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, or (at your option)
009    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; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 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    package java.security;
039    import 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     */
047    public 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    }