Module io.helidon.integrations.vault.sys

Package io.helidon.integrations.vault.sys

Class EnableAuth.Request

java.lang.Object

io.helidon.integrations.common.rest.ApiJsonBuilder<T>

io.helidon.integrations.common.rest.ApiJsonRequest<T>

io.helidon.integrations.vault.VaultRequest<T>

io.helidon.integrations.vault.sys.EnableAuth.Request

All Implemented Interfaces:

ApiRequest<EnableAuth.Request>

Enclosing class:

EnableAuth

public static final class EnableAuth.Request
extends VaultRequest<T>

Request object. Can be configured with additional headers, query parameters etc.

Method Summary

Modifier and Type	Method	Description
T	addAllowedResponseHeader(String allowedResponseHeader)	Header to whitelist, allowing a plugin to include them in the response.
T	addPassThroughHeader(String passThroughHeader)	Add header to whitelist and pass from the request to the plugin.
EnableAuth.Request	auth(AuthMethod<?> auth)	Authentication method to enable.
static EnableAuth.Request	builder()	Fluent API builder for configuring a request.
T	defaultLeaseTtl(Duration defaultLeaseTtl)	Default lease duration.
protected void	defaultPath(String defaultMount)
T	description(String description)	Specifies the human-friendly description of the mount.
T	forceNoCache(boolean forceNoCache)	Disable caching.
T	maxLeaseTtl(Duration maxLeaseTtl)	Maximum lease duration.
T	path(String path)	Specifies the path where the engine/method will be mounted.
protected void	postBuild(JsonBuilderFactory factory, JsonObjectBuilder payload)	Called after adding properties defined in this request.

Methods inherited from class io.helidon.integrations.vault.VaultRequest

add, addCommaDelimitedArray, addToCommaDelimitedArray, durationToTtl, preBuild

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonRequest

addHeader, addQueryParam, headers, queryParams, requestId, requestId, requestMediaType, requestMediaType, responseMediaType, responseMediaType

Methods inherited from class io.helidon.integrations.common.rest.ApiJsonBuilder

add, add, add, add, add, add, addBase64, addToArray, addToArray, addToArray, addToArray, addToArray, addToArray, addToObject, addToObject, addToObject, addToObject, addToObject, emptyArray, me, toJson

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.integrations.common.rest.ApiRequest

toJson

Method Detail

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(javax.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 T 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 T description(String description)

Specifies the human-friendly description of the mount.

Parameters:

description - description

Returns:

updated request

defaultLeaseTtl

public T defaultLeaseTtl(Duration defaultLeaseTtl)

Default lease duration.

Parameters:

defaultLeaseTtl - lease time to live

Returns:

updated request

maxLeaseTtl

public T maxLeaseTtl(Duration maxLeaseTtl)

Maximum lease duration.

Parameters:

maxLeaseTtl - maximum lease time to live

Returns:

updated request

forceNoCache

public T forceNoCache(boolean forceNoCache)

Disable caching.

Defaults to false.

Parameters:

forceNoCache - whether to disable caching

Returns:

updated request

addPassThroughHeader

public T 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 T 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)