io.micronaut.discovery.vault.config

Class VaultClientConfiguration

java.lang.Object

io.micronaut.http.client.HttpClientConfiguration

io.micronaut.discovery.vault.config.VaultClientConfiguration

@ConfigurationProperties(value="vault.client")
public class VaultClientConfiguration
extends HttpClientConfiguration

A HttpClientConfiguration for Vault Client.

Since:

1.2.0

Author:

thiagolocatelli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultClientConfiguration.VaultClientConnectionPoolConfiguration The Http Pool Connection Configuration class for Vault.
static class	VaultClientConfiguration.VaultClientDiscoveryConfiguration The Discovery Configuration class for Vault.
static class	VaultClientConfiguration.VaultKvVersion Vault Secret Engine versions.

Nested classes/interfaces inherited from class io.micronaut.http.client.HttpClientConfiguration

HttpClientConfiguration.ConnectionPoolConfiguration

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX
static java.lang.String	VAULT_CLIENT_CONFIG_ENDPOINT Vault Server Endpoint.

Fields inherited from class io.micronaut.http.client.HttpClientConfiguration

DEFAULT_EXCEPTION_ON_ERROR_STATUS, DEFAULT_FOLLOW_REDIRECTS, DEFAULT_MAX_CONTENT_LENGTH, DEFAULT_READ_IDLE_TIMEOUT_MINUTES, DEFAULT_READ_TIMEOUT_SECONDS, DEFAULT_SHUTDOWN_TIMEOUT_MILLISECONDS

Constructor Summary

Constructors

Constructor and Description
VaultClientConfiguration(VaultClientConfiguration.VaultClientConnectionPoolConfiguration vaultClientConnectionPoolConfiguration, ApplicationConfiguration applicationConfiguration)

Method Summary

Modifier and Type	Method and Description
HttpClientConfiguration.ConnectionPoolConfiguration	getConnectionPoolConfiguration() Obtains the connection pool configuration.
VaultClientConfiguration.VaultClientDiscoveryConfiguration	getDiscoveryConfiguration()
VaultClientConfiguration.VaultKvVersion	getKvVersion()
java.lang.String	getSecretEngineName()
java.lang.String	getToken()
java.lang.String	getUri()
boolean	isFailFast()
void	setFailFast(boolean failFast) If set to true an exception will be thrown if configuration is not found for the application or any of its environments.
void	setKvVersion(VaultClientConfiguration.VaultKvVersion kvVersion) Set the version of the Vault Secret engine.
void	setSecretEngineName(java.lang.String secretEngineName) Set the name of the Vault Secret engine name.
void	setToken(java.lang.String token) Set the Vault authentication token.
void	setUri(java.lang.String uri) Set the Vault Server Uri.

Methods inherited from class io.micronaut.http.client.HttpClientConfiguration

getChannelOptions, getConnectTimeout, getConnectTtl, getDefaultCharset, getEventLoopGroup, getHttpVersion, getLoggerName, getLogLevel, getMaxContentLength, getNumOfThreads, getProxyAddress, getProxyPassword, getProxySelector, getProxyType, getProxyUsername, getReadIdleTimeout, getReadTimeout, getShutdownTimeout, getSslConfiguration, getThreadFactory, isExceptionOnErrorStatus, isFollowRedirects, resolveProxy, setChannelOptions, setConnectTimeout, setConnectTtl, setDefaultCharset, setEventLoopGroup, setExceptionOnErrorStatus, setFollowRedirects, setHttpVersion, setLoggerName, setLogLevel, setMaxContentLength, setNumOfThreads, setProxyAddress, setProxyPassword, setProxySelector, setProxyType, setProxyUsername, setReadIdleTimeout, setReadTimeout, setShutdownTimeout, setSslConfiguration, setThreadFactory

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

VAULT_CLIENT_CONFIG_ENDPOINT

public static final java.lang.String VAULT_CLIENT_CONFIG_ENDPOINT

Vault Server Endpoint.

See Also:

Constant Field Values

Constructor Detail

VaultClientConfiguration

@Inject
public VaultClientConfiguration(VaultClientConfiguration.VaultClientConnectionPoolConfiguration vaultClientConnectionPoolConfiguration,
                                        ApplicationConfiguration applicationConfiguration)

Parameters:

vaultClientConnectionPoolConfiguration - Vault Client Connection Pool Configuration

applicationConfiguration - Application Configuration

Method Detail

getConnectionPoolConfiguration

public HttpClientConfiguration.ConnectionPoolConfiguration getConnectionPoolConfiguration()

Description copied from class: HttpClientConfiguration

Obtains the connection pool configuration.

Specified by:

getConnectionPoolConfiguration in class HttpClientConfiguration

Returns:

The connection pool configuration.

getDiscoveryConfiguration

public VaultClientConfiguration.VaultClientDiscoveryConfiguration getDiscoveryConfiguration()

Returns:

The discovery service configuration

getUri

public java.lang.String getUri()

Returns:

The Vault Server Uri

setUri

public void setUri(java.lang.String uri)

Set the Vault Server Uri. Default value ().

Parameters:

uri - Vault Server Uri

getToken

public java.lang.String getToken()

Returns:

The Vault authentication token

setToken

public void setToken(java.lang.String token)

Set the Vault authentication token.

Parameters:

token - Vault authentication token

getKvVersion

public VaultClientConfiguration.VaultKvVersion getKvVersion()

Returns:

The Vault Secret engine version

setKvVersion

public void setKvVersion(VaultClientConfiguration.VaultKvVersion kvVersion)

Set the version of the Vault Secret engine. V1 or V2. Default value (V2).

Parameters:

kvVersion - The version of the Vault Secret engine

getSecretEngineName

public java.lang.String getSecretEngineName()

Returns:

The Vault Secret engine name

setSecretEngineName

public void setSecretEngineName(java.lang.String secretEngineName)

Set the name of the Vault Secret engine name. Default value ().

Parameters:

secretEngineName - Vault Secret engine name

isFailFast

public boolean isFailFast()

Returns:

Flag to indicate that failure to connect to HashiCorp Vault is fatal (default false).

setFailFast

public void setFailFast(boolean failFast)

If set to true an exception will be thrown if configuration is not found for the application or any of its environments. Default value ().

Parameters:

failFast - Flag to fail fast