Interface SecureKeyStore

All Known Implementing Classes:

SimpleKeyFile

public interface SecureKeyStore

Represents a collection of Secure Keys and typically stores them in some persistent storage. SecureKeyStore isolates from particular DB implementations. A Secure Key Store need not implement any security itself, it just holds keys that are inherently secure (like SecureDESKey).

Note: SecureKeyStore doesn't have any relation with java.security.KeyStore SecureKeyStore works on objects of type org.jpos.security.SecureKey

See Also:

• SecureKey

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SecureKeyStore.SecureKeyStoreException

Method Summary

Modifier and Type	Method	Description
<T extends SecureKey> T	getKey(String alias)	Returns the key assiciated with the given alias.
<T extends SecureKey> Map<String,T>	getKeys()	Returns map of existing keys assiciated with aliases.
void	setKey(String alias, SecureKey key)	Assigns the given key to the given alias.

Method Details

getKey

<T extends SecureKey> T getKey(String alias)
                        throws SecureKeyStore.SecureKeyStoreException

Returns the key assiciated with the given alias.

Type Parameters:

T - desired type of requested key

Parameters:

alias - the alias name

Returns:

the requested key, or null if the given alias does not exist.

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or if the operation fails for some other reason.

setKey

void setKey(String alias,
 SecureKey key)
     throws SecureKeyStore.SecureKeyStoreException

Assigns the given key to the given alias. If the given alias already exists, the keystore information associated with it is overridden by the given key.

Parameters:

alias - the alias name

key - the key to be associated with the alias

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or the key can't be recovered.

getKeys

<T extends SecureKey> Map<String,T> getKeys()
                                     throws SecureKeyStore.SecureKeyStoreException

Returns map of existing keys assiciated with aliases.

Type Parameters:

T - desired type of requested keys

Returns:

map of existing keys assiciated with aliases.

Throws:

SecureKeyStore.SecureKeyStoreException - if SecureKeyStore is not initialized or if the operation fails for some other reason.