Class VaultClient.Builder

java.lang.Object
codes.grow.packages.vault.VaultClient.Builder
Enclosing class:
VaultClient

public static final class VaultClient.Builder extends Object
Builder that configures and creates a client in one chain.
  • Method Details

    • fromEnv

      public VaultClient.Builder fromEnv(EnvReader env)
      Fills unset fields from an environment reader.
      Parameters:
      env - reader, e.g. EnvReader.system()
      Returns:
      this builder
    • url

      public VaultClient.Builder url(String url)
      Sets the endpoint base URL.
      Parameters:
      url - URL
      Returns:
      this builder
    • token

      public VaultClient.Builder token(String token)
      Sets the API token.
      Parameters:
      token - token
      Returns:
      this builder
    • token

      public VaultClient.Builder token(Secret token)
      Sets the API token.
      Parameters:
      token - token
      Returns:
      this builder
    • connectTimeout

      public VaultClient.Builder connectTimeout(Duration d)
      Sets the connect timeout.
      Parameters:
      d - duration
      Returns:
      this builder
    • requestTimeout

      public VaultClient.Builder requestTimeout(Duration d)
      Sets the per-attempt timeout.
      Parameters:
      d - duration
      Returns:
      this builder
    • totalTimeout

      public VaultClient.Builder totalTimeout(Duration d)
      Sets the total timeout.
      Parameters:
      d - duration
      Returns:
      this builder
    • retry

      public VaultClient.Builder retry(RetryPolicy retry)
      Sets the retry policy.
      Parameters:
      retry - policy
      Returns:
      this builder
    • tls

      public VaultClient.Builder tls(TlsOptions tls)
      Sets the TLS options.
      Parameters:
      tls - options
      Returns:
      this builder
    • proxy

      public VaultClient.Builder proxy(String proxy)
      Sets the proxy URL.
      Parameters:
      proxy - URL
      Returns:
      this builder
    • header

      public VaultClient.Builder header(String name, String value)
      Adds a header.
      Parameters:
      name - name
      value - value
      Returns:
      this builder
    • userAgentSuffix

      public VaultClient.Builder userAgentSuffix(String suffix)
      Sets the user agent suffix.
      Parameters:
      suffix - suffix
      Returns:
      this builder
    • hooks

      public VaultClient.Builder hooks(Hooks hooks)
      Sets hooks.
      Parameters:
      hooks - hooks
      Returns:
      this builder
    • logger

      public VaultClient.Builder logger(Logger logger)
      Sets the logger.
      Parameters:
      logger - logger
      Returns:
      this builder
    • namespace

      public VaultClient.Builder namespace(String namespace)
      Sets the namespace (X-Vault-Namespace).
      Parameters:
      namespace - namespace
      Returns:
      this builder
    • kvMount

      public VaultClient.Builder kvMount(String kvMount)
      Sets the default KV mount.
      Parameters:
      kvMount - mount path
      Returns:
      this builder
    • kvVersion

      public VaultClient.Builder kvVersion(int kvVersion)
      Fixes the KV version (skips auto-detection).
      Parameters:
      kvVersion - 1 or 2
      Returns:
      this builder
    • build

      public VaultClient build()
      Builds the configuration and the client.
      Returns:
      a new client
      Throws:
      ConfigException - when the configuration is invalid