oracle.fmwplatform.credentials.credential

Interface CredentialStore

All Known Implementing Classes:

WalletStoreProvider

public interface CredentialStore

CredentialStore is an interface that defines set of methods for interacting with underlying credentialStore.

Method Summary

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

Method Detail

deleteCredentailsStore

void deleteCredentailsStore()
                     throws FMWCredentialsException

Delete the underlying credentialStore.

Throws:

FMWCredentialsException - an error occurred when deleting the credentialStore.

deleteCredentials

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.

loadCredentials

Credentials loadCredentials()
                     throws FMWCredentialsException

Retrieve a list of credentials from underlying credentialStore.

Returns:

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

Throws:

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

getCredential

Credential getCredential(String alias)
                  throws FMWCredentialsException

Return the credential from the wallet store with the provided alias

Parameters:

alias - of the credential in the wallet store. If alias is null, will return a null credential

Returns:

Credential matching the alias or null if the alias does not exist in the wallet.

Throws:

FMWCredentialsException - if there was a problem accessing the wallet store

storeCredentials

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.