Package org.frankframework.credentialprovider

Interface ICredentialProvider

All Known Implementing Classes:

AbstractMapCredentialFactory, AnsibleVaultCredentialFactory, DelineaCredentialFactory, FileSystemCredentialFactory, KubernetesCredentialFactory, PropertyFileCredentialFactory, WildFlyCredentialFactory

public interface ICredentialProvider

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, or null if such a list cannot be provided.
ICredentials	getCredentials(CredentialAlias alias)
boolean	hasCredentials(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

hasCredentials

boolean hasCredentials(@Nonnull
 CredentialAlias alias)

getCredentials

ICredentials getCredentials(@Nonnull
 CredentialAlias alias)
                     throws NoSuchElementException

Throws:

NoSuchElementException

getConfiguredAliases

Collection<String> getConfiguredAliases()
                                 throws Exception

return a list of all configured aliases, or null if such a list cannot be provided.

Throws:

Exception