org.springframework.vault.config

Class AbstractVaultConfiguration

java.lang.Object

org.springframework.vault.config.AbstractVaultConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

AbstractReactiveVaultConfiguration, EnvironmentVaultConfiguration

@Configuration(proxyBeanMethods=false)
public abstract class AbstractVaultConfiguration
extends Object
implements org.springframework.context.ApplicationContextAware

Base class for Spring Vault configuration using JavaConfig.

Author:

Spencer Gibb, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractVaultConfiguration.ClientFactoryWrapper Wrapper for ClientHttpRequestFactory to not expose the bean globally.
static class	AbstractVaultConfiguration.TaskSchedulerWrapper Wrapper to keep ThreadPoolTaskScheduler local to Spring Vault and to not expose the bean globally.

Constructor Summary

Constructors

Constructor and Description
AbstractVaultConfiguration()

Method Summary

Modifier and Type	Method and Description
abstract ClientAuthentication	clientAuthentication() Annotate with Bean in case you want to expose a ClientAuthentication instance to the ApplicationContext.
AbstractVaultConfiguration.ClientFactoryWrapper	clientHttpRequestFactoryWrapper() Create a AbstractVaultConfiguration.ClientFactoryWrapper containing a ClientHttpRequestFactory .
ClientOptions	clientOptions()
protected org.springframework.beans.factory.BeanFactory	getBeanFactory()
protected org.springframework.core.env.Environment	getEnvironment() Return the Environment to access property sources during Spring Vault bootstrapping.
protected RestTemplateFactory	getRestTemplateFactory() Return the RestTemplateFactory.
protected org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler	getVaultThreadPoolTaskScheduler()
org.springframework.web.client.RestOperations	restOperations() Construct a RestOperations object configured for Vault session management and authentication usage.
protected RestTemplateBuilder	restTemplateBuilder(VaultEndpointProvider endpointProvider, org.springframework.http.client.ClientHttpRequestFactory requestFactory) Create a RestTemplateBuilder initialized with VaultEndpointProvider and ClientHttpRequestFactory.
RestTemplateFactory	restTemplateFactory(AbstractVaultConfiguration.ClientFactoryWrapper requestFactoryWrapper) Create a RestTemplateFactory bean that is used to produce RestTemplate.
SecretLeaseContainer	secretLeaseContainer() Construct a SecretLeaseContainer using vaultTemplate() and threadPoolTaskScheduler().
SessionManager	sessionManager() Construct a LifecycleAwareSessionManager using clientAuthentication().
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
SslConfiguration	sslConfiguration()
AbstractVaultConfiguration.TaskSchedulerWrapper	threadPoolTaskScheduler() Create a AbstractVaultConfiguration.TaskSchedulerWrapper used by LifecycleAwareSessionManager and SecretLeaseContainer wrapping ThreadPoolTaskScheduler.
abstract VaultEndpoint	vaultEndpoint()
VaultEndpointProvider	vaultEndpointProvider()
VaultTemplate	vaultTemplate() Create a VaultTemplate.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVaultConfiguration

public AbstractVaultConfiguration()

Method Detail

vaultEndpoint

public abstract VaultEndpoint vaultEndpoint()

Returns:

Vault endpoint coordinates for HTTP/HTTPS communication, must not be null.

vaultEndpointProvider

public VaultEndpointProvider vaultEndpointProvider()

Returns:

a VaultEndpointProvider returning the value of vaultEndpoint().

Since:

1.1

clientAuthentication

public abstract ClientAuthentication clientAuthentication()

Annotate with Bean in case you want to expose a ClientAuthentication instance to the ApplicationContext.

Returns:

the ClientAuthentication to use. Must not be null.

restTemplateBuilder

protected RestTemplateBuilder restTemplateBuilder(VaultEndpointProvider endpointProvider,
                                                  org.springframework.http.client.ClientHttpRequestFactory requestFactory)

Create a RestTemplateBuilder initialized with VaultEndpointProvider and ClientHttpRequestFactory. May be overridden by subclasses.

Returns:

the RestTemplateBuilder.

Since:

2.3

See Also:

vaultEndpointProvider(), clientHttpRequestFactoryWrapper()

restTemplateFactory

@Bean
public RestTemplateFactory restTemplateFactory(AbstractVaultConfiguration.ClientFactoryWrapper requestFactoryWrapper)

Create a RestTemplateFactory bean that is used to produce RestTemplate.

Returns:

the RestTemplateFactory.

Since:

2.3

See Also:

vaultEndpointProvider(), clientHttpRequestFactoryWrapper()

vaultTemplate

@Bean
public VaultTemplate vaultTemplate()

Create a VaultTemplate.

Returns:

the VaultTemplate.

See Also:

vaultEndpointProvider(), clientHttpRequestFactoryWrapper(), sessionManager()

sessionManager

@Bean
public SessionManager sessionManager()

Construct a LifecycleAwareSessionManager using clientAuthentication(). This SessionManager uses threadPoolTaskScheduler().

Returns:

the SessionManager for Vault session management.

See Also:

SessionManager, LifecycleAwareSessionManager, restOperations(), clientAuthentication(), ()

secretLeaseContainer

@Bean
public SecretLeaseContainer secretLeaseContainer()
                                                throws Exception

Construct a SecretLeaseContainer using vaultTemplate() and threadPoolTaskScheduler().

Returns:

the SecretLeaseContainer to allocate, renew and rotate secrets and their leases.

Throws:

Exception

See Also:

vaultTemplate(), threadPoolTaskScheduler()

threadPoolTaskScheduler

@Bean(value="vaultThreadPoolTaskScheduler")
public AbstractVaultConfiguration.TaskSchedulerWrapper threadPoolTaskScheduler()

Create a AbstractVaultConfiguration.TaskSchedulerWrapper used by LifecycleAwareSessionManager and SecretLeaseContainer wrapping ThreadPoolTaskScheduler. Subclasses may override this method to reuse a different/existing scheduler.

Returns:

the AbstractVaultConfiguration.TaskSchedulerWrapper to use. Must not be null.

See Also:

AbstractVaultConfiguration.TaskSchedulerWrapper.fromInstance(ThreadPoolTaskScheduler)

restOperations

public org.springframework.web.client.RestOperations restOperations()

Construct a RestOperations object configured for Vault session management and authentication usage. Can be customized by providing a RestTemplateFactory bean.

Returns:

the RestOperations to be used for Vault access.

See Also:

restTemplateFactory(ClientFactoryWrapper)

clientHttpRequestFactoryWrapper

@Bean
public AbstractVaultConfiguration.ClientFactoryWrapper clientHttpRequestFactoryWrapper()

Create a AbstractVaultConfiguration.ClientFactoryWrapper containing a ClientHttpRequestFactory . ClientHttpRequestFactory is not exposed as root bean because ClientHttpRequestFactory is configured with ClientOptions and SslConfiguration which are not necessarily applicable for the whole application.

Returns:

the AbstractVaultConfiguration.ClientFactoryWrapper to wrap a ClientHttpRequestFactory instance.

See Also:

clientOptions(), sslConfiguration()

clientOptions

public ClientOptions clientOptions()

Returns:

ClientOptions to configure communication parameters.

See Also:

ClientOptions

sslConfiguration

public SslConfiguration sslConfiguration()

Returns:

SSL configuration options. Defaults to SslConfiguration.unconfigured().

See Also:

SslConfiguration, SslConfiguration.unconfigured()

getEnvironment

protected org.springframework.core.env.Environment getEnvironment()

Return the Environment to access property sources during Spring Vault bootstrapping. Requires ApplicationContext to be set.

Returns:

the Environment to access property sources during Spring Vault bootstrapping.

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getRestTemplateFactory

protected RestTemplateFactory getRestTemplateFactory()

Return the RestTemplateFactory.

Returns:

the RestTemplateFactory bean.

Since:

2.3

getVaultThreadPoolTaskScheduler

protected org.springframework.scheduling.concurrent.ThreadPoolTaskScheduler getVaultThreadPoolTaskScheduler()

getBeanFactory

protected org.springframework.beans.factory.BeanFactory getBeanFactory()