Package org.springframework.vault.core.env

Class VaultPropertySource

java.lang.Object

org.springframework.core.env.PropertySource<T>

org.springframework.core.env.EnumerablePropertySource<VaultOperations>

org.springframework.vault.core.env.VaultPropertySource

public class VaultPropertySource
extends EnumerablePropertySource<VaultOperations>

PropertySource that reads keys and values from a VaultTemplate and path. Transforms properties after retrieving these from Vault using PropertyTransformer.

Author:

Mark Paluch

See Also:

• PropertiesPropertySource
• PropertyTransformer
• PropertyTransformers

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.core.env.PropertySource

PropertySource.StubPropertySource

Field Summary

Fields inherited from class org.springframework.core.env.PropertySource

name, source

Constructor Summary

Constructors

Constructor	Description
VaultPropertySource(String name, VaultOperations vaultOperations, String path)	Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault.
VaultPropertySource(String name, VaultOperations vaultOperations, String path, PropertyTransformer propertyTransformer)	Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault.
VaultPropertySource(String name, VaultOperations vaultOperations, String path, PropertyTransformer propertyTransformer, boolean ignoreSecretNotFound)	Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault.
VaultPropertySource(VaultOperations vaultOperations, String path)	Create a new VaultPropertySource given a VaultTemplate and path inside of Vault.

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	doGetProperties(String path)	Hook method to obtain properties from Vault.
protected Map<String,Object>	doTransformProperties(Map<String,Object> properties)	Hook method to transform properties using PropertyTransformer.
protected Map<String,Object>	flattenMap(Map<String,Object> data)	Utility method converting a String/Object map to a flat String/Object map.
Object	getProperty(String name)
String[]	getPropertyNames()
protected void	loadProperties()	Initialize property source and read properties from Vault.

Methods inherited from class org.springframework.core.env.EnumerablePropertySource

containsProperty

Methods inherited from class org.springframework.core.env.PropertySource

equals, getName, getSource, hashCode, named, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

VaultPropertySource

public VaultPropertySource(VaultOperations vaultOperations,
 String path)

Create a new VaultPropertySource given a VaultTemplate and path inside of Vault. This property source loads properties upon construction.

Parameters:

vaultOperations - must not be null.

path - the path inside Vault (e.g. secret/myapp/myproperties. Must not be empty or null.

VaultPropertySource

public VaultPropertySource(String name,
 VaultOperations vaultOperations,
 String path)

Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault. This property source loads properties upon construction.

Parameters:

name - name of the property source, must not be null.

vaultOperations - must not be null.

path - the path inside Vault (e.g. secret/myapp/myproperties. Must not be empty or null.

VaultPropertySource

public VaultPropertySource(String name,
 VaultOperations vaultOperations,
 String path,
 PropertyTransformer propertyTransformer)

Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault. This property source loads properties upon construction and transforms these by applying PropertyTransformer.

Parameters:

name - name of the property source, must not be null.

vaultOperations - must not be null.

path - the path inside Vault (e.g. secret/myapp/myproperties. Must not be empty or null.

propertyTransformer - object to transform properties.

See Also:

• PropertyTransformers

VaultPropertySource

public VaultPropertySource(String name,
 VaultOperations vaultOperations,
 String path,
 PropertyTransformer propertyTransformer,
 boolean ignoreSecretNotFound)

Create a new VaultPropertySource given a name, VaultTemplate and path inside of Vault. This property source loads properties upon construction and transforms these by applying PropertyTransformer.

Parameters:

name - name of the property source, must not be null.

vaultOperations - must not be null.

path - the path inside Vault (e.g. secret/myapp/myproperties. Must not be empty or null.

propertyTransformer - object to transform properties.

ignoreSecretNotFound - indicate if failure to find a secret at path should be ignored.

Since:

2.2

See Also:

• PropertyTransformers

Method Details

loadProperties

protected void loadProperties()

Initialize property source and read properties from Vault.

getProperty

public Object getProperty(String name)

Specified by:

getProperty in class PropertySource<VaultOperations>

getPropertyNames

public String[] getPropertyNames()

Specified by:

getPropertyNames in class EnumerablePropertySource<VaultOperations>

doGetProperties

@Nullable
protected Map<String,Object> doGetProperties(String path)
                                      throws VaultException

Hook method to obtain properties from Vault.

Parameters:

path - the path, must not be empty or null.

Returns:

the resulting Map or null if properties were not found.

Throws:

VaultException - on problems retrieving properties

doTransformProperties

protected Map<String,Object> doTransformProperties(Map<String,Object> properties)

Hook method to transform properties using PropertyTransformer.

Parameters:

properties - must not be null.

Returns:

the transformed properties.

flattenMap

protected Map<String,Object> flattenMap(Map<String,Object> data)

Utility method converting a String/Object map to a flat String/Object map. Nested objects are represented with property path keys.

Parameters:

data - the map

Returns:

the flattened map.

Since:

2.0