Added in API level 18
Deprecated in API level 23

Builder

Kotlin |Java

class Builder

kotlin.Any
↳	android.security.KeyStoreParameter.Builder

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
`Builder(context: Context)` Creates a new instance of the `Builder` with the given `context`.

Public methods
KeyStoreParameter	`build()` Builds the instance of the `KeyStoreParameter`.
KeyStoreParameter.Builder	`setEncryptionRequired(required: Boolean)` Sets whether this `java.security.KeyStore` entry must be encrypted at rest.

Public constructors

Builder

Added in API level 18

Builder(context: Context)

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.

Parameters
`context`	Context: This value cannot be `null`.

Public methods

build

Added in API level 18

fun build(): KeyStoreParameter

Deprecated: Deprecated in Java.

Builds the instance of the KeyStoreParameter.

Return
`KeyStoreParameter`	built instance of `KeyStoreParameter` This value cannot be `null`.

Exceptions
`java.lang.IllegalArgumentException`	if a required field is missing

setEncryptionRequired

Added in API level 18

fun setEncryptionRequired(required: Boolean): KeyStoreParameter.Builder

Deprecated: Data at rest encryption is enabled by default. If extra binding to the lockscreen credential is desired, use .Builder#setUserAuthenticationRequired(boolean). This flag will be ignored from Android S.

Sets whether this java.security.KeyStore entry must be encrypted at rest. Encryption at rest will protect the entry with the secure lock screen credential (e.g., password, PIN, or pattern).

Note that enabling this feature requires that the secure lock screen (e.g., password, PIN, pattern) is set up, otherwise setting the KeyStore entry will fail. Moreover, this entry will be deleted when the secure lock screen is disabled or reset (e.g., by the user or a Device Administrator). Finally, this entry cannot be used until the user unlocks the secure lock screen after boot.

Return
`KeyStoreParameter.Builder`	This value cannot be `null`.

See Also

android.app.KeyguardManager#isDeviceSecure()