public final class HTTPVaultConnectorBuilder extends Object implements VaultConnectorBuilder
Modifier and Type | Field and Description |
---|---|
static String |
DEFAULT_HOST |
static int |
DEFAULT_NUMBER_OF_RETRIES |
static Integer |
DEFAULT_PORT |
static String |
DEFAULT_PREFIX |
static boolean |
DEFAULT_TLS |
static String |
DEFAULT_TLS_VERSION |
Constructor and Description |
---|
HTTPVaultConnectorBuilder()
Default empty constructor.
|
Modifier and Type | Method and Description |
---|---|
HTTPVaultConnector |
build()
Build command, produces connector after initialization.
|
HTTPVaultConnector |
buildAndAuth()
Build connector and authenticate with token set in factory or from environment.
|
HTTPVaultConnectorBuilder |
fromEnv()
Build connector based on the VAULT_ADDR} and
VAULT_CACERT (optional) environment variables. |
HTTPVaultConnectorBuilder |
withHost(String host)
Set hostname (default: 127.0.0.1).
|
HTTPVaultConnectorBuilder |
withNumberOfRetries(int numberOfRetries)
Define the number of retries to attempt on 5xx errors.
|
HTTPVaultConnectorBuilder |
withoutTLS()
Convenience Method for NOT using TLS.
|
HTTPVaultConnectorBuilder |
withPort(Integer port)
Set port (default: 8200).
|
HTTPVaultConnectorBuilder |
withPrefix(String prefix)
Set API prefix.
|
HTTPVaultConnectorBuilder |
withTimeout(int milliseconds)
Define a custom timeout for the HTTP connection.
|
HTTPVaultConnectorBuilder |
withTLS()
Convenience Method for TLS usage (enabled by default).
|
HTTPVaultConnectorBuilder |
withTLS(boolean useTLS)
Set TLS usage (default: TRUE).
|
HTTPVaultConnectorBuilder |
withTLS(boolean useTLS,
String version)
Set TLS usage (default: TRUE).
|
HTTPVaultConnectorBuilder |
withTLS(String version)
Convenience Method for TLS usage (enabled by default).
|
HTTPVaultConnectorBuilder |
withToken(String token)
Set token for automatic authentication, using
buildAndAuth() . |
HTTPVaultConnectorBuilder |
withTrustedCA(Path cert)
Add a trusted CA certifiate for HTTPS connections.
|
HTTPVaultConnectorBuilder |
withTrustedCA(X509Certificate cert)
Add a trusted CA certifiate for HTTPS connections.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
http
public static final String DEFAULT_HOST
public static final Integer DEFAULT_PORT
public static final boolean DEFAULT_TLS
public static final String DEFAULT_TLS_VERSION
public static final String DEFAULT_PREFIX
public static final int DEFAULT_NUMBER_OF_RETRIES
public HTTPVaultConnectorBuilder()
public HTTPVaultConnectorBuilder withHost(String host)
host
- Hostname or IP addresspublic HTTPVaultConnectorBuilder withPort(Integer port)
port
- Vault TCP portpublic HTTPVaultConnectorBuilder withTLS(boolean useTLS)
useTLS
- use TLS or notpublic HTTPVaultConnectorBuilder withTLS(boolean useTLS, String version)
useTLS
- Use TLS or not.version
- Supported TLS version (TLSv1.2
, TLSv1.1
, TLSv1.0
, TLS
).public HTTPVaultConnectorBuilder withTLS(String version)
version
- Supported TLS version (TLSv1.2
, TLSv1.1
, TLSv1.0
, TLS
).public HTTPVaultConnectorBuilder withTLS()
public HTTPVaultConnectorBuilder withoutTLS()
public HTTPVaultConnectorBuilder withPrefix(String prefix)
prefix
- Vault API prefix (default: "/v1/"public HTTPVaultConnectorBuilder withTrustedCA(Path cert) throws VaultConnectorException
cert
- path to certificate fileVaultConnectorException
- on errorpublic HTTPVaultConnectorBuilder withTrustedCA(X509Certificate cert)
cert
- path to certificate filepublic HTTPVaultConnectorBuilder withToken(String token)
buildAndAuth()
.token
- Vault tokenpublic HTTPVaultConnectorBuilder fromEnv() throws VaultConnectorException
VAULT_CACERT
(optional) environment variables.VaultConnectorException
- if Vault address from environment variables is malformedpublic HTTPVaultConnectorBuilder withNumberOfRetries(int numberOfRetries)
numberOfRetries
- The number of retries to attempt on 5xx errors (default: 0)public HTTPVaultConnectorBuilder withTimeout(int milliseconds)
milliseconds
- Timeout value in milliseconds.public HTTPVaultConnector build()
VaultConnectorBuilder
build
in interface VaultConnectorBuilder
public HTTPVaultConnector buildAndAuth() throws VaultConnectorException
VaultConnectorBuilder
buildAndAuth
in interface VaultConnectorBuilder
VaultConnectorException
- if authentication failedCopyright © 2016–2019. All rights reserved.