Interface SecretsEngineProvider<T extends Secrets>

Type Parameters:
T - type of the secrets supported by this provider
All Known Implementing Classes:
CubbyholeEngineProvider, DbEngineProvider, Kv1EngineProvider, Kv2EngineProvider, PkiEngineProvider, TransitEngineProvider

public interface SecretsEngineProvider<T extends Secrets>
A Java Service Loader SPI to support additional secret engines of Vault.
  • Method Details

    • supportedEngine

      Engine<T> supportedEngine()
      Supported engine by this provider.
      Returns:
      engine that is supported, used to choose the correct provider for an engine
      See Also:
    • createSecrets

      @Deprecated(since="4.4.0", forRemoval=true) default T createSecrets(Config config, RestApi restAccess, String mount)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Create a secrets instance to provide API to access this engine.
      Parameters:
      config - configuration that can be used to customize the engine
      restAccess - to access REST API of the vault, preconfigured with token
      mount - mount point of this engine's secrets
      Returns:
      a new secrets instance to be used to access secrets
    • createSecrets

      default T createSecrets(Config config, RestApi restAccess, String mount)
      Create a secrets instance to provide API to access this engine.

      API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version

      Parameters:
      config - configuration that can be used to customize the engine
      restAccess - to access REST API of the vault, preconfigured with token
      mount - mount point of this engine's secrets
      Returns:
      a new secrets instance to be used to access secrets\
      Since:
      4.4.0