de.stklcode.jvault.connector.factory

Class HTTPVaultConnectorFactory

java.lang.Object

de.stklcode.jvault.connector.factory.VaultConnectorFactory

de.stklcode.jvault.connector.factory.HTTPVaultConnectorFactory

public final class HTTPVaultConnectorFactory
extends VaultConnectorFactory

Vault Connector Factory implementation for HTTP Vault connectors.

Since:

0.1

Author:

Stefan Kalscheuer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
HTTPVaultConnectorFactory() Default empty constructor.

Method Summary

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.
HTTPVaultConnectorFactory	fromEnv() Build connector based on the VAULT_ADDR} and VAULT_CACERT (optional) environment variables.
HTTPVaultConnectorFactory	withHost(String host) Set hostname (default: 127.0.0.1).
HTTPVaultConnectorFactory	withNumberOfRetries(int numberOfRetries) Define the number of retries to attempt on 5xx errors.
HTTPVaultConnectorFactory	withoutTLS() Convenience Method for NOT using TLS.
HTTPVaultConnectorFactory	withPort(Integer port) Set port (default: 8200).
HTTPVaultConnectorFactory	withPrefix(String prefix) Set API prefix.
HTTPVaultConnectorFactory	withSslContext(SSLContext sslContext) Add a custom SSL context.
HTTPVaultConnectorFactory	withTimeout(int milliseconds) Define a custom timeout for the HTTP connection.
HTTPVaultConnectorFactory	withTLS() Convenience Method for TLS usage (enabled by default).
HTTPVaultConnectorFactory	withTLS(boolean useTLS) Set TLS usage (default: TRUE).
HTTPVaultConnectorFactory	withToken(String token) Set token for automatic authentication, using buildAndAuth().
HTTPVaultConnectorFactory	withTrustedCA(Path cert) Add a trusted CA certifiate for HTTPS connections.

Methods inherited from class de.stklcode.jvault.connector.factory.VaultConnectorFactory

httpFactory

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final Integer DEFAULT_PORT

DEFAULT_TLS

public static final boolean DEFAULT_TLS

See Also:

Constant Field Values

DEFAULT_PREFIX

public static final String DEFAULT_PREFIX

See Also:

Constant Field Values

DEFAULT_NUMBER_OF_RETRIES

public static final int DEFAULT_NUMBER_OF_RETRIES

See Also:

Constant Field Values

Constructor Detail

HTTPVaultConnectorFactory

public HTTPVaultConnectorFactory()

Default empty constructor. Initializes factory with default values.

Method Detail

withHost

public HTTPVaultConnectorFactory withHost(String host)

Set hostname (default: 127.0.0.1).

Parameters:

host - Hostname or IP address

Returns:

self

withPort

public HTTPVaultConnectorFactory withPort(Integer port)

Set port (default: 8200).

Parameters:

port - Vault TCP port

Returns:

self

withTLS

public HTTPVaultConnectorFactory withTLS(boolean useTLS)

Set TLS usage (default: TRUE).

Parameters:

useTLS - use TLS or not

Returns:

self

withTLS

public HTTPVaultConnectorFactory withTLS()

Convenience Method for TLS usage (enabled by default).

Returns:

self

withoutTLS

public HTTPVaultConnectorFactory withoutTLS()

Convenience Method for NOT using TLS.

Returns:

self

withPrefix

public HTTPVaultConnectorFactory withPrefix(String prefix)

Set API prefix. Default is "/v1/" and changes should not be necessary for current state of development.

Parameters:

prefix - Vault API prefix (default: "/v1/"

Returns:

self

withTrustedCA

public HTTPVaultConnectorFactory withTrustedCA(Path cert)
                                        throws VaultConnectorException

Add a trusted CA certifiate for HTTPS connections.

Parameters:

cert - path to certificate file

Returns:

self

Throws:

VaultConnectorException - on error

Since:

0.4.0

withSslContext

public HTTPVaultConnectorFactory withSslContext(SSLContext sslContext)

Add a custom SSL context. Overwrites certificates set by withTrustedCA(java.nio.file.Path).

Parameters:

sslContext - the SSL context

Returns:

self

Since:

0.4.0

withToken

public HTTPVaultConnectorFactory withToken(String token)

Set token for automatic authentication, using buildAndAuth().

Parameters:

token - Vault token

Returns:

self

Since:

0.6.0

fromEnv

public HTTPVaultConnectorFactory fromEnv()
                                  throws VaultConnectorException

Build connector based on the VAULT_ADDR} and VAULT_CACERT (optional) environment variables.

Returns:

self

Throws:

VaultConnectorException - if Vault address from environment variables is malformed

Since:

0.6.0

withNumberOfRetries

public HTTPVaultConnectorFactory withNumberOfRetries(int numberOfRetries)

Define the number of retries to attempt on 5xx errors.

Parameters:

numberOfRetries - The number of retries to attempt on 5xx errors (default: 0)

Returns:

self

Since:

0.6.0

withTimeout

public HTTPVaultConnectorFactory withTimeout(int milliseconds)

Define a custom timeout for the HTTP connection.

Parameters:

milliseconds - Timeout value in milliseconds.

Returns:

self

Since:

0.6.0

build

public HTTPVaultConnector build()

Description copied from class: VaultConnectorFactory

Build command, produces connector after initialization.

Specified by:

build in class VaultConnectorFactory

Returns:

Vault Connector instance.

buildAndAuth

public HTTPVaultConnector buildAndAuth()
                                throws VaultConnectorException

Description copied from class: VaultConnectorFactory

Build connector and authenticate with token set in factory or from environment.

Specified by:

buildAndAuth in class VaultConnectorFactory

Returns:

Authenticated Vault connector instance.

Throws:

VaultConnectorException - if authentication failed