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 base class that implements Wallet interface. It encapsulates an OracleWallet 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) Determine if a wallet exists at the supplied location.
void	closeWallet(boolean forcedSave) Close the wallet.
void	createNewWallet() Create a new wallet.
abstract void	createWallet() Create a new wallet.
boolean	exists(String alias) Determines if the passed alias exists in this wallet.
Credential	getCredential(String alias) Retrieve the credential from the underlying wallet that matches the alias.
protected String	getLocation() Returns the location of this wallet.
protected void	getORAWalletSecretStore() Sets the secret store of this instance from the Oracle Wallet.
protected oracle.security.pki.OracleSecretStore	getSecretStore() Returns the secret store for this wallet instance.
protected oracle.security.pki.OracleWallet	getWallet() Returns the Oracle Wallet this instance is based on.
Credentials	loadCredentials() Loads all the credentials from the key store.
protected void	loadWallet() Load the Oracle Wallet data.
abstract void	openWallet() Opens the Oracle Wallet.
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) Sets the location of this wallet.
protected void	updateWallet() Updates the Oracle Wallet with any changes.
boolean	walletExists(String location, char[] walletPassword) Determines if a wallet exists at the specified location.

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)

Determine if a wallet exists at the supplied location.

Parameters:

location - wallet location

Returns:

true if a wallet exists at the 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 needs 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

Create a new wallet.

Throws:

IOException - if an error occurs

exists

public boolean exists(String alias)

Description copied from interface: Wallet

Determines if the passed alias exists in this wallet.

Specified by:

exists in interface Wallet

Parameters:

alias - the Credential alias

Returns:

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

getLocation

protected String getLocation()

Returns the location of this wallet.

Returns:

wallet location

getORAWalletSecretStore

protected void getORAWalletSecretStore()
                                throws FMWCredentialsException

Sets the secret store of this instance from the Oracle Wallet.

Throws:

FMWCredentialsException - if an error occurs

getSecretStore

protected oracle.security.pki.OracleSecretStore getSecretStore()

Returns the secret store for this wallet instance.

Returns:

the secret store

getWallet

protected oracle.security.pki.OracleWallet getWallet()

Returns the Oracle Wallet this instance is based on.

Returns:

the Oracle Wallet

loadCredentials

public Credentials loadCredentials()
                            throws FMWCredentialsException

Loads all the credentials from the key store.

Specified by:

loadCredentials in interface Wallet

Returns:

a Credentials object containg all keys

Throws:

FMWCredentialsException - if an error occurs

loadWallet

protected void loadWallet()
                   throws FMWCredentialsException

Load the Oracle Wallet data.

Throws:

FMWCredentialsException - if an error occurs

openWallet

public abstract void openWallet()
                         throws IOException

Opens the Oracle Wallet.

Throws:

IOException - if an error occurs

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

Sets the location of this wallet.

Parameters:

location - wallet location

updateWallet

protected void updateWallet()
                     throws FMWCredentialsException

Updates the Oracle Wallet with any changes.

Throws:

FMWCredentialsException - if an error occurs

walletExists

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

Description copied from interface: Wallet

Determines if a wallet exists at the specified location.

Specified by:

walletExists in interface Wallet

Parameters:

location - the location of the wallet

walletPassword - the wallet password

Returns:

true if the wallet file exists, otherwise return false