Package com.klaytn.caver.wallet.keyring

Class KeyStore

java.lang.Object

com.klaytn.caver.wallet.keyring.KeyStore

public class KeyStore
extends java.lang.Object

Represents a KeyStore DTO(Data transfer Object) class according to KIP-3.

For more details, please see below link.

http://kips.klaytn.com/KIPs/kip-3

See Also:

KeyringFactory.decrypt(String, String), KeyringFactory.decrypt(KeyStore, String), AbstractKeyring.encrypt(String), AbstractKeyring.encrypt(String, KeyStoreOption), AbstractKeyring.encryptV3(String), AbstractKeyring.encryptV3(String, KeyStoreOption), AbstractKeyring.encrypt(String), SingleKeyring.encrypt(String, KeyStoreOption), SingleKeyring.encryptV3(String), SingleKeyring.encryptV3(String, KeyStoreOption), AbstractKeyring.encrypt(String), MultipleKeyring.encrypt(String, KeyStoreOption), AbstractKeyring.encryptV3(String), AbstractKeyring.encryptV3(String, KeyStoreOption), AbstractKeyring.encrypt(String), RoleBasedKeyring.encrypt(String, KeyStoreOption), AbstractKeyring.encryptV3(String), AbstractKeyring.encryptV3(String, KeyStoreOption)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyStore.CipherParams	Represents a Cipher option to encrypt or decrypt key
static class	KeyStore.Crypto	Represent a Crypto data in KeyStore It represents a 'keyring' in KeyStore Format V4 - If role-based Keyring : It has a List that has Crypto list.
static class	KeyStore.Pbkdf2KdfParams	Represent a PBKDF2 parameter Class used in Key derivation
static class	KeyStore.ScryptKdfParams	Represent a Scrypt parameter Class used in Key derivation

Field Summary

Fields

Modifier and Type	Field	Description
static int	KEY_STORE_VERSION_V3	Keystore Format V4 version
static int	KEY_STORE_VERSION_V4	Keystore Format V3 version

Constructor Summary

Constructors

Constructor	Description
KeyStore()	Creates a KeyStore instance.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getAddress()	Getter function of address.
KeyStore.Crypto	getCrypto()	Getter function of crypto.
java.lang.String	getId()	Getter function for id.
java.util.List	getKeyring()	Getter function of keyRing.
int	getVersion()	Getter function for version.
void	setAddress(java.lang.String address)	Setter function of address.
void	setCrypto(KeyStore.Crypto crypto)	Setter function of crypto.
void	setCryptoV1(KeyStore.Crypto crypto)	Setter function of Crypto.
void	setId(java.lang.String id)	Setter function for id.
void	setKeyring(java.util.List keyRing)	Setter function of keyRing.
void	setVersion(int version)	Setter function for version

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_STORE_VERSION_V3

public static final int KEY_STORE_VERSION_V3

Keystore Format V4 version

See Also:

Constant Field Values

KEY_STORE_VERSION_V4

public static final int KEY_STORE_VERSION_V4

Keystore Format V3 version

See Also:

Constant Field Values

Constructor Detail

KeyStore

public KeyStore()

Creates a KeyStore instance.

Method Detail

setKeyring

public void setKeyring(java.util.List keyRing)

Setter function of keyRing.

Parameters:

keyRing -

getKeyring

public java.util.List getKeyring()

Getter function of keyRing.

Returns:

List

getAddress

public java.lang.String getAddress()

Getter function of address.

Returns:

String

setAddress

public void setAddress(java.lang.String address)

Setter function of address.

Parameters:

address - An address

getCrypto

public KeyStore.Crypto getCrypto()

Getter function of crypto.

Returns:

KeyStore.Crypto

setCrypto

public void setCrypto(KeyStore.Crypto crypto)

Setter function of crypto. for KeyStore Format V3.

Parameters:

crypto - KeyStore.Crypto.

setCryptoV1

public void setCryptoV1(KeyStore.Crypto crypto)

Setter function of Crypto. for KeyStore Format V1.

Parameters:

crypto - KeyStore.Crypto

getId

public java.lang.String getId()

Getter function for id.

Returns:

String

setId

public void setId(java.lang.String id)

Setter function for id.

Parameters:

id - An id in KeyStore

getVersion

public int getVersion()

Getter function for version.

Returns:

integer

setVersion

public void setVersion(int version)

Setter function for version

Parameters:

version - version in KeyStore