oracle.fmwplatform.credentials.credential

Class Credentials

java.lang.Object

oracle.fmwplatform.credentials.credential.Credentials

All Implemented Interfaces:

Iterable<Credential>

public class Credentials
extends Object
implements Iterable<Credential>

Credentials class contains a collection of credential objects. Internally it uses HashMap for storing the credential objects.

Constructor Summary

Constructors

Constructor and Description
Credentials()

Method Summary

Modifier and Type	Method and Description
String	getAsEncryptedString(SecretKeySpec secretKey) Convert the credentials store into a single encrypted string that may be stored.
Credential	getCredential(String alias)
List<Credential>	getCredentialsAsList() Return the list of credential objects that are currently stored in the Credentials object
Iterator<Credential>	iterator() An iterator over the internal Credential collection.
Credentials	setAsString(String creds, SecretKeySpec secretKey) Decrypt a encrypted string representation of a credential store and load it and the credentials of this object.
Credentials	setCredential(Credential cred) Store a credential to the internal credentials HashMap
Credentials	setCredential(String alias, char[] password) Store a credential to the internal credentials HashMap
Credentials	setCredential(String alias, String userName, char[] password) Store a credential to the internal credentials HashMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Credentials

public Credentials()

Method Detail

getCredential

public Credential getCredential(String alias)

getCredentialsAsList

public List<Credential> getCredentialsAsList()

Return the list of credential objects that are currently stored in the Credentials object

Returns:

List<Credential>

iterator

public Iterator<Credential> iterator()

An iterator over the internal Credential collection.

Specified by:

iterator in interface Iterable<Credential>

Returns:

Iterator<Credential>

setCredential

public Credentials setCredential(Credential cred)

Store a credential to the internal credentials HashMap

Parameters:

cred - The credential object that is being stored.

Returns:

Credentials a reference to this Credential object.

setCredential

public Credentials setCredential(String alias,
                                 char[] password)
                          throws FMWCredentialsException

Store a credential to the internal credentials HashMap

Parameters:

alias - alias alias of the credential object that is being stored.

password - password of the credential object that is being stored.

Returns:

Credentials

Throws:

FMWCredentialsException - if an error occurs

setCredential

public Credentials setCredential(String alias,
                                 String userName,
                                 char[] password)
                          throws FMWCredentialsException

Store a credential to the internal credentials HashMap

Parameters:

alias - alias of the credential object that is being set

userName - userName of the credential object that is being stored

password - password of the credential object that is being stored

Returns:

Credentials

Throws:

FMWCredentialsException - if an error occurs

getAsEncryptedString

public String getAsEncryptedString(SecretKeySpec secretKey)
                            throws FMWCredentialsException

Convert the credentials store into a single encrypted string that may be stored.

Parameters:

secretKey - a SecretKeySpec object used to encrypt the sting

Returns:

a string representation of the credentials

Throws:

FMWCredentialsException - if an error occurs

setAsString

public Credentials setAsString(String creds,
                               SecretKeySpec secretKey)
                        throws FMWCredentialsException

Decrypt a encrypted string representation of a credential store and load it and the credentials of this object.

Parameters:

creds - the string version of the credentials

secretKey - a SecretKeySpec object containing the required info to decrypt the string

Returns:

the this object for method chaining

Throws:

FMWCredentialsException - if the string passed is invalid