oracle.fmwplatform.credentials.credential

Class CredentialBuilder

java.lang.Object

oracle.fmwplatform.credentials.credential.CredentialBuilder

public class CredentialBuilder
extends Object

The CredentialBuilder class is responsible for providing APIs for interacting with the underlying credential store. The user of the CredentialBuilder class must specify the CredentialStore provider that the CredentialBuilder object will use.

Constructor Summary

Constructors

Constructor and Description
CredentialBuilder(CredentialStore credentialStore)

Method Summary

Modifier and Type	Method and Description
void	deleteCredentials(List<String> aliasList) Delete a list of credentials from the underlying credentialStore.
void	deleteCredentialsStore() Delete the underlying credentialStore.
Credential	getCredential(String alias) Retrieve the credential with the provided alias from the underlying credentialStore
Credentials	loadCredentials() Retrieve a list of credentials from underlying credentialStore.
void	storeCredentials(Credentials credentials) Storing a list of credentials to the underlying credentialStore.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialBuilder

public CredentialBuilder(CredentialStore credentialStore)

Method Detail

deleteCredentials

public void deleteCredentials(List<String> aliasList)
                       throws FMWCredentialsException

Delete a list of credentials from the underlying credentialStore.

Parameters:

aliasList - a list of credential alias that need to be deleted.

Throws:

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

deleteCredentialsStore

public void deleteCredentialsStore()
                            throws FMWCredentialsException

Delete the underlying credentialStore.

Throws:

FMWCredentialsException - an error occurred when deleting the credentialStore.

loadCredentials

public Credentials loadCredentials()
                            throws FMWCredentialsException

Retrieve a list of credentials from underlying credentialStore.

Returns:

a list of Credentials if the underlying credentialStore contains any.

Throws:

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

getCredential

public Credential getCredential(String alias)
                         throws FMWCredentialsException

Retrieve the credential with the provided alias from the underlying credentialStore

Parameters:

alias - of the credential in the credential store

Returns:

Credential found in the credential store or null if not found

Throws:

FMWCredentialsException - if the builder is not initialized with the store or an error occurred when accessing the credential store

storeCredentials

public void storeCredentials(Credentials credentials)
                      throws FMWCredentialsException

Storing a list of credentials to the underlying credentialStore.

Parameters:

credentials - a list of credentials that need to be persisted

Throws:

FMWCredentialsException - an error occurred when storing credentials to the credentialStore.