Class CredentialFactory

java.lang.Object

org.frankframework.credentialprovider.CredentialFactory

public class CredentialFactory
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static boolean	ALLOW_DEFAULT_PASSWORD
static final String	CREDENTIAL_FACTORY_ALIAS_PREFIX_KEY
static final String	CREDENTIAL_FACTORY_KEY
static final String	DEFAULT_PASSWORD_FIELD
static final String	DEFAULT_USERNAME_FIELD
protected final List<ISecretProvider>	delegates
static final String	LEGACY_PACKAGE_NAME
static final String	ORG_FRANKFRAMEWORK_PACKAGE_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CredentialFactory(boolean allowFallbackProvider)

Method Summary

Modifier and Type	Method	Description
static void	createInstance(ISecretProvider... providers)	Create an instance using the given ISecretProviders, ignoring the providers specified in the configuration.
protected void	exit()
static Collection<String>	getConfiguredAliases()
static @Nullable ICredentials	getCredentials(@Nullable String rawAlias)	Entrypoint.
static ICredentials	getCredentials(@Nullable String rawAlias, @Nullable String defaultUsername, @Nullable String defaultPassword)	Entrypoint.
static CredentialFactory	getInstance()
static Properties	getProperties()	Get the configuration properties of the CredentialFactory.
static @Nullable String	getProperty(String key)	Get a property of the CredentialFactory, or null if not set
static @Nullable String	getProperty(String key, @Nullable String defaultValue)	Get a property of the CredentialFactory, or defaultValue if not set
static boolean	hasCredential(String rawAlias)
static void	reset()	Reset factory to its default state.
static @Nullable String	setProperty(String key, String value)	Update the value of a property.

Methods inherited from class Object

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

Field Details

CREDENTIAL_FACTORY_KEY

public static final String CREDENTIAL_FACTORY_KEY

See Also:

• Constant Field Values

CREDENTIAL_FACTORY_ALIAS_PREFIX_KEY

public static final String CREDENTIAL_FACTORY_ALIAS_PREFIX_KEY

See Also:

• Constant Field Values

LEGACY_PACKAGE_NAME

public static final String LEGACY_PACKAGE_NAME

See Also:

• Constant Field Values

ORG_FRANKFRAMEWORK_PACKAGE_NAME

public static final String ORG_FRANKFRAMEWORK_PACKAGE_NAME

See Also:

• Constant Field Values

DEFAULT_USERNAME_FIELD

public static final String DEFAULT_USERNAME_FIELD

See Also:

• Constant Field Values

DEFAULT_PASSWORD_FIELD

public static final String DEFAULT_PASSWORD_FIELD

See Also:

• Constant Field Values

delegates

protected final List<ISecretProvider> delegates

ALLOW_DEFAULT_PASSWORD

protected static boolean ALLOW_DEFAULT_PASSWORD

Constructor Details

CredentialFactory

protected CredentialFactory(boolean allowFallbackProvider)

Method Details

getInstance

public static CredentialFactory getInstance()

reset

public static void reset()

Reset factory to its default state.

getProperties

public static Properties getProperties()

Get the configuration properties of the CredentialFactory. This is a convenience method; you should never modify the properties obtained via this method.

setProperty

public static @Nullable String setProperty(String key,
 String value)

Update the value of a property. This method is for test-usage. Changing the value of any property will clear the loaded CredentialProviders, so that the changes will be reflected in any CredentialProviders accessed since.

Parameters:

key - Name of property to update

value - New value of the property, may not be null.

Returns:

Previous value of the property if set, otherwise null.

getProperty

public static @Nullable String getProperty(String key)

Get a property of the CredentialFactory, or null if not set

getProperty

@Contract("_, !null -> !null")
public static @Nullable String getProperty(String key,
 @Nullable String defaultValue)

Get a property of the CredentialFactory, or defaultValue if not set

createInstance

public static void createInstance(ISecretProvider... providers)
                           throws Exception

Create an instance using the given ISecretProviders, ignoring the providers specified in the configuration.

Throws:

Exception

exit

protected void exit()

hasCredential

public static boolean hasCredential(String rawAlias)

getCredentials

public static @Nullable ICredentials getCredentials(@Nullable String rawAlias)

Entrypoint. Attempts to find the credential for the specified alias. If none is found, returns NULL, else the credential.

getCredentials

public static ICredentials getCredentials(@Nullable String rawAlias,
 @Nullable String defaultUsername,
 @Nullable String defaultPassword)
                                   throws NoSuchElementException

Entrypoint. Attempts to find the credential for the specified alias. When none is found, uses the default (provided) fallback user/pass combination.

Throws:

NoSuchElementException

getConfiguredAliases

public static Collection<String> getConfiguredAliases()