Class VaultKeyValueBackendProperties

java.lang.Object

org.springframework.cloud.vault.config.VaultKeyValueBackendProperties

All Implemented Interfaces:

org.springframework.beans.factory.Aware, VaultKeyValueBackendPropertiesSupport, org.springframework.context.EnvironmentAware

@ConfigurationProperties("spring.cloud.vault.kv")
@Validated
public class VaultKeyValueBackendProperties
extends Object
implements org.springframework.context.EnvironmentAware, VaultKeyValueBackendPropertiesSupport

Configuration properties for Vault using the key-value backend.

Since:

2.0

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	Configuration prefix for config properties.

Constructor Summary

Constructors

Constructor	Description
VaultKeyValueBackendProperties()

Method Summary

Modifier and Type	Method	Description
String	getApplicationName()
String	getBackend()
int	getBackendVersion()	Deprecated.
String	getDefaultContext()
List<String>	getProfiles()
String	getProfileSeparator()
boolean	isEnabled()
void	setApplicationName(String applicationName)
void	setBackend(String backend)
void	setBackendVersion(int backendVersion)
void	setDefaultContext(String defaultContext)
void	setEnabled(boolean enabled)
void	setEnvironment(org.springframework.core.env.Environment environment)
void	setProfiles(List<String> profiles)
void	setProfileSeparator(String profileSeparator)
String	toString()

Methods inherited from class Object

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

Field Details

PREFIX

public static final String PREFIX

Configuration prefix for config properties.

See Also:

• Constant Field Values

Constructor Details

VaultKeyValueBackendProperties

public VaultKeyValueBackendProperties()

Method Details

setEnvironment

public void setEnvironment(org.springframework.core.env.Environment environment)

Specified by:

setEnvironment in interface org.springframework.context.EnvironmentAware

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface VaultKeyValueBackendPropertiesSupport

Returns:

true if this backend configuration is enabled; false otherwise.

getBackend

public String getBackend()

Specified by:

getBackend in interface VaultKeyValueBackendPropertiesSupport

Returns:

mound path of the secret backend.

getDefaultContext

public String getDefaultContext()

Specified by:

getDefaultContext in interface VaultKeyValueBackendPropertiesSupport

Returns:

default context path. Can be empty.

getProfileSeparator

public String getProfileSeparator()

Specified by:

getProfileSeparator in interface VaultKeyValueBackendPropertiesSupport

Returns:

profile separator character.

getApplicationName

public String getApplicationName()

Specified by:

getApplicationName in interface VaultKeyValueBackendPropertiesSupport

Returns:

the application name to use.

getProfiles

public List<String> getProfiles()

Specified by:

getProfiles in interface VaultKeyValueBackendPropertiesSupport

Returns:

the application profiles to use.

getBackendVersion

@Deprecated
@DeprecatedConfigurationProperty(reason="Backend version no longer required. The kv version is determined during secret retrieval")
public int getBackendVersion()

Deprecated.

setEnabled

public void setEnabled(boolean enabled)

setBackend

public void setBackend(String backend)

setDefaultContext

public void setDefaultContext(String defaultContext)

setProfileSeparator

public void setProfileSeparator(String profileSeparator)

setApplicationName

public void setApplicationName(String applicationName)

setProfiles

public void setProfiles(List<String> profiles)

setBackendVersion

public void setBackendVersion(int backendVersion)

toString

public String toString()

Overrides:

toString in class Object