Interface ISecretProvider

All Known Implementing Classes:

AbstractMapCredentialFactory, AnsibleVaultCredentialFactory, DelineaCredentialFactory, FileSystemCredentialFactory, FrankApplication.NoopCredentialFactory, KubernetesCredentialFactory, PropertyFileCredentialFactory, WildFlyCredentialFactory

public interface ISecretProvider

Interface for a CredentialFactory. A CredentialFactory is responsible for providing credentials to the framework.

Implementations of this interface should be registered in the credentialproperties.properties file.

Implementations of this interface should be thread-safe.

Method Summary

Modifier and Type	Method	Description
Collection<String>	getConfiguredAliases()	Return a list of all configured aliases, should provide an empty list if none can be provided.
ISecret	getSecret(CredentialAlias alias)
boolean	hasSecret(CredentialAlias alias)
void	initialize()	initialize() of an implementation can throw an exception when the credentialFactory cannot be properly configured and used.

Method Details

initialize

void initialize()
         throws Exception

initialize() of an implementation can throw an exception when the credentialFactory cannot be properly configured and used.

Throws:

Exception

hasSecret

boolean hasSecret(CredentialAlias alias)

getSecret

ISecret getSecret(CredentialAlias alias)
           throws NoSuchElementException

Throws:

NoSuchElementException

getConfiguredAliases

Collection<String> getConfiguredAliases()
                                 throws Exception

Return a list of all configured aliases, should provide an empty list if none can be provided.

Throws:

Exception - Can throw an exception when failing to get the configured aliases.