Added in API level 1

KeyPairGeneratorSpi

public abstract class KeyPairGeneratorSpi
extends Object

java.lang.Object
   ↳ java.security.KeyPairGeneratorSpi
KeyPairGenerator The KeyPairGenerator class is used to generate pairs of public and private keys. 


This class defines the Service Provider Interface (SPI) for the KeyPairGenerator class, which is used to generate pairs of public and private keys.

All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key pair generator for a particular algorithm.

In case the client does not explicitly initialize the KeyPairGenerator (via a call to an initialize method), each provider must supply (and document) a default initialization. For example, the Sun provider uses a default modulus size (keysize) of 1024 bits.

Summary

Public constructors

KeyPairGeneratorSpi()

Public methods

abstract KeyPair generateKeyPair()

Generates a key pair.

void initialize(AlgorithmParameterSpec params, SecureRandom random)

Initializes the key pair generator using the specified parameter set and user-provided source of randomness.

abstract void initialize(int keysize, SecureRandom random)

Initializes the key pair generator for a certain keysize, using the default parameter set.

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

KeyPairGeneratorSpi

Added in API level 1
public KeyPairGeneratorSpi ()

Public methods

generateKeyPair

Added in API level 1
public abstract KeyPair generateKeyPair ()

Generates a key pair. Unless an initialization method is called using a KeyPairGenerator interface, algorithm-specific defaults will be used. This will generate a new key pair every time it is called.

Returns
KeyPair the newly generated KeyPair

initialize

Added in API level 1
public void initialize (AlgorithmParameterSpec params, 
                SecureRandom random)

Initializes the key pair generator using the specified parameter set and user-provided source of randomness.

This concrete method has been added to this previously-defined abstract class. (For backwards compatibility, it cannot be abstract.) It may be overridden by a provider to initialize the key pair generator. Such an override is expected to throw an InvalidAlgorithmParameterException if a parameter is inappropriate for this key pair generator. If this method is not overridden, it always throws an UnsupportedOperationException.

Parameters
params AlgorithmParameterSpec: the parameter set used to generate the keys.

random SecureRandom: the source of randomness for this generator.

Throws
InvalidAlgorithmParameterException if the given parameters are inappropriate for this key pair generator.

initialize

Added in API level 1
public abstract void initialize (int keysize, 
                SecureRandom random)

Initializes the key pair generator for a certain keysize, using the default parameter set.

Parameters
keysize int: the keysize. This is an algorithm-specific metric, such as modulus length, specified in number of bits.

random SecureRandom: the source of randomness for this generator.

Throws
InvalidParameterException if the keysize is not supported by this KeyPairGeneratorSpi object.

The official site for Android 15. Provides the Android SDK tools and API documentation.

Updated Dec 20, 2024

The official site for Android 15. Provides the Android SDK tools and API documentation.

Updated Mar 21, 2024

Discover the latest app development tools, platform updates, training, and documentation for developers across every Android device.

Updated Feb 16, 2024