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) Creates a WalletStoreProvider.
WalletStoreProvider(File dir, char[] walletPassword) Creates an encrypted WalletStoreProvider.
WalletStoreProvider(String dirName) Creates a WalletStoreProvider.
WalletStoreProvider(String dirName, char[] walletPassword) Creates a WalletStoreProvider.

Method Summary

Modifier and Type	Method and Description
void	closeWallet(boolean forcedSave) Closes the contained wallet.
void	createWallet() Creates a new wallet based in the wallet being managed.
void	deleteCredentailsStore() Delete the underlying wallet.
void	deleteCredential(String alias) Deletes the requested credential.
void	deleteCredentials(List<String> aliasList) Delete a list of credentials from the underlying wallet.
boolean	exists(String alias) Determines of an alias exists in the managed wallet.
Credential	getCredential(String alias) Returns the credential from the wallet store with the provided alias.
static String	getDefaultWalletLocation() Returns the default wallet location.
Wallet	getWallet() Returns the wallet contained within this provider.
static boolean	isAutoLogin(String walletDirectory) Determines if a wallet is an auto-login wallet.
Credentials	loadCredentials() Retrieve a list of credentials from underlying wallet.
void	setCredential(Credential cred) Sets a credential to the managed wallet.
void	setWallet(Wallet wallet) Set the wallet managed by this provider.
void	storeCredentials(Credentials credentials) Storing a list of credentials to the underlying wallet.
boolean	walletExists(String location, char[] walletPassword) Determines if a wallet exists.

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

Creates a WalletStoreProvider.

Parameters:

dir - location of the wallet

Throws:

FMWCredentialsException - if an error occurs

WalletStoreProvider

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

Creates an encrypted WalletStoreProvider.

Parameters:

dir - location of the wallet

walletPassword - password fro an encrypted wallet

Throws:

FMWCredentialsException - if an error occurs

WalletStoreProvider

public WalletStoreProvider(String dirName)

Creates a WalletStoreProvider.

Parameters:

dirName - location of the wallet

WalletStoreProvider

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

Creates a WalletStoreProvider.

Parameters:

dirName - location of the wallet

walletPassword - password for an encrypted wallet

Throws:

FMWCredentialsException - if an error occurs

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()

Returns the default wallet location.

Returns:

default wallet location

isAutoLogin

public static boolean isAutoLogin(String walletDirectory)
                           throws FMWCredentialsException

Determines if a wallet is an auto-login wallet.

Parameters:

walletDirectory - location of the wallet

Returns:

true if the wallet is an auto-login wallet

Throws:

FMWCredentialsException - if an error occurs

getWallet

public Wallet getWallet()

Returns the wallet contained within this provider.

Returns:

wallet

setWallet

public void setWallet(Wallet wallet)

Set the wallet managed by this provider.

Parameters:

wallet - the wallet to be managed

closeWallet

public void closeWallet(boolean forcedSave)
                 throws FMWCredentialsException

Closes the contained wallet.

Parameters:

forcedSave - if true save the wallet before closing

Throws:

FMWCredentialsException - if an error occurs

createWallet

public void createWallet()
                  throws FMWCredentialsException

Creates a new wallet based in the wallet being managed.

Throws:

FMWCredentialsException - if an error occurs

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

Deletes the requested credential.

Parameters:

alias - the credential alias to be deleted

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 aliases that are being deleted.

Throws:

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

exists

public boolean exists(String alias)

Determines of an alias exists in the managed wallet.

Parameters:

alias - the alias to be located

Returns:

true if the alias exists

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

Returns 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

Sets a credential to the managed wallet.

Parameters:

cred - the credential to be set

Throws:

FMWCredentialsException - if an error occurs

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)

Determines if a wallet exists.

Parameters:

location - the wallet location

walletPassword - the wallet password

Returns:

true if the wallet exists at the specified location