Package io.smallrye.config

Interface SecretKeysHandlerFactory

public interface SecretKeysHandlerFactory

This SecretKeysHandlerFactory allows to initialize a SecretKeysHandler, with access to the current ConfigSourceContext.

Instances of this interface will be discovered via the ServiceLoader mechanism and can be registered by providing a META-INF/services/io.smallrye.config.SecretKeysHandlerFactory file, which contains the fully qualified class name of the custom SecretKeysHandlerFactory implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SecretKeysHandlerFactory.LazySecretKeysHandler	Defers the initialization of a SecretKeysHandlerFactory to only when a value requires decoding.

Method Summary

Modifier and Type	Method	Description
String	getName()	The name of SecretKeysHandler.
SecretKeysHandler	getSecretKeysHandler(ConfigSourceContext context)	Gets the SecretKeysHandler from the SecretKeysHandlerFactory.

Method Details

getSecretKeysHandler

SecretKeysHandler getSecretKeysHandler(ConfigSourceContext context)

Gets the SecretKeysHandler from the SecretKeysHandlerFactory. Implementations of this method must provide an instance of the SecretKeysHandler to decode secret configuration values by the SecretKeysHandler name.

Parameters:

context - the current ConfigSourceContext with access to the current configuration sources.

Returns:

the SecretKeysHandler to decode secret configuration values with the name getName().

getName

String getName()

The name of SecretKeysHandler.

Returns:

the name of the SecretKeysHandler.