toolchain/gcc/libjava/java/security/KeyPairGeneratorSpi.java

   1 /* KeyPairGeneratorSpi.java --- Key Pair Generator SPI Class
   2    Copyright (C) 1999, 2002 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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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 package java.security;
  39 import java.security.spec.AlgorithmParameterSpec;
  40
  41 /**
  42    KeyPairGeneratorSpi is the interface used to generate key pairs
  43    for security algorithms.
  44
  45    @author Mark Benvenuto
  46  */
  47 public abstract class KeyPairGeneratorSpi
  48 {
  49   /**
  50      Constructs a new KeyPairGeneratorSpi
  51    */
  52   public KeyPairGeneratorSpi()
  53   {
  54   }
  55
  56   /**
  57      Initialize the KeyPairGeneratorSpi with the specified
  58      key size and source of randomness
  59
  60      @param keysize size of the key to generate
  61      @param random A SecureRandom source of randomness
  62    */
  63   public abstract void initialize(int keysize, SecureRandom random);
  64
  65   /**
  66      Initialize the KeyPairGeneratorSpi with the specified
  67      AlgorithmParameterSpec and source of randomness
  68
  69      This is a concrete method. It may be overridden by the provider
  70      and if the AlgorithmParameterSpec class is invalid
  71      throw InvalidAlgorithmParameterException. By default this
  72      method just throws UnsupportedOperationException.
  73
  74      @param params A AlgorithmParameterSpec to intialize with
  75      @param random A SecureRandom source of randomness
  76
  77      @throws InvalidAlgorithmParameterException
  78    */
  79   public void initialize(AlgorithmParameterSpec params, SecureRandom random)
  80     throws InvalidAlgorithmParameterException
  81   {
  82     throw new java.lang.UnsupportedOperationException();
  83   }
  84
  85   /**
  86      Generates a KeyPair according the rules for the algorithm.
  87      Unless intialized, algorithm defaults will be used. It
  88      creates a unique key pair each time.
  89
  90      @return a key pair
  91    */
  92   public abstract KeyPair generateKeyPair();
  93
  94   /**
  95      Returns a clone of this class.
  96
  97      If cloning is not supported, then by default the class throws a
  98      CloneNotSupportedException.  The MessageDigestSpi provider
  99      implementation has to overload this class in order to be
 100      cloneable.
 101    */
 102   public Object clone() throws CloneNotSupportedException
 103   {
 104     if (this instanceof Cloneable)
 105       return super.clone();
 106     else
 107       throw new CloneNotSupportedException();
 108   }
 109 }