org.springframework.vault.config

Class AbstractVaultConfiguration

java.lang.Object

org.springframework.vault.config.AbstractVaultConfiguration

All Implemented Interfaces:

Aware, ApplicationContextAware

@Configuration
public abstract class AbstractVaultConfiguration
extends Object
implements 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.

Constructor Summary

Constructors

Constructor and Description
AbstractVaultConfiguration()

Method Summary

Modifier and Type	Method and Description
AsyncTaskExecutor	asyncTaskExecutor() Create a AsyncTaskExecutor used by LifecycleAwareSessionManager.
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 Environment	getEnvironment() Return the Environment to access property sources during Spring Vault bootstrapping.
SessionManager	sessionManager() Construct a LifecycleAwareSessionManager using clientAuthentication() and vaultClient().
void	setApplicationContext(ApplicationContext applicationContext)
SslConfiguration	sslConfiguration()
VaultClient	vaultClient()
VaultClientFactory	vaultClientFactory() Creates the VaultClientFactory to be used with VaultTemplate.
abstract VaultEndpoint	vaultEndpoint()
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.

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.

asyncTaskExecutor

public AsyncTaskExecutor asyncTaskExecutor()

Create a AsyncTaskExecutor used by LifecycleAwareSessionManager. Annotate with Bean in case you want to expose a AsyncTaskExecutor instance to the ApplicationContext. This might be useful to supply managed executor instances or AsyncTaskExecutors using a queue/pooled threads.

Returns:

the AsyncTaskExecutor to use. Must not be null.

See Also:

AsyncTaskExecutor

sessionManager

@Bean
public SessionManager sessionManager()

Construct a LifecycleAwareSessionManager using clientAuthentication() and vaultClient(). This SessionManager uses asyncTaskExecutor().

Returns:

the SessionManager for Vault session management.

See Also:

SessionManager, LifecycleAwareSessionManager, clientAuthentication(), (), vaultClient()

clientOptions

public ClientOptions clientOptions()

Returns:

ClientOptions to configure communication parameters.

See Also:

ClientOptions

sslConfiguration

public SslConfiguration sslConfiguration()

Returns:

SSL configuration options. Defaults to SslConfiguration.NONE.

See Also:

SslConfiguration, SslConfiguration.NONE

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()

vaultClient

@Bean
public VaultClient vaultClient()

Returns:

the VaultClient

See Also:

clientHttpRequestFactoryWrapper(), vaultEndpoint()

vaultClientFactory

@Bean
public VaultClientFactory vaultClientFactory()

Creates the VaultClientFactory to be used with VaultTemplate. Uses by default DefaultVaultClientFactory with the configured vaultClient() instance.

Returns:

the VaultClientFactory.

vaultTemplate

@Bean
public VaultTemplate vaultTemplate()

Create a VaultTemplate.

Returns:

the VaultTemplate.

See Also:

vaultClientFactory(), sessionManager()

getEnvironment

protected 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(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException