javax.crypto

Class KeyGeneratorSpi

Known Direct Subclasses:
SecretKeyGeneratorImpl

public abstract class KeyGeneratorSpi
extends Object

The Service Provider Interface (SPI) for the KeyGenerator class.

Providers wishing to implement a key generator must subclass this and provide an appropriate implementation for all the abstract methods below, and provide an appropriate entry in the master Provider class (the service name for key generators is "KeyGenerator").

Since:
1.4
See Also:
KeyGenerator

Constructor Summary

KeyGeneratorSpi()
Create a new key generator SPI.

Method Summary

protected abstract SecretKey
engineGenerateKey()
Generate a key, returning it as a SecretKey.
protected abstract void
engineInit(int keySize, SecureRandom random)
Initialize this key generator with a key size (in bits) and a source of randomness.
protected abstract void
engineInit(SecureRandom random)
Initialize this key generator with a source of randomness; the implementation should use reasonable default parameters (such as generated key size).
protected abstract void
engineInit(AlgorithmParameterSpec params, SecureRandom random)
Initialize this key generator with parameters and a source of randomness.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

KeyGeneratorSpi

public KeyGeneratorSpi()
Create a new key generator SPI.

Method Details

engineGenerateKey

protected abstract SecretKey engineGenerateKey()
Generate a key, returning it as a SecretKey.
Returns:
The generated key.

engineInit

protected abstract void engineInit(int keySize,
                                   SecureRandom random)
Initialize this key generator with a key size (in bits) and a source of randomness.
Parameters:
keySize - The target key size, in bits.
random - The source of randomness.
Throws:
InvalidParameterException - If the key size is illogical or unsupported.

engineInit

protected abstract void engineInit(SecureRandom random)
Initialize this key generator with a source of randomness; the implementation should use reasonable default parameters (such as generated key size).
Parameters:
random - The source of randomness.

engineInit

protected abstract void engineInit(AlgorithmParameterSpec params,
                                   SecureRandom random)
            throws InvalidAlgorithmParameterException
Initialize this key generator with parameters and a source of randomness.
Parameters:
params - The parameters.
random - The source of randomness.
Throws:
InvalidAlgorithmParameterException - If the parameters are inappropriate for this instance.

KeyGeneratorSpi.java -- The key generator service provider interface. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.