Package org.springframework.vault.core.env

Class LeaseAwareVaultPropertySource

java.lang.Object

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

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

org.springframework.vault.core.env.LeaseAwareVaultPropertySource

public class LeaseAwareVaultPropertySource
extends EnumerablePropertySource<VaultOperations>

PropertySource that requests renewable secrets from SecretLeaseContainer. Leases are renewed or rotated, depeding on RequestedSecret.getMode(). Contents of this PropertySource is updated from background threads and the content is mutable. Expiration and revocation removes properties.

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
LeaseAwareVaultPropertySource(String name, SecretLeaseContainer secretLeaseContainer, RequestedSecret requestedSecret)	Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret.
LeaseAwareVaultPropertySource(String name, SecretLeaseContainer secretLeaseContainer, RequestedSecret requestedSecret, PropertyTransformer propertyTransformer)	Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret.
LeaseAwareVaultPropertySource(String name, SecretLeaseContainer secretLeaseContainer, RequestedSecret requestedSecret, PropertyTransformer propertyTransformer, boolean ignoreSecretNotFound)	Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret.
LeaseAwareVaultPropertySource(SecretLeaseContainer secretLeaseContainer, RequestedSecret requestedSecret)	Create a new LeaseAwareVaultPropertySource given a SecretLeaseContainer and RequestedSecret.

Method Summary

Modifier and Type	Method	Description
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()
RequestedSecret	getRequestedSecret()
protected void	handleLeaseErrorEvent(SecretLeaseEvent leaseEvent, Exception exception)	Hook method to handle a SecretLeaseEvent errors.
protected void	handleLeaseEvent(SecretLeaseEvent leaseEvent, Map<String,Object> properties)	Hook method to handle a SecretLeaseEvent.

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

LeaseAwareVaultPropertySource

public LeaseAwareVaultPropertySource(SecretLeaseContainer secretLeaseContainer,
 RequestedSecret requestedSecret)

Create a new LeaseAwareVaultPropertySource given a SecretLeaseContainer and RequestedSecret. This property source requests the secret upon initialization and receives secrets once they are emitted through events published by SecretLeaseContainer.

Parameters:

secretLeaseContainer - must not be null.

requestedSecret - must not be null.

LeaseAwareVaultPropertySource

public LeaseAwareVaultPropertySource(String name,
 SecretLeaseContainer secretLeaseContainer,
 RequestedSecret requestedSecret)

Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret. This property source requests the secret upon initialization and receives secrets once they are emitted through events published by SecretLeaseContainer.

Parameters:

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

secretLeaseContainer - must not be null.

requestedSecret - must not be null.

LeaseAwareVaultPropertySource

public LeaseAwareVaultPropertySource(String name,
 SecretLeaseContainer secretLeaseContainer,
 RequestedSecret requestedSecret,
 PropertyTransformer propertyTransformer)

Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret. This property source requests the secret upon initialization and receives secrets once they are emitted through events published by SecretLeaseContainer.

Parameters:

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

secretLeaseContainer - must not be null.

requestedSecret - must not be null.

propertyTransformer - object to transform properties.

See Also:

• PropertyTransformers

LeaseAwareVaultPropertySource

public LeaseAwareVaultPropertySource(String name,
 SecretLeaseContainer secretLeaseContainer,
 RequestedSecret requestedSecret,
 PropertyTransformer propertyTransformer,
 boolean ignoreSecretNotFound)

Create a new LeaseAwareVaultPropertySource given a name, SecretLeaseContainer and RequestedSecret. This property source requests the secret upon initialization and receives secrets once they are emitted through events published by SecretLeaseContainer.

Parameters:

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

secretLeaseContainer - must not be null.

requestedSecret - must not be 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

getRequestedSecret

public RequestedSecret getRequestedSecret()

getProperty

public Object getProperty(String name)

Specified by:

getProperty in class PropertySource<VaultOperations>

getPropertyNames

public String[] getPropertyNames()

Specified by:

getPropertyNames in class EnumerablePropertySource<VaultOperations>

handleLeaseEvent

protected void handleLeaseEvent(SecretLeaseEvent leaseEvent,
 Map<String,Object> properties)

Hook method to handle a SecretLeaseEvent.

Parameters:

leaseEvent - must not be null.

properties - reference to property storage of this property source.

handleLeaseErrorEvent

protected void handleLeaseErrorEvent(SecretLeaseEvent leaseEvent,
 Exception exception)

Hook method to handle a SecretLeaseEvent errors.

Parameters:

leaseEvent - must not be null.

exception - offending exception.

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