Package io.smallrye.config

Interface SecretKeysHandler

All Known Implementing Classes:
SecretKeysHandlerFactory.LazySecretKeysHandler
public interface SecretKeysHandler
A SecretKeysHandler provides a way to decode or decrypt a secret configuration value.

A secret configuration value may be expressed as ${handler::value}, where the handler is the name of the SecretKeysHandler to use for decode or decryption the value separated by a double colon ::.

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

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    decode(String secret)
    Decodes the secret configuration value.
    String
    getName()
    The name of SecretKeysHandler.

  • Method Details

    • decode

      String decode(String secret)
      Decodes the secret configuration value.
      Parameters:
      secret - the value to decode.
      Returns:
      the secret decoded.

    • getName

      String getName()
      The name of SecretKeysHandler.
      Returns:
      the name of the SecretKeysHandler.