01 /*
02 * Copyright 1997-1999 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.security;
27
28 import java.security.spec.AlgorithmParameterSpec;
29
30 /**
31 * This class defines the <i>Service Provider Interface</i> (<b>SPI</b>)
32 * for the <code>AlgorithmParameterGenerator</code> class, which
33 * is used to generate a set of parameters to be used with a certain algorithm.
34 *
35 * <p> All the abstract methods in this class must be implemented by each
36 * cryptographic service provider who wishes to supply the implementation
37 * of a parameter generator for a particular algorithm.
38 *
39 * <p> In case the client does not explicitly initialize the
40 * AlgorithmParameterGenerator (via a call to an <code>engineInit</code>
41 * method), each provider must supply (and document) a default initialization.
42 * For example, the Sun provider uses a default modulus prime size of 1024
43 * bits for the generation of DSA parameters.
44 *
45 * @author Jan Luehe
46 *
47 * @version 1.21, 05/05/07
48 *
49 * @see AlgorithmParameterGenerator
50 * @see AlgorithmParameters
51 * @see java.security.spec.AlgorithmParameterSpec
52 *
53 * @since 1.2
54 */
55
56 public abstract class AlgorithmParameterGeneratorSpi {
57
58 /**
59 * Initializes this parameter generator for a certain size
60 * and source of randomness.
61 *
62 * @param size the size (number of bits).
63 * @param random the source of randomness.
64 */
65 protected abstract void engineInit(int size, SecureRandom random);
66
67 /**
68 * Initializes this parameter generator with a set of
69 * algorithm-specific parameter generation values.
70 *
71 * @param genParamSpec the set of algorithm-specific parameter generation values.
72 * @param random the source of randomness.
73 *
74 * @exception InvalidAlgorithmParameterException if the given parameter
75 * generation values are inappropriate for this parameter generator.
76 */
77 protected abstract void engineInit(
78 AlgorithmParameterSpec genParamSpec, SecureRandom random)
79 throws InvalidAlgorithmParameterException;
80
81 /**
82 * Generates the parameters.
83 *
84 * @return the new AlgorithmParameters object.
85 */
86 protected abstract AlgorithmParameters engineGenerateParameters();
87 }
|