oracle.fmwplatform.credentials.wallet

Interface KeyStoreBuilder<T>

All Known Implementing Classes:

StringKeyStoreBuilder, UsernamePasswordKeyStoreBuilder

public interface KeyStoreBuilder<T>

An Interface that defines a set of methods for transforming a credential object to OracleWallet secretStore and vice versa. This interface also defines set of methods for persisting, retrieving and removing credentials from OracleWallet secretStore.

Method Summary

Modifier and Type	Method and Description
String	buildAlias(String alias) Build an alias based on the input provided.
T	credentialToKey(Credential credential) Convert a credential to a key value.
Credential	getKeyFromKeyStore(String alias, oracle.security.pki.OracleSecretStore secretStore) Retrieves a key form a key store.
List<T>	getKeysFromKeyStore(oracle.security.pki.OracleSecretStore secretStore) Retrieves all the keys from the key store.
Credential	keyToCredential(T key) Converts a key to a credential.
void	persistKeyToKeyStore(String alias, T key, oracle.security.pki.OracleSecretStore secretStore) Saves a key to a key store.
void	removeKeyFromKeyStore(String alias, oracle.security.pki.OracleSecretStore secretStore) Removes a key form a key store.

Method Detail

buildAlias

String buildAlias(String alias)

Build an alias based on the input provided.

Parameters:

alias - base alias name

Returns:

alias name

credentialToKey

T credentialToKey(Credential credential)

Convert a credential to a key value.

Parameters:

credential - the credential

Returns:

a key value of the type supported by this builder

getKeysFromKeyStore

List<T> getKeysFromKeyStore(oracle.security.pki.OracleSecretStore secretStore)
                     throws FMWCredentialsException

Retrieves all the keys from the key store.

Parameters:

secretStore - the key store.

Returns:

a list of keys

Throws:

FMWCredentialsException - if an error occurs

keyToCredential

Credential keyToCredential(T key)
                    throws FMWCredentialsException

Converts a key to a credential.

Parameters:

key - the key to be converted

Returns:

a credential

Throws:

FMWCredentialsException - if an error occurs

getKeyFromKeyStore

Credential getKeyFromKeyStore(String alias,
                              oracle.security.pki.OracleSecretStore secretStore)
                       throws FMWCredentialsException

Retrieves a key form a key store.

Parameters:

alias - the key to be retrieved

secretStore - the key store

Returns:

the key value if it exists

Throws:

FMWCredentialsException - if an error occurs

persistKeyToKeyStore

void persistKeyToKeyStore(String alias,
                          T key,
                          oracle.security.pki.OracleSecretStore secretStore)
                   throws FMWCredentialsException

Saves a key to a key store.

Parameters:

alias - the key alias

key - the key to be stored

secretStore - the store to be used in saving the key

Throws:

FMWCredentialsException - if an error occurs

removeKeyFromKeyStore

void removeKeyFromKeyStore(String alias,
                           oracle.security.pki.OracleSecretStore secretStore)
                    throws FMWCredentialsException

Removes a key form a key store.

Parameters:

alias - the alias identifying the key to be removed

secretStore - the store to be used

Throws:

FMWCredentialsException - if an error occurs