oracle.fmwplatform.credentials.wallet

Class UsernamePasswordKeyStoreBuilder

java.lang.Object

oracle.fmwplatform.credentials.wallet.UsernamePasswordKeyStoreBuilder

All Implemented Interfaces:

KeyStoreBuilder<Credential>

public class UsernamePasswordKeyStoreBuilder
extends Object
implements KeyStoreBuilder<Credential>

Implementation class of KeyStoreBuilder Interface

Constructor Summary

Constructors

Constructor and Description
UsernamePasswordKeyStoreBuilder()

Method Summary

Modifier and Type	Method and Description
String	buildAlias(String alias) Build an alias based on the input provided.
Credential	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<Credential>	getKeysFromKeyStore(oracle.security.pki.OracleSecretStore secretStore) Retrieves all the keys from the key store.
Credential	keyToCredential(Credential key) Converts a key to a credential.
void	persistKeyToKeyStore(String alias, Credential 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

UsernamePasswordKeyStoreBuilder

public UsernamePasswordKeyStoreBuilder()

Method Detail

buildAlias

public String buildAlias(String alias)

Description copied from interface: KeyStoreBuilder

Build an alias based on the input provided.

Specified by:

buildAlias in interface KeyStoreBuilder<Credential>

Parameters:

alias - base alias name

Returns:

alias name

credentialToKey

public Credential credentialToKey(Credential credential)

Description copied from interface: KeyStoreBuilder

Convert a credential to a key value.

Specified by:

credentialToKey in interface KeyStoreBuilder<Credential>

Parameters:

credential - the credential

Returns:

a key value of the type supported by this builder

getKeysFromKeyStore

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

Description copied from interface: KeyStoreBuilder

Retrieves all the keys from the key store.

Specified by:

getKeysFromKeyStore in interface KeyStoreBuilder<Credential>

Parameters:

secretStore - the key store.

Returns:

a list of keys

Throws:

FMWCredentialsException - if an error occurs

getKeyFromKeyStore

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

Description copied from interface: KeyStoreBuilder

Retrieves a key form a key store.

Specified by:

getKeyFromKeyStore in interface KeyStoreBuilder<Credential>

Parameters:

alias - the key to be retrieved

secretStore - the key store

Returns:

the key value if it exists

Throws:

FMWCredentialsException - if an error occurs

keyToCredential

public Credential keyToCredential(Credential key)
                           throws FMWCredentialsException

Description copied from interface: KeyStoreBuilder

Converts a key to a credential.

Specified by:

keyToCredential in interface KeyStoreBuilder<Credential>

Parameters:

key - the key to be converted

Returns:

a credential

Throws:

FMWCredentialsException - if an error occurs

persistKeyToKeyStore

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

Description copied from interface: KeyStoreBuilder

Saves a key to a key store.

Specified by:

persistKeyToKeyStore in interface KeyStoreBuilder<Credential>

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

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

Description copied from interface: KeyStoreBuilder

Removes a key form a key store.

Specified by:

removeKeyFromKeyStore in interface KeyStoreBuilder<Credential>

Parameters:

alias - the alias identifying the key to be removed

secretStore - the store to be used

Throws:

FMWCredentialsException - if an error occurs