oracle.fmwplatform.credentials.wallet

Class FMWWallet

java.lang.Object

oracle.fmwplatform.credentials.wallet.FMWWallet

All Implemented Interfaces:

Wallet

Direct Known Subclasses:

AutoLoginWallet, EncryptedWallet, EtcdWallet

public abstract class FMWWallet
extends Object
implements Wallet

An abstract based class that implements Wallet interface. It encapsulates an OracleWalle object and provides low-level manipulation on OracleWallet object.

Constructor Summary

Constructors

Constructor and Description
FMWWallet()

Method Summary

Modifier and Type	Method and Description
abstract boolean	checkWalletExists(String location)
void	closeWallet(boolean forcedSave) Close the wallet.
void	createNewWallet() Create a new wallet.
abstract void	createWallet()
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
protected String	getLocation()
protected void	getORAWalletSecretStore()
protected oracle.security.pki.OracleSecretStore	getSecretStore()
protected oracle.security.pki.OracleWallet	getWallet()
Credentials	loadCredentials() Retrieve a list of credentials from underlying wallet.
protected void	loadWallet()
abstract void	openWallet()
void	removeCredential(String alias) Remove a credential from the wallet.
void	setCredential(Credential cred) Persist a credential to the underlying wallet.
protected void	setLocation(String location)
protected void	updateWallet()
boolean	walletExists(String location, char[] walletPassword) Check the existent of a wallet file.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.fmwplatform.credentials.wallet.Wallet

deleteWallet

Constructor Detail

FMWWallet

public FMWWallet()

Method Detail

checkWalletExists

public abstract boolean checkWalletExists(String location)

closeWallet

public void closeWallet(boolean forcedSave)
                 throws FMWCredentialsException

Description copied from interface: Wallet

Close the wallet.

Specified by:

closeWallet in interface 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

public void createNewWallet()
                     throws FMWCredentialsException

Description copied from interface: Wallet

Create a new wallet.

Specified by:

createNewWallet in interface Wallet

Throws:

FMWCredentialsException - an error occurred when creating a new wallet.

createWallet

public abstract void createWallet()
                           throws IOException

Throws:

IOException

exists

public boolean exists(String alias)

Description copied from interface: Wallet

Check the existent of a credential in the wallet.

Specified by:

exists in interface Wallet

Parameters:

alias - Credential alias

Returns:

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

getLocation

protected String getLocation()

getORAWalletSecretStore

protected void getORAWalletSecretStore()
                                throws FMWCredentialsException

Throws:

FMWCredentialsException

getSecretStore

protected oracle.security.pki.OracleSecretStore getSecretStore()

getWallet

protected oracle.security.pki.OracleWallet getWallet()

loadCredentials

public Credentials loadCredentials()
                            throws FMWCredentialsException

Description copied from interface: Wallet

Retrieve a list of credentials from underlying wallet.

Specified by:

loadCredentials in interface Wallet

Returns:

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

Throws:

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

loadWallet

protected void loadWallet()
                   throws FMWCredentialsException

Throws:

FMWCredentialsException

openWallet

public abstract void openWallet()
                         throws IOException

Throws:

IOException

removeCredential

public void removeCredential(String alias)
                      throws FMWCredentialsException

Description copied from interface: Wallet

Remove a credential from the wallet.

Specified by:

removeCredential in interface 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

public void setCredential(Credential cred)
                   throws FMWCredentialsException

Description copied from interface: Wallet

Persist a credential to the underlying wallet.

Specified by:

setCredential in interface Wallet

Parameters:

cred - The credential object that need to be persisted

Throws:

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

getCredential

public Credential getCredential(String alias)
                         throws FMWCredentialsException

Description copied from interface: Wallet

Retrieve the credential from the underlying wallet that matches the alias

Specified by:

getCredential in interface Wallet

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

setLocation

protected void setLocation(String location)

updateWallet

protected void updateWallet()
                     throws FMWCredentialsException

Throws:

FMWCredentialsException

walletExists

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

Description copied from interface: Wallet

Check the existent of a wallet file.

Specified by:

walletExists in interface Wallet

Parameters:

location - File path to the wallet file.

walletPassword - Wallet password

Returns:

true if the wallet file exist, otherwise return false