org.apache.nifi.vault.hashicorp.config

Class HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder

java.lang.Object

org.apache.nifi.vault.hashicorp.config.HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder

Enclosing class:

HashiCorpVaultProperties

public static class HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder
extends Object

Builder for HashiCorpVaultProperties. The only properties that are considered mandatory are uri and authPropertiesFilename.

Field Summary

Fields

Modifier and Type	Field and Description
private String	authPropertiesFilename
private String	connectionTimeout
private String	enabledTlsCipherSuites
private String	enabledTlsProtocols
private String	keyStore
private String	keyStorePassword
private String	keyStoreType
private String	readTimeout
private String	trustStore
private String	trustStorePassword
private String	trustStoreType
private String	uri

Constructor Summary

Constructors

Constructor and Description
HashiCorpVaultPropertiesBuilder()

Method Summary

Modifier and Type	Method and Description
HashiCorpVaultProperties	build() Build the VaultProperties.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setAuthPropertiesFilename(String authPropertiesFilename) Sets the path to the vault authentication properties file.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setConnectionTimeout(String connectionTimeout) Sets the connection timeout for the HTTP client, using the standard NiFi duration format (e.g., 5 secs)
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setEnabledTlsCipherSuites(String enabledTlsCipherSuites) Sets an optional comma-separated list of enabled TLS cipher suites.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setEnabledTlsProtocols(String enabledTlsProtocols) Sets an optional comma-separated list of enabled TLS protocols.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setKeyStore(String keyStore) Sets the path to the keyStore.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setKeyStorePassword(String keyStorePassword) Sets the keyStore password.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setKeyStoreType(String keyStoreType) Sets keyStore type (e.g., JKS, PKCS12).
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setReadTimeout(String readTimeout) Sets the read timeout for the HTTP client, using the standard NiFi duration format (e.g., 15 secs).
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setTrustStore(String trustStore) Sets the path to the trustStore.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setTrustStorePassword(String trustStorePassword) Sets the trustStore passsword.
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setTrustStoreType(String trustStoreType) Sets the trustStore type (e.g., JKS, PKCS12).
HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder	setUri(String uri) Set the Vault URI (e.g., http://localhost:8200).

Methods inherited from class java.lang.Object

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

Field Detail

uri

private String uri

keyStore

private String keyStore

keyStoreType

private String keyStoreType

keyStorePassword

private String keyStorePassword

trustStore

private String trustStore

trustStoreType

private String trustStoreType

trustStorePassword

private String trustStorePassword

authPropertiesFilename

private String authPropertiesFilename

enabledTlsCipherSuites

private String enabledTlsCipherSuites

enabledTlsProtocols

private String enabledTlsProtocols

connectionTimeout

private String connectionTimeout

readTimeout

private String readTimeout

Constructor Detail

HashiCorpVaultPropertiesBuilder

public HashiCorpVaultPropertiesBuilder()

Method Detail

setUri

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setUri(String uri)

Set the Vault URI (e.g., http://localhost:8200). If using https protocol, the KeyStore and TrustStore properties are expected to also be set.

Parameters:

uri - Vault's URI

Returns:

setKeyStore

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setKeyStore(String keyStore)

Sets the path to the keyStore.

Parameters:

keyStore - Path to the keyStore

Returns:

setKeyStoreType

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setKeyStoreType(String keyStoreType)

Sets keyStore type (e.g., JKS, PKCS12).

Parameters:

keyStoreType - KeyStore type

Returns:

setKeyStorePassword

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setKeyStorePassword(String keyStorePassword)

Sets the keyStore password.

Parameters:

keyStorePassword - KeyStore password

Returns:

setTrustStore

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setTrustStore(String trustStore)

Sets the path to the trustStore.

Parameters:

trustStore - Path to the trustStore

Returns:

setTrustStoreType

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setTrustStoreType(String trustStoreType)

Sets the trustStore type (e.g., JKS, PKCS12).

Parameters:

trustStoreType - TrustStore type

Returns:

setTrustStorePassword

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setTrustStorePassword(String trustStorePassword)

Sets the trustStore passsword.

Parameters:

trustStorePassword - TrustStore password

Returns:

setAuthPropertiesFilename

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setAuthPropertiesFilename(String authPropertiesFilename)

Sets the path to the vault authentication properties file. See the following link for valid vault authentication properties (default is vault.authentication=TOKEN, expecting a vault.token property to be supplied).

Parameters:

authPropertiesFilename - The filename of a properties file containing Spring Vault authentication properties

Returns:

See Also:

https://docs.spring.io/spring-vault/docs/2.3.1/reference/html/#vault.core.environment-vault-configuration

setEnabledTlsCipherSuites

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setEnabledTlsCipherSuites(String enabledTlsCipherSuites)

Sets an optional comma-separated list of enabled TLS cipher suites.

Parameters:

enabledTlsCipherSuites - Enabled TLS cipher suites (only these will be enabled)

Returns:

setEnabledTlsProtocols

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setEnabledTlsProtocols(String enabledTlsProtocols)

Sets an optional comma-separated list of enabled TLS protocols.

Parameters:

enabledTlsProtocols - Enabled TLS protocols (only these will be enabled)

Returns:

setConnectionTimeout

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setConnectionTimeout(String connectionTimeout)

Sets the connection timeout for the HTTP client, using the standard NiFi duration format (e.g., 5 secs)

Parameters:

connectionTimeout - Connection timeout (default is 5 secs)

Returns:

setReadTimeout

public HashiCorpVaultProperties.HashiCorpVaultPropertiesBuilder setReadTimeout(String readTimeout)

Sets the read timeout for the HTTP client, using the standard NiFi duration format (e.g., 15 secs).

Parameters:

readTimeout - Read timeout (default is 15 secs)

Returns:

build

public HashiCorpVaultProperties build()

Build the VaultProperties.

Returns: