Starting March 27, 2025, we recommend using android-latest-release instead of aosp-main to build and contribute to AOSP. For more information, see Changes to AOSP.

IKeyStoreClient

public interface IKeyStoreClient

com.android.tradefed.util.keystore.IKeyStoreClient

Known indirect subclasses

DryRunKeyStore, JSONFileKeyStoreClient, StubKeyStoreClient

DryRunKeyStore	A keystore for dry-run where any keystore value is always properly replaced and found.
JSONFileKeyStoreClient	A sample implementation where a local JSON file acts a key store.
StubKeyStoreClient	Default stub implementation for KeyStore Client.

Interface to access a key store for password or sensitive data.

Summary

Public methods
`abstract boolean`	`containsKey(String key)` A method to check if the key store contains a given key.
`abstract String`	`fetchKey(String key)` A method to fetch a given key inside the key store.
`abstract boolean`	`isAvailable()` A method to check whether or not we have a valid key store to talk to.

Public methods

containsKey

public abstract boolean containsKey (String key)

A method to check if the key store contains a given key.

Parameters
`key`	`String`: to check existence for.

Returns
`boolean`	true if the given key exists.

fetchKey

public abstract String fetchKey (String key)

A method to fetch a given key inside the key store.

Parameters
`key`	`String`: to fetch inside the key store.

Returns
`String`	the `String` value of the key. It will return null if key is not found.

isAvailable

public abstract boolean isAvailable ()

A method to check whether or not we have a valid key store to talk to.

Returns
`boolean`	true if we have a valid key store, false otherwise.