Package org.springframework.cloud.vault.config

Interface SecretBackendConfigurer

public interface SecretBackendConfigurer

Helps to configure secret backends with support for property transformers.

Assists configuration with a fluent style. This configurer allows configuration via context paths and direct registration of SecretBackendMetadata.

Use registerDefaultKeyValueSecretBackends(boolean) to register default kv secret backend property sources and registerDefaultDiscoveredSecretBackends(boolean) to register additional secret backend property sources such as MySQL and RabbitMQ.

Since:

1.1

Author:

Mark Paluch

See Also:

PropertyTransformer, SecretBackendMetadata

Method Summary

Modifier and Type	Method	Description
SecretBackendConfigurer	add(String path)	Add a SecretBackendMetadata given its path.
SecretBackendConfigurer	add(String path, org.springframework.vault.core.util.PropertyTransformer propertyTransformer)	Add a SecretBackendMetadata given its path and PropertyTransformer.
SecretBackendConfigurer	add(SecretBackendMetadata metadata)	Add a SecretBackendMetadata.
SecretBackendConfigurer	add(org.springframework.vault.core.lease.domain.RequestedSecret requestedSecret)	Add a SecretBackendMetadata given RequestedSecret.
SecretBackendConfigurer	add(org.springframework.vault.core.lease.domain.RequestedSecret requestedSecret, org.springframework.vault.core.util.PropertyTransformer propertyTransformer)	Add a SecretBackendMetadata given RequestedSecret and PropertyTransformer.
SecretBackendConfigurer	registerDefaultDiscoveredSecretBackends(boolean registerDefault)	Register default discovered secret backend property sources from SecretBackendMetadata via VaultSecretBackendDescriptor beans.
SecretBackendConfigurer	registerDefaultKeyValueSecretBackends(boolean registerDefault)	Register default key-value secret backend property sources.

Method Detail

add

SecretBackendConfigurer add(String path)

Add a SecretBackendMetadata given its path.

Parameters:

path - must not be null or empty.

Returns:

this SecretBackendConfigurer.

add

SecretBackendConfigurer add(String path,
                            org.springframework.vault.core.util.PropertyTransformer propertyTransformer)

Add a SecretBackendMetadata given its path and PropertyTransformer.

Parameters:

path - must not be null or empty.

propertyTransformer - must not be null.

Returns:

this SecretBackendConfigurer.

add

SecretBackendConfigurer add(SecretBackendMetadata metadata)

Add a SecretBackendMetadata.

Parameters:

metadata - must not be null.

Returns:

this SecretBackendConfigurer.

add

SecretBackendConfigurer add(org.springframework.vault.core.lease.domain.RequestedSecret requestedSecret)

Add a SecretBackendMetadata given RequestedSecret. Property sources supporting leasing will derive lease renewal/rotation from RequestedSecret.Mode.

Parameters:

requestedSecret - must not be null or empty.

Returns:

this SecretBackendConfigurer.

add

SecretBackendConfigurer add(org.springframework.vault.core.lease.domain.RequestedSecret requestedSecret,
                            org.springframework.vault.core.util.PropertyTransformer propertyTransformer)

Add a SecretBackendMetadata given RequestedSecret and PropertyTransformer. Property sources supporting leasing will derive lease renewal/rotation from RequestedSecret.Mode.

Parameters:

requestedSecret - must not be null or empty.

propertyTransformer - must not be null.

Returns:

this SecretBackendConfigurer.

registerDefaultKeyValueSecretBackends

SecretBackendConfigurer registerDefaultKeyValueSecretBackends(boolean registerDefault)

Register default key-value secret backend property sources.

Parameters:

registerDefault - true to enable default kv secret backend registration.

Returns:

this SecretBackendConfigurer.

Since:

2.3.3

registerDefaultDiscoveredSecretBackends

SecretBackendConfigurer registerDefaultDiscoveredSecretBackends(boolean registerDefault)

Register default discovered secret backend property sources from SecretBackendMetadata via VaultSecretBackendDescriptor beans.

Parameters:

registerDefault - true to enable default discovered secret backend registration via VaultSecretBackendDescriptor beans.

Returns:

this SecretBackendConfigurer.