org.springframework.cloud.vault.config

Class VaultBootstrapConfiguration

java.lang.Object

org.springframework.cloud.vault.config.VaultBootstrapConfiguration

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

@Configuration
 @ConditionalOnProperty(name="spring.cloud.vault.enabled",
                       matchIfMissing=true)
 @EnableConfigurationProperties(value=VaultProperties.class)
 @Order(value=2147483642)
public class VaultBootstrapConfiguration
extends Object
implements org.springframework.beans.factory.InitializingBean

Auto-configuration for Spring Vault support.

Author:

Spencer Gibb, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VaultBootstrapConfiguration.TaskSchedulerWrapper Wrapper to keep TaskScheduler local to Spring Cloud Vault.

Constructor Summary

Constructors

Constructor and Description
VaultBootstrapConfiguration(org.springframework.context.ConfigurableApplicationContext applicationContext, VaultProperties vaultProperties, org.springframework.beans.factory.ObjectProvider<org.springframework.vault.client.VaultEndpointProvider> endpointProvider)

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.springframework.vault.authentication.ClientAuthentication	clientAuthentication()
org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper	clientHttpRequestFactoryWrapper() Creates a AbstractVaultConfiguration.ClientFactoryWrapper containing a ClientHttpRequestFactory.
org.springframework.vault.authentication.SessionManager	vaultSessionManager(org.springframework.vault.authentication.ClientAuthentication clientAuthentication, org.springframework.beans.factory.ObjectFactory<VaultBootstrapConfiguration.TaskSchedulerWrapper> asyncTaskExecutorFactory)
VaultBootstrapConfiguration.TaskSchedulerWrapper	vaultTaskScheduler() Creates a new VaultBootstrapConfiguration.TaskSchedulerWrapper that encapsulates a bean implementing TaskScheduler and AsyncTaskExecutor.
org.springframework.vault.core.VaultTemplate	vaultTemplate(org.springframework.vault.authentication.SessionManager sessionManager) Creates a VaultTemplate.

Methods inherited from class java.lang.Object

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

Constructor Detail

VaultBootstrapConfiguration

public VaultBootstrapConfiguration(org.springframework.context.ConfigurableApplicationContext applicationContext,
                                   VaultProperties vaultProperties,
                                   org.springframework.beans.factory.ObjectProvider<org.springframework.vault.client.VaultEndpointProvider> endpointProvider)

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

clientHttpRequestFactoryWrapper

@Bean
 @ConditionalOnMissingBean
public org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper clientHttpRequestFactoryWrapper()

Creates 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.

vaultTemplate

@Bean
 @ConditionalOnMissingBean(value=org.springframework.vault.core.VaultOperations.class)
public org.springframework.vault.core.VaultTemplate vaultTemplate(org.springframework.vault.authentication.SessionManager sessionManager)

Creates a VaultTemplate.

Parameters:

sessionManager - the SessionManager.

Returns:

the VaultTemplate bean.

See Also:

clientHttpRequestFactoryWrapper()

vaultTaskScheduler

@Bean
 @Lazy
 @ConditionalOnMissingBean(value=VaultBootstrapConfiguration.TaskSchedulerWrapper.class)
public VaultBootstrapConfiguration.TaskSchedulerWrapper vaultTaskScheduler()

Creates a new VaultBootstrapConfiguration.TaskSchedulerWrapper that encapsulates a bean implementing TaskScheduler and AsyncTaskExecutor.

Returns:

the VaultBootstrapConfiguration.TaskSchedulerWrapper bean.

See Also:

ThreadPoolTaskScheduler

vaultSessionManager

@Bean
 @ConditionalOnMissingBean
public org.springframework.vault.authentication.SessionManager vaultSessionManager(org.springframework.vault.authentication.ClientAuthentication clientAuthentication,
                                                                                                                    org.springframework.beans.factory.ObjectFactory<VaultBootstrapConfiguration.TaskSchedulerWrapper> asyncTaskExecutorFactory)

Parameters:

clientAuthentication - the ClientAuthentication.

asyncTaskExecutorFactory - the ObjectFactory for VaultBootstrapConfiguration.TaskSchedulerWrapper.

Returns:

the SessionManager for Vault session management.

See Also:

SessionManager, LifecycleAwareSessionManager

clientAuthentication

@Bean
 @ConditionalOnMissingBean
public org.springframework.vault.authentication.ClientAuthentication clientAuthentication()

Returns:

the ClientAuthentication to obtain a VaultToken.

See Also:

SessionManager, LifecycleAwareSessionManager