KeyStore.Builder - Android SDK

Summary: Protected Ctors | Methods | Inherited Methods | [Expand All]

Added in API level 1

public static abstract class

KeyStore.Builder

extends Object

java.lang.Object
↳	java.security.KeyStore.Builder

Class Overview

Builder is used to construct new instances of KeyStore.

Summary

Protected Constructors
	KeyStore.Builder() Constructs a new instance of `Builder`.

Public Methods
abstract KeyStore	getKeyStore() Returns the `KeyStore` created by this `Builder`.
abstract KeyStore.ProtectionParameter	getProtectionParameter(String alias) Returns the `ProtectionParameter` to be used when a `Entry` with the specified alias is requested.
static KeyStore.Builder	newInstance(KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter) Returns a new `Builder` that holds the given `KeyStore` and the given `ProtectionParameter`.
static KeyStore.Builder	newInstance(String type, Provider provider, KeyStore.ProtectionParameter protectionParameter) Returns a new `Builder` that creates a new `KeyStore` based on the provided arguments.
static KeyStore.Builder	newInstance(String type, Provider provider, File file, KeyStore.ProtectionParameter protectionParameter) Returns a new `Builder` that creates a new `KeyStore` based on the provided arguments.

[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.

Protected Constructors

protected KeyStore.Builder ()

Added in API level 1

Constructs a new instance of Builder.

Public Methods

public abstract KeyStore getKeyStore ()

Added in API level 1

Returns the KeyStore created by this Builder.

Returns

the KeyStore created by this Builder.

Throws

KeyStoreException	if an error occurred during construction.

public abstract KeyStore.ProtectionParameter getProtectionParameter (String alias)

Added in API level 1

Returns the ProtectionParameter to be used when a Entry with the specified alias is requested. Before this method is invoked, getKeyStore() must be called.

Parameters

alias	the alias for the entry.

Returns

the ProtectionParameter to be used when a Entry with the specified alias is requested.

Throws

KeyStoreException	if an error occurred during the lookup for the protection parameter.
IllegalStateException	if `getKeyStore()` is not called prior the invocation of this method.
NullPointerException	if `alias` is `null`.

public static KeyStore.Builder newInstance (KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that holds the given KeyStore and the given ProtectionParameter.

Parameters

keyStore	the `KeyStore` to be held.
protectionParameter	the `ProtectionParameter` to be held.

Returns

a new instance of Builder that holds the specified KeyStore and the specified ProtectionParameter.

Throws

NullPointerException	if `keyStore` or `protectionParameter` is `null`.
IllegalArgumentException	if the given `KeyStore` is not initialized.

public static KeyStore.Builder newInstance (String type, Provider provider, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that creates a new KeyStore based on the provided arguments.

If provider is null, all installed providers are searched, otherwise the key store from the specified provider is used.

Parameters

type	the type of the `KeyStore` to be constructed.
provider	the provider of the `KeyStore` to be constructed, maybe `null`.
protectionParameter	the `ProtectionParameter` used to protect the stored keys.

Returns

a new Builder that creates a new KeyStore based on the provided arguments.

Throws

NullPointerException	if `type` or `protectionParameter` is `null`.
IllegalArgumentException	`protectionParameter` not an instance of either `PasswordProtection` or `CallbackHandlerProtection`, `file` is not a file or does not exist at all.

public static KeyStore.Builder newInstance (String type, Provider provider, File file, KeyStore.ProtectionParameter protectionParameter)

Added in API level 1

Returns a new Builder that creates a new KeyStore based on the provided arguments.

If provider is null, all installed providers are searched, otherwise the key store from the specified provider is used.

Parameters

type	the type of the `KeyStore` to be constructed.
provider	the provider of the `KeyStore` to be constructed, maybe `null`.
file	the `File` that contains the data for the `KeyStore`.
protectionParameter	the `ProtectionParameter` used to protect the stored keys.

Returns

a new Builder that creates a new KeyStore based on the provided arguments.

Throws

NullPointerException	if `type, protectionParameter` or `file` is `null`.
IllegalArgumentException	`protectionParameter` not an instance of either `PasswordProtection` or `CallbackHandlerProtection`, `file` is not a file or does not exist at all.

Results

Interfaces

Classes

Enums

Exceptions

KeyStore.Builder

Class Overview

Summary

Protected Constructors

protected KeyStore.Builder ()

Public Methods

public abstract KeyStore getKeyStore ()

Returns

Throws

public abstract KeyStore.ProtectionParameter getProtectionParameter (String alias)

Parameters

Returns

Throws

public static KeyStore.Builder newInstance (KeyStore keyStore, KeyStore.ProtectionParameter protectionParameter)

Parameters

Returns

Throws

public static KeyStore.Builder newInstance (String type, Provider provider, KeyStore.ProtectionParameter protectionParameter)

Parameters

Returns

Throws

public static KeyStore.Builder newInstance (String type, Provider provider, File file, KeyStore.ProtectionParameter protectionParameter)

Parameters

Returns

Throws