hera.keystore

Interface KeyStore

All Known Implementing Classes:

InMemoryKeyStore, JavaKeyStore

@ApiAudience.Public
 @ApiStability.Unstable
public interface KeyStore

Method Summary

Modifier and Type	Method and Description
EncryptedPrivateKey	export(Authentication authentication, java.lang.String password) Export an private key encrypted.
java.util.List<Identity>	listIdentities() Get all the stored identities.
Signer	load(Authentication authentication) Load signer with authentication.
void	remove(Authentication authentication) Remove an AergoKey corresponding to authentication.
void	save(Authentication authentication, AergoKey key) Store an AergoKey to the keystore.
void	store(java.lang.String path, char[] password) Store keystore to the path with password.

Method Detail

save

void save(Authentication authentication,
          AergoKey key)

Store an AergoKey to the keystore.

Parameters:

authentication - an authentication to save key

key - an aergo key to store

Throws:

InvalidAuthenticationException - on invalid authentication

KeyStoreException - on keystore error

load

Signer load(Authentication authentication)

Load signer with authentication.

Parameters:

authentication - an authentication

Returns:

a signer corresponding to authentication

Throws:

InvalidAuthenticationException - on invalid authentication

KeyStoreException - on keystore error

remove

void remove(Authentication authentication)

Remove an AergoKey corresponding to authentication.

Parameters:

authentication - an authentication to remove key

Throws:

InvalidAuthenticationException - on invalid authentication

KeyStoreException - on keystore error

export

EncryptedPrivateKey export(Authentication authentication,
                           java.lang.String password)

Export an private key encrypted.

Parameters:

authentication - an authentication to used in exporting key

password - a password to encrypt

Returns:

an encrypted private key

Throws:

InvalidAuthenticationException - on invalid authentication

KeyStoreException - on keystore error

listIdentities

java.util.List<Identity> listIdentities()

Get all the stored identities.

Returns:

stored identities

Throws:

KeyStoreException - on keystore error

store

void store(java.lang.String path,
           char[] password)

Store keystore to the path with password.

Parameters:

path - a path to store keystore

password - a password to encrypt keystore

Throws:

KeyStoreException - on keystore error