Interface AuthMethodProvider<T>

Type Parameters:
T - type of the API supported by this provider
All Known Implementing Classes:
AppRoleAuthProvider, K8sAuthProvider, TokenAuthProvider

public interface AuthMethodProvider<T>
A Java Service Loader SPI to support additional auth methods of Vault.
  • Method Details

    • supportedMethod

      AuthMethod<T> supportedMethod()
      Supported method by this provider.
      Returns:
      method that is supported, used to choose the correct provider for a method
      See Also:
    • createAuth

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

      default T createAuth(Config config, RestApi restAccess, String path)
      Create an auth instance to provide API to access this method.

      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
      path - path of this auth method instance
      Returns:
      a new secrets instance to be used to access secrets
      Since:
      4.4.0