Package org.frankframework.credentialprovider

Class CredentialResolver

java.lang.Object

org.frankframework.credentialprovider.CredentialResolver

All Implemented Interfaces:

AdditionalStringResolver

public class CredentialResolver
extends Object
implements AdditionalStringResolver

Implementation of AdditionalStringResolver for resolving user credentials using the CredentialFactory. This class is loaded via the ServiceLoader.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CREDENTIAL_EXPANSION_ALLOWING_PROPERTY
static final String	CREDENTIAL_PREFIX
static final String	PASSWORD_PREFIX
static final String	USERNAME_PREFIX

Constructor Summary

Constructors

Constructor	Description
CredentialResolver()

Method Summary

Modifier and Type	Method	Description
protected static void	resetAllowedExpansions()
Optional<String>	resolve(String key, Map<?,?> props1, Map<?,?> props2, Set<String> propsToHide, String delimStart, String delimStop, boolean resolveWithPropertyName)	Method to implement string resolution.

Methods inherited from class java.lang.Object

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

Field Details

CREDENTIAL_PREFIX

public static final String CREDENTIAL_PREFIX

See Also:

• Constant Field Values

USERNAME_PREFIX

public static final String USERNAME_PREFIX

See Also:

• Constant Field Values

PASSWORD_PREFIX

public static final String PASSWORD_PREFIX

See Also:

• Constant Field Values

CREDENTIAL_EXPANSION_ALLOWING_PROPERTY

public static final String CREDENTIAL_EXPANSION_ALLOWING_PROPERTY

See Also:

• Constant Field Values

Constructor Details

CredentialResolver

public CredentialResolver()

Method Details

resolve

public Optional<String> resolve(String key,
 Map<?,?> props1,
 Map<?,?> props2,
 Set<String> propsToHide,
 String delimStart,
 String delimStop,
 boolean resolveWithPropertyName)

Description copied from interface: AdditionalStringResolver

Method to implement string resolution.

Parameters are mostly as from StringResolver.substVars(String, Map, Map, Set, String, String, boolean), except the first parameter, key, which is the key to be resolved instead of the full string in which to substitute.

Specified by:

resolve in interface AdditionalStringResolver

Parameters:

key - Key to look up

props1 - First property map in which to look up values

props2 - Second property map in which to look up values

propsToHide - List of properties to hide. If null, then no hiding of properties should be done. If not null, any properties whose name is in the collection will be hidden by the caller but the implementation may make its own decision on hiding property values. For instance, hiding credentials.

delimStart - Start delimiter, normally only needed by caller

delimStop - End delimiter, normally only needed by caller

resolveWithPropertyName - Flag if values should be prefixed with name of resolved property, normally only needed by caller.

Returns:

Resolved property value, or Optional.empty() if it cannot be resolved by this implementation. If Optional.empty() is returned, the StringResolver will then continue to try resolving the key. If any non-empty Optional is returned, the StringResolver will use the value of that as value for the key and not look for other resolutions for the key.

resetAllowedExpansions

protected static void resetAllowedExpansions()