KeyStoreParameter.Builder

Class Overview

Builder class for KeyStoreParameter objects.

This will build protection parameters for use with the Android KeyStore facility.

This can be used to require that KeyStore entries be stored encrypted.

Example:

KeyStoreParameter params = new KeyStoreParameter.Builder(mContext) .setEncryptionRequired() .build();

Summary

Public Constructors
	KeyStoreParameter.Builder(Context context) Creates a new instance of the `Builder` with the given `context`.

Public Constructors

KeyStoreParameter.Builder(Context context)

Creates a new instance of the Builder with the given context.

Public Methods
KeyStoreParameter	build() Builds the instance of the `KeyPairGeneratorSpec`.
KeyStoreParameter.Builder	setEncryptionRequired(boolean required) Indicates that this key must be encrypted at rest on storage.

Public Methods

KeyStoreParameter

build()

Builds the instance of the KeyPairGeneratorSpec.

KeyStoreParameter.Builder

setEncryptionRequired(boolean required)

Indicates that this key must be encrypted at rest on storage.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

Public Constructors

public KeyStoreParameter.Builder (Context context)

Added in API level 18

Creates a new instance of the Builder with the given context. The context passed in may be used to pop up some UI to ask the user to unlock or initialize the Android KeyStore facility.

Public Methods

public KeyStoreParameter build ()

Added in API level 18

Builds the instance of the KeyPairGeneratorSpec.

Returns

built instance of KeyPairGeneratorSpec

Throws

IllegalArgumentException	if a required field is missing

public KeyStoreParameter.Builder setEncryptionRequired (boolean required)

Added in API level 18

Indicates that this key must be encrypted at rest on storage. Note that enabling this will require that the user enable a strong lock screen (e.g., PIN, password) before creating or using the generated key is successful.

Results

Interfaces

Classes

Exceptions

Class Overview

Summary

Public Constructors

public KeyStoreParameter.Builder (Context context)

Public Methods

public KeyStoreParameter build ()

Returns

Throws

public KeyStoreParameter.Builder setEncryptionRequired (boolean required)

java.lang.Object
↳	android.security.KeyStoreParameter.Builder