Package org.springframework.vault.client

Interface VaultClient.Builder

Enclosing interface:

VaultClient

public static interface VaultClient.Builder

A mutable builder for creating a VaultClient.

Method Summary

Modifier and Type	Method	Description
VaultClient.Builder	apply(Consumer<VaultClient.Builder> builderConsumer)	Apply the given Consumer to this builder instance.
VaultClient	build()	Build the VaultClient instance.
VaultClient.Builder	clone()	Clone this VaultClient.Builder.
VaultClient.Builder	configureRestClient(Consumer<RestClient.Builder> restClientBuilderConsumer)	Provide a consumer to access RestClient.Builder with the possibility to override or augment its configuration.
VaultClient.Builder	defaultHeader(String header, String... values)	Global option to specify a header to be added to every request, if the request does not already contain such a header.
default VaultClient.Builder	defaultNamespace(String namespace)	Global option to specify a namespace header to be added to every request, if the request does not already contain such a header.
VaultClient.Builder	endpoint(VaultEndpoint endpoint)	Set the Vault endpoint to use.
VaultClient.Builder	endpoint(VaultEndpointProvider endpointProvider)	Set the Vault endpoint provider to use.
VaultClient.Builder	requestFactory(ClientHttpRequestFactory requestFactory)	Configure the ClientHttpRequestFactory to use.
VaultClient.Builder	uriBuilderFactory(UriBuilderFactory uriBuilderFactory)	Provide a pre-configured UriBuilderFactory instance.

Method Details

endpoint

VaultClient.Builder endpoint(VaultEndpoint endpoint)

Set the Vault endpoint to use.

Parameters:

endpoint - the vault endpoint to use.

Returns:

this builder.

endpoint

VaultClient.Builder endpoint(VaultEndpointProvider endpointProvider)

Set the Vault endpoint provider to use.

Parameters:

endpointProvider - the vault endpoint provider to use.

Returns:

this builder.

uriBuilderFactory

VaultClient.Builder uriBuilderFactory(UriBuilderFactory uriBuilderFactory)

Provide a pre-configured UriBuilderFactory instance. This is an alternative to, and effectively overrides the following shortcut properties:

• endpoint(VaultEndpoint)}
• endpoint(VaultEndpointProvider)}.

Parameters:

uriBuilderFactory - the URI builder factory to use.

Returns:

this builder.

See Also:

• endpoint(VaultEndpoint)
• endpoint(VaultEndpointProvider)
• VaultClients.createUriBuilderFactory(VaultEndpointProvider)

defaultNamespace

default VaultClient.Builder defaultNamespace(String namespace)

Global option to specify a namespace header to be added to every request, if the request does not already contain such a header.

Parameters:

namespace - the namespace header value.

Returns:

this builder.

defaultHeader

VaultClient.Builder defaultHeader(String header,
 String... values)

Global option to specify a header to be added to every request, if the request does not already contain such a header.

Parameters:

header - the header name.

values - the header values.

Returns:

this builder.

requestFactory

VaultClient.Builder requestFactory(ClientHttpRequestFactory requestFactory)

Configure the ClientHttpRequestFactory to use. This is useful for plugging in and/or customizing options of the underlying HTTP client library (for example, SSL).

If no request factory is specified, VaultClient uses Apache Http Client, Jetty Http Client if available on the classpath, and defaults to the JDK HttpClient if the java.net.http module is loaded, or to a simple default otherwise.

Parameters:

requestFactory - the request factory to use.

Returns:

this builder.

configureRestClient

VaultClient.Builder configureRestClient(Consumer<RestClient.Builder> restClientBuilderConsumer)

Provide a consumer to access RestClient.Builder with the possibility to override or augment its configuration.

Parameters:

restClientBuilderConsumer - the consumer.

Returns:

this builder.

apply

VaultClient.Builder apply(Consumer<VaultClient.Builder> builderConsumer)

Apply the given Consumer to this builder instance.

This can be useful for applying pre-packaged customizations.

Parameters:

builderConsumer - the consumer to apply

Returns:

this builder

clone

VaultClient.Builder clone()

Clone this VaultClient.Builder.

build

VaultClient build()

Build the VaultClient instance.