oracle.fmwplatform.credentials.wallet

Class WalletStoreProvider

java.lang.Object

oracle.fmwplatform.credentials.wallet.WalletStoreProvider

All Implemented Interfaces:

CredentialStore

public class WalletStoreProvider
extends Object
implements CredentialStore

WalletStoreProvider implements CredentialStore interface. It provides APIs for performing CRUD operations on the OracleWallet object. This class is also used by WalletManager command-line tools.

Constructor Summary

Constructors

Constructor and Description
WalletStoreProvider(ConfigStoreType type, String url, String location, char[] passPhrase) Create a config store based wallet retrieving credentials from the server
WalletStoreProvider(File dir)
WalletStoreProvider(File dir, char[] walletPassword)
WalletStoreProvider(String dirName)
WalletStoreProvider(String dirName, char[] walletPassword)

Method Summary

Modifier and Type	Method and Description
void	closeWallet(boolean forcedSave)
void	createWallet()
void	deleteCredentailsStore() Delete the underlying wallet.
void	deleteCredential(String alias) Remove the requested credential from the wallet.
void	deleteCredentials(List<String> aliasList) Delete a list of credentials from the underlying wallet.
boolean	exists(String alias)
Credential	getCredential(String alias) Return the credential from the wallet store with the provided alias
static String	getDefaultWalletLocation()
Wallet	getWallet()
static boolean	isAutoLogin(String walletDirectory)
Credentials	loadCredentials() Retrieve a list of credentials from underlying wallet.
void	setCredential(Credential cred)
void	setWallet(Wallet wallet)
void	storeCredentials(Credentials credentials) Storing a list of credentials to the underlying wallet.
boolean	walletExists(String location, char[] walletPassword)

Methods inherited from class java.lang.Object

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

Constructor Detail

WalletStoreProvider

public WalletStoreProvider(File dir)
                    throws FMWCredentialsException

Throws:

FMWCredentialsException

WalletStoreProvider

public WalletStoreProvider(File dir,
                           char[] walletPassword)
                    throws FMWCredentialsException

Throws:

FMWCredentialsException

WalletStoreProvider

public WalletStoreProvider(String dirName)

WalletStoreProvider

public WalletStoreProvider(String dirName,
                           char[] walletPassword)
                    throws FMWCredentialsException

Throws:

FMWCredentialsException

WalletStoreProvider

public WalletStoreProvider(ConfigStoreType type,
                           String url,
                           String location,
                           char[] passPhrase)
                    throws FMWCredentialsException

Create a config store based wallet retrieving credentials from the server

Parameters:

type - the type of config store being used

url - base URL of the config store server

location - the config store key for retrieving/storing credential data

passPhrase - the phrase used to encrypt the credential data

Throws:

FMWCredentialsException - if an error occurs

Method Detail

getDefaultWalletLocation

public static String getDefaultWalletLocation()

isAutoLogin

public static boolean isAutoLogin(String walletDirectory)
                           throws FMWCredentialsException

Throws:

FMWCredentialsException

getWallet

public Wallet getWallet()

setWallet

public void setWallet(Wallet wallet)

closeWallet

public void closeWallet(boolean forcedSave)
                 throws FMWCredentialsException

Throws:

FMWCredentialsException

createWallet

public void createWallet()
                  throws FMWCredentialsException

Throws:

FMWCredentialsException

deleteCredentailsStore

public void deleteCredentailsStore()
                            throws FMWCredentialsException

Delete the underlying wallet.

Specified by:

deleteCredentailsStore in interface CredentialStore

Throws:

FMWCredentialsException - an error occurred when deleting the wallet.

deleteCredential

public void deleteCredential(String alias)
                      throws FMWCredentialsException

Remove the requested credential from the wallet.

Parameters:

alias - he alias of the credential to be removed

Throws:

FMWCredentialsException - if an error occurs

deleteCredentials

public void deleteCredentials(List<String> aliasList)
                       throws FMWCredentialsException

Delete a list of credentials from the underlying wallet.

Specified by:

deleteCredentials in interface CredentialStore

Parameters:

aliasList - a list of credential alias that are being deleted.

Throws:

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

exists

public boolean exists(String alias)

loadCredentials

public Credentials loadCredentials()
                            throws FMWCredentialsException

Retrieve a list of credentials from underlying wallet.

Specified by:

loadCredentials in interface CredentialStore

Returns:

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

Throws:

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

getCredential

public Credential getCredential(String alias)
                         throws FMWCredentialsException

Description copied from interface: CredentialStore

Return the credential from the wallet store with the provided alias

Specified by:

getCredential in interface CredentialStore

Parameters:

alias - of the credential in the wallet store. If alias is null, will return a null credential

Returns:

Credential matching the alias or null if the alias does not exist in the wallet.

Throws:

FMWCredentialsException - if there was a problem accessing the wallet store

setCredential

public void setCredential(Credential cred)
                   throws FMWCredentialsException

Throws:

FMWCredentialsException

storeCredentials

public void storeCredentials(Credentials credentials)
                      throws FMWCredentialsException

Storing a list of credentials to the underlying wallet.

Specified by:

storeCredentials in interface CredentialStore

Parameters:

credentials - a list of credentials that are being persisted

Throws:

FMWCredentialsException - an error occurred when storing credentials to the wallet.

walletExists

public boolean walletExists(String location,
                            char[] walletPassword)