Module io.helidon.integrations.vault.sys
Package io.helidon.integrations.vault.sys

Class EnableAuth.Request

java.lang.Object
io.helidon.integrations.common.rest.ApiJsonBuilder<EnableAuth.Request>
io.helidon.integrations.common.rest.ApiJsonRequest<EnableAuth.Request>
io.helidon.integrations.vault.VaultRequest<EnableAuth.Request>
io.helidon.integrations.vault.sys.EnableAuth.Request
All Implemented Interfaces:
ApiRequest<EnableAuth.Request>
Enclosing class:
EnableAuth
public static final class EnableAuth.Request extends VaultRequest<EnableAuth.Request>
Request object. Can be configured with additional headers, query parameters etc.

  • Method Details

    • builder

      public static EnableAuth.Request builder()
      Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(jakarta.json.JsonBuilderFactory) used by the RestApi.
      Returns:
      new request builder

    • auth

      public EnableAuth.Request auth(AuthMethod<?> auth)
      Authentication method to enable. Custom path can be configured through path(String).
      Parameters:
      auth - authentication method to enable
      Returns:
      updated request

    • path

      public EnableAuth.Request path(String path)
      Specifies the path where the engine/method will be mounted. If no path is defined, the engine/method default path will be used.
      Parameters:
      path - path to configure
      Returns:
      updated request

    • description

      public EnableAuth.Request description(String description)
      Specifies the human-friendly description of the mount.
      Parameters:
      description - description
      Returns:
      updated request

    • defaultLeaseTtl

      public EnableAuth.Request defaultLeaseTtl(Duration defaultLeaseTtl)
      Default lease duration.
      Parameters:
      defaultLeaseTtl - lease time to live
      Returns:
      updated request

    • maxLeaseTtl

      public EnableAuth.Request maxLeaseTtl(Duration maxLeaseTtl)
      Maximum lease duration.
      Parameters:
      maxLeaseTtl - maximum lease time to live
      Returns:
      updated request

    • forceNoCache

      public EnableAuth.Request forceNoCache(boolean forceNoCache)
      Disable caching.

      Defaults to false.

      Parameters:
      forceNoCache - whether to disable caching
      Returns:
      updated request

    • addPassThroughHeader

      public EnableAuth.Request addPassThroughHeader(String passThroughHeader)
      Add header to whitelist and pass from the request to the plugin.
      Parameters:
      passThroughHeader - name of the header
      Returns:
      updated request

    • addAllowedResponseHeader

      public EnableAuth.Request addAllowedResponseHeader(String allowedResponseHeader)
      Header to whitelist, allowing a plugin to include them in the response.
      Parameters:
      allowedResponseHeader - name of the header
      Returns:
      updated request

    • postBuild

      protected void postBuild(JsonBuilderFactory factory, JsonObjectBuilder payload)
      Description copied from class: ApiJsonBuilder
      Called after adding properties defined in this request.
      Overrides:
      postBuild in class ApiJsonBuilder<T extends io.helidon.integrations.vault.sys.MountRequest<T>>
      Parameters:
      factory - json factory
      payload - payload builder

    • defaultPath

      protected void defaultPath(String defaultMount)
      Specifies the default path where the engine/method will be mounted, if no path is defined.
      Parameters:
      defaultMount - default path to configure