oracle.fmwplatform.credentials.wallet

Class WalletManager

java.lang.Object

oracle.fmwplatform.credentials.wallet.WalletManager

public class WalletManager
extends Object

WalletManager provides command-line interaction with users who can use the tool to build and maintain Oracle Wallet file. It provides CRUD operations on the Oracle Wallet file.

Constructor Summary

Constructors

Constructor and Description
WalletManager()

Method Summary

Modifier and Type	Method and Description
Object	add(String walletDirectory, char[] walletPassword, String alias, char[] password)
Object	add(String walletDirectory, char[] walletPassword, String alias, String user, char[] password)
Object	add(String walletDirectory, String alias, char[] password)
Object	add(String walletDirectory, String alias, String user, char[] password)
Object	createWallet(String walletDirectory)
Object	createWallet(String walletDirectory, char[] walletPassword)
Object	deleteWallet(String walletDirectory)
Object	deleteWallet(String walletDirectory, char[] walletPassword)
Credential	get(String walletDirectory, char[] walletPassword, String alias) Retireves a credential from a wallet.
Credential	get(String walletDirectory, String alias) Retireves a credential from a wallet.
Credentials	getAll(String walletDirectory) Retireves all credentials from a wallet.
Credentials	getAll(String walletDirectory, char[] walletPassword) Retireves all credentials from a wallet.
static void	main(String[] args) Entry point for accessing the WalletManager from a command line.
List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument>	parseCommandLineArguments(String[] args)
static void	printCommandUsage(String command, List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> requiredCommandArgs, List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> optionalCommandArgs)
void	printCredential(Credential credential) Displays the passed credentials.
void	printCredential(Credential credential, String passwordCover) Displays the passed credentials.
void	printCredentials(Credentials credentials) Displays the passed credentials.
void	printCredentials(Credentials credentials, String passwordCover) Displays the passed credentials.
Object	remove(String walletDirectory, char[] walletPassword, String alias) Removes an alias from a wallet.
Object	remove(String walletDirectory, String alias) Removes an alias from a wallet.
Object	removeAll(String walletDirectory) Removes all aliases from a wallet.
Object	removeAll(String walletDirectory, char[] walletPassword) Removes all aliases from a wallet.
void	runCommand() Runs a Wallet Manager command.
Object	set(String walletDirectory, char[] walletPassword, String alias, char[] password) Sets the passed credential in the specified wallet.
Object	set(String walletDirectory, char[] walletPassword, String alias, String user, char[] password) Sets the passed credential in the specified wallet.
Object	set(String walletDirectory, String alias, char[] password) Sets the passed credential in the specified wallet.
Object	set(String walletDirectory, String alias, String user, char[] password) Sets the passed credential in the specified wallet.
void	showErrors(Exception e) Displays Wallet Manager error.
void	showErrors(List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> missingCmdArgs) Displays Wallet Manager errors.
static void	showUsage()
Object	update(String walletDirectory, char[] walletPassword, String alias, char[] password) Updates a wallet credential with a new value.
Object	update(String walletDirectory, char[] walletPassword, String alias, String user, char[] password) Updates a wallet credential with a new value.
Object	update(String walletDirectory, String alias, char[] password) Updates a wallet credential with a new value.
Object	update(String walletDirectory, String alias, String user, char[] password) Updates a wallet credential with a new value.

Methods inherited from class java.lang.Object

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

Constructor Detail

WalletManager

public WalletManager()

Method Detail

main

public static void main(String[] args)

Entry point for accessing the WalletManager from a command line.

Parameters:

args - WalletManager options, run with no options to see list

printCommandUsage

public static void printCommandUsage(String command,
                                     List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> requiredCommandArgs,
                                     List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> optionalCommandArgs)

showUsage

public static void showUsage()

add

public Object add(String walletDirectory,
                  String alias,
                  char[] password)
           throws FMWCredentialsException

Throws:

FMWCredentialsException

add

public Object add(String walletDirectory,
                  String alias,
                  String user,
                  char[] password)
           throws FMWCredentialsException

Throws:

FMWCredentialsException

add

public Object add(String walletDirectory,
                  char[] walletPassword,
                  String alias,
                  char[] password)
           throws FMWCredentialsException

Throws:

FMWCredentialsException

add

public Object add(String walletDirectory,
                  char[] walletPassword,
                  String alias,
                  String user,
                  char[] password)
           throws FMWCredentialsException

Throws:

FMWCredentialsException

createWallet

public Object createWallet(String walletDirectory)
                    throws FMWCredentialsException

Throws:

FMWCredentialsException

createWallet

public Object createWallet(String walletDirectory,
                           char[] walletPassword)
                    throws FMWCredentialsException

Throws:

FMWCredentialsException

deleteWallet

public Object deleteWallet(String walletDirectory)

deleteWallet

public Object deleteWallet(String walletDirectory,
                           char[] walletPassword)

parseCommandLineArguments

public List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> parseCommandLineArguments(String[] args)
                                                                                                    throws IllegalArgumentException,
                                                                                                           FMWCredentialsException

Throws:

IllegalArgumentException

FMWCredentialsException

remove

public Object remove(String walletDirectory,
                     char[] walletPassword,
                     String alias)
              throws FMWCredentialsException

Removes an alias from a wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password for the wallet

alias - the alias to be removed

Returns:

string indicating outcome of the request

Throws:

FMWCredentialsException - if an error occurs

remove

public Object remove(String walletDirectory,
                     String alias)
              throws FMWCredentialsException

Removes an alias from a wallet.

Parameters:

walletDirectory - location of the wallet

alias - the alias to be removed

Returns:

string indicating outcome of the request

Throws:

FMWCredentialsException - if an error occurs

removeAll

public Object removeAll(String walletDirectory)
                 throws FMWCredentialsException

Removes all aliases from a wallet.

Parameters:

walletDirectory - location of the wallet

Returns:

string indicating outcome of the request

Throws:

FMWCredentialsException - if an error occurs

removeAll

public Object removeAll(String walletDirectory,
                        char[] walletPassword)
                 throws FMWCredentialsException

Removes all aliases from a wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password for the wallet

Returns:

string indicating outcome of the request

Throws:

FMWCredentialsException - if an error occurs

runCommand

public void runCommand()
                throws FMWCredentialsException

Runs a Wallet Manager command.

Throws:

FMWCredentialsException - if an error occurs

printCredentials

public void printCredentials(Credentials credentials)

Displays the passed credentials.

Parameters:

credentials - the credentials to display

printCredentials

public void printCredentials(Credentials credentials,
                             String passwordCover)

Displays the passed credentials.

Parameters:

credentials - the credentials to display

passwordCover - data used to cover password

printCredential

public void printCredential(Credential credential)

Displays the passed credentials.

Parameters:

credential - the credentials to display

printCredential

public void printCredential(Credential credential,
                            String passwordCover)

Displays the passed credentials.

Parameters:

credential - the credentials to display

passwordCover - data used to cover password

set

public Object set(String walletDirectory,
                  String alias,
                  char[] password)
           throws FMWCredentialsException

Sets the passed credential in the specified wallet.

Parameters:

walletDirectory - location of the wallet

alias - the credential alias

password - the credential password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

set

public Object set(String walletDirectory,
                  String alias,
                  String user,
                  char[] password)
           throws FMWCredentialsException

Sets the passed credential in the specified wallet.

Parameters:

walletDirectory - location of the wallet

alias - the credential alias

user - the credential user ID

password - the credential password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

set

public Object set(String walletDirectory,
                  char[] walletPassword,
                  String alias,
                  char[] password)
           throws FMWCredentialsException

Sets the passed credential in the specified wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password to access the wallet

alias - the credential alias

password - the credential password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

set

public Object set(String walletDirectory,
                  char[] walletPassword,
                  String alias,
                  String user,
                  char[] password)
           throws FMWCredentialsException

Sets the passed credential in the specified wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password to access the wallet

alias - the credential alias

user - the credential user ID

password - the credential password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

showErrors

public void showErrors(Exception e)

Displays Wallet Manager error.

Parameters:

e - the exception causing the error

showErrors

public void showErrors(List<oracle.fmwplatform.credentials.wallet.WalletManager.CommandArgument> missingCmdArgs)

Displays Wallet Manager errors.

Parameters:

missingCmdArgs - the passed in command line options

update

public Object update(String walletDirectory,
                     String alias,
                     char[] password)
              throws FMWCredentialsException

Updates a wallet credential with a new value.

Parameters:

walletDirectory - location of the wallet

alias - the alias to be updated

password - the alias password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

update

public Object update(String walletDirectory,
                     String alias,
                     String user,
                     char[] password)
              throws FMWCredentialsException

Updates a wallet credential with a new value.

Parameters:

walletDirectory - location of the wallet

alias - the alias to be updated

user - the alias user ID

password - the alias password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

update

public Object update(String walletDirectory,
                     char[] walletPassword,
                     String alias,
                     char[] password)
              throws FMWCredentialsException

Updates a wallet credential with a new value.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password to access the wallet

alias - the alias to be updated

password - the alias password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

update

public Object update(String walletDirectory,
                     char[] walletPassword,
                     String alias,
                     String user,
                     char[] password)
              throws FMWCredentialsException

Updates a wallet credential with a new value.

Parameters:

walletDirectory - location of the wallet

walletPassword - the password to access the wallet

alias - the alias to be updated

user - the alias user ID

password - the alias password

Returns:

string indicating success of operation

Throws:

FMWCredentialsException - if an error occurs

get

public Credential get(String walletDirectory,
                      String alias)
               throws FMWCredentialsException

Retireves a credential from a wallet.

Parameters:

walletDirectory - location of the wallet

alias - the alias of the credential to be returned

Returns:

the requested credential

Throws:

FMWCredentialsException - if an error occurs

get

public Credential get(String walletDirectory,
                      char[] walletPassword,
                      String alias)
               throws FMWCredentialsException

Retireves a credential from a wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the wallet password

alias - the alias of the credential to be returned

Returns:

the requested credential

Throws:

FMWCredentialsException - if an error occurs

getAll

public Credentials getAll(String walletDirectory)
                   throws FMWCredentialsException

Retireves all credentials from a wallet.

Parameters:

walletDirectory - location of the wallet

Returns:

all credentials in the wallet

Throws:

FMWCredentialsException - if an error occurs

getAll

public Credentials getAll(String walletDirectory,
                          char[] walletPassword)
                   throws FMWCredentialsException

Retireves all credentials from a wallet.

Parameters:

walletDirectory - location of the wallet

walletPassword - the wallet password

Returns:

all credentials in the wallet

Throws:

FMWCredentialsException - if an error occurs