Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Ctors](https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#pubctors) \| [Protected Methods](https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#promethods) \| [Inherited Methods](https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#inhmethods)

# KeyGeneratorSpi

` public abstract class KeyGeneratorSpi `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | javax.crypto.KeyGeneratorSpi |

<br />

*** ** * ** ***

This class defines the *Service Provider Interface* (**SPI** ) for the `KeyGenerator` class. All the abstract methods in this class must be implemented by each cryptographic service provider who wishes to supply the implementation of a key generator for a particular algorithm.
**See also:**

- `https://developer.android.com/reference/javax/crypto/SecretKey`

## Summary

| ### Public constructors ||
|---|---|
| ` https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#KeyGeneratorSpi()() ` |

| ### Protected methods ||
|---|---|
| ` abstract https://developer.android.com/reference/javax/crypto/SecretKey` | ` https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#engineGenerateKey()() ` Generates a secret key. |
| ` abstract void` | ` https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#engineInit(java.security.spec.AlgorithmParameterSpec,%20java.security.SecureRandom)(https://developer.android.com/reference/java/security/spec/AlgorithmParameterSpec params, https://developer.android.com/reference/java/security/SecureRandom random) ` Initializes the key generator with the specified parameter set and a user-provided source of randomness. |
| ` abstract void` | ` https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#engineInit(java.security.SecureRandom)(https://developer.android.com/reference/java/security/SecureRandom random) ` Initializes the key generator. |
| ` abstract void` | ` https://developer.android.com/reference/javax/crypto/KeyGeneratorSpi#engineInit(int,%20java.security.SecureRandom)(int keysize, https://developer.android.com/reference/java/security/SecureRandom random) ` Initializes this key generator for a certain keysize, using the given source of randomness. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(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` ` https://developer.android.com/reference/java/lang/Object#wait(long)(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` ` https://developer.android.com/reference/java/lang/Object#wait()() `

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

## Public constructors

### KeyGeneratorSpi

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public KeyGeneratorSpi ()
```

<br />

<br />

## Protected methods

### engineGenerateKey

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected abstract SecretKey engineGenerateKey ()
```

Generates a secret key.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/javax/crypto/SecretKey` | the new key <br /> |

### engineInit

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected abstract void engineInit (AlgorithmParameterSpec params, 
                SecureRandom random)
```

Initializes the key generator with the specified parameter set and a user-provided source of randomness.

<br />

| Parameters ||
|---|---|
| `params` | `AlgorithmParameterSpec`: the key generation parameters <br /> |
| `random` | `SecureRandom`: the source of randomness for this key generator <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/security/InvalidAlgorithmParameterException` | if `params` is inappropriate for this key generator |

### engineInit

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected abstract void engineInit (SecureRandom random)
```

Initializes the key generator.

<br />

| Parameters ||
|---|---|
| `random` | `SecureRandom`: the source of randomness for this generator <br /> |

### engineInit

Added in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
protected abstract void engineInit (int keysize, 
                SecureRandom random)
```

Initializes this key generator for a certain keysize, using the given source of randomness.

<br />

| Parameters ||
|---|---|
| `keysize` | `int`: the keysize. This is an algorithm-specific metric, specified in number of bits. <br /> |
| `random` | `SecureRandom`: the source of randomness for this key generator <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/security/InvalidParameterException` | if the keysize is wrong or not supported. |