001/* AlgorithmParameterGeneratorSpi.java --- Algorithm Parameter Generator SPI
002   Copyright (C) 1999 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   AlgorithmParameterGeneratorSpi is the Service Provider
043   Interface for the AlgorithmParameterGenerator class.
044   This class is used to generate the algorithm parameters
045   for a specific algorithm.
046
047   @since JDK 1.2
048   @author Mark Benvenuto
049 */
050public abstract class AlgorithmParameterGeneratorSpi
051{
052
053  /**
054     Constructs a new AlgorithmParameterGeneratorSpi
055   */
056  public AlgorithmParameterGeneratorSpi()
057  {
058  }
059
060  /**
061     Initializes the parameter generator with the specified size
062     and SecureRandom
063
064     @param size the size( in number of bits)
065     @param random the SecureRandom class to use for randomness
066   */
067  protected abstract void engineInit(int size, SecureRandom random);
068
069  /**
070     Initializes the parameter generator with the specified
071     AlgorithmParameterSpec and SecureRandom classes.
072
073     If genParamSpec is an invalid AlgorithmParameterSpec for this
074     AlgorithmParameterGeneratorSpi then it throws
075     InvalidAlgorithmParameterException
076
077     @param genParamSpec the AlgorithmParameterSpec class to use
078     @param random the SecureRandom class to use for randomness
079
080     @throws InvalidAlgorithmParameterException genParamSpec is invalid
081   */
082  protected abstract void engineInit(AlgorithmParameterSpec genParamSpec,
083                                     SecureRandom random) throws
084    InvalidAlgorithmParameterException;
085
086
087  /**
088     Generate a new set of AlgorithmParameters.
089
090     @returns a new set of algorithm parameters
091   */
092  protected abstract AlgorithmParameters engineGenerateParameters();
093
094}