oracle.fmwplatform.credentials.wallet

Interface Wallet

All Known Implementing Classes:

AutoLoginWallet, EncryptedWallet, EtcdWallet, FMWWallet

public interface Wallet

A interface that defined set of methods for interacting with underlying Wallet file.

Method Summary

Modifier and Type	Method and Description
void	closeWallet(boolean forcedSave) Close the wallet.
void	createNewWallet() Create a new wallet.
void	deleteWallet() Delete the wallet file.
boolean	exists(String alias) Check the existent of a credential in the wallet.
Credential	getCredential(String alias) Retrieve the credential from the underlying wallet that matches the alias
Credentials	loadCredentials() Retrieve a list of credentials from underlying wallet.
void	removeCredential(String alias) Remove a credential from the wallet.
void	setCredential(Credential cred) Persist a credential to the underlying wallet.
boolean	walletExists(String location, char[] walletPassword) Check the existent of a wallet file.

Method Detail

closeWallet

void closeWallet(boolean forcedSave)
          throws FMWCredentialsException

Close the wallet.

Parameters:

forcedSave - flag to indicate if wallet file need to be saved regardless if any wallet keyStore change has occurred.

Throws:

FMWCredentialsException - an error occurred when closing the wallet.

createNewWallet

void createNewWallet()
              throws FMWCredentialsException

Create a new wallet.

Throws:

FMWCredentialsException - an error occurred when creating a new wallet.

deleteWallet

void deleteWallet()
           throws FMWCredentialsException

Delete the wallet file.

Throws:

FMWCredentialsException - an error occurred when deleting the wallet.

exists

boolean exists(String alias)

Check the existent of a credential in the wallet.

Parameters:

alias - Credential alias

Returns:

true if a credential with given alias exist, otherwise return false

loadCredentials

Credentials loadCredentials()
                     throws FMWCredentialsException

Retrieve a list of credentials from underlying wallet.

Returns:

Credentials a list of Credentials if the underlying wallet contains any.

Throws:

FMWCredentialsException - an error occurred when retrieving credentials from the wallet.

removeCredential

void removeCredential(String alias)
               throws FMWCredentialsException

Remove a credential from the wallet.

Parameters:

alias - The alias of the credential that is being removed

Throws:

FMWCredentialsException - an error occurred when removing a credential from the wallet.

setCredential

void setCredential(Credential cred)
            throws FMWCredentialsException

Persist a credential to the underlying wallet.

Parameters:

cred - The credential object that need to be persisted

Throws:

FMWCredentialsException - an error occurred when persisting a credential to the wallet.

walletExists

boolean walletExists(String location,
                     char[] walletPassword)

Check the existent of a wallet file.

Parameters:

location - File path to the wallet file.

walletPassword - Wallet password

Returns:

true if the wallet file exist, otherwise return false

getCredential

Credential getCredential(String alias)
                  throws FMWCredentialsException

Retrieve the credential from the underlying wallet that matches the alias

Parameters:

alias - The alias of the credential that is being retrieved

Returns:

Credential matching the alias or null if not found in the wallet

Throws:

FMWCredentialsException - if there is a problem accessing the underlying wallet