Class KeyPairGeneratorSpi

java.lang.Object
java.security.KeyPairGeneratorSpi
Direct Known Subclasses:
KeyPairGenerator
public abstract class KeyPairGeneratorSpi extends Object

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. See the Keysize Restriction sections of the JDK Providers document for information on the KeyPairGenerator defaults used by JDK providers. However, note that defaults may vary across different providers. Additionally, the default value for a provider may change in a future version. Therefore, it is recommended to explicitly initialize the KeyPairGenerator instead of relying on provider-specific defaults.

Since:
1.2
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyPairGeneratorSpi()
    Constructor for subclasses to call.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract KeyPair
    generateKeyPair()
    Generates a key pair.
    abstract void
    initialize(int keysize, SecureRandom random)
    Initializes the key pair generator for a certain keysize, using the default parameter set.
    void
    initialize(AlgorithmParameterSpec params, SecureRandom random)
    Initializes the key pair generator using the specified parameter set and user-provided source of randomness.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • KeyPairGeneratorSpi

      public KeyPairGeneratorSpi()
      Constructor for subclasses to call.

  • Method Details

    • initialize

      public abstract void initialize(int keysize, SecureRandom random)
      Initializes the key pair generator for a certain keysize, using the default parameter set.
      Parameters:
      keysize - the keysize. This is an algorithm-specific metric, such as modulus length, specified in number of bits.
      random - the source of randomness for this generator.
      Throws:
      InvalidParameterException - if the keysize is not supported by this KeyPairGeneratorSpi object.

    • initialize

      public void initialize(AlgorithmParameterSpec params, SecureRandom random) throws InvalidAlgorithmParameterException
      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 - the parameter set used to generate the keys.
      random - the source of randomness for this generator.
      Throws:
      InvalidAlgorithmParameterException - if the given parameters are inappropriate for this key pair generator.
      Since:
      1.2

    • generateKeyPair

      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:
      the newly generated KeyPair