A

AbstractVaultConfiguration - Class in org.springframework.vault.config

Base class for Spring Vault configuration using JavaConfig.

AbstractVaultConfiguration() - Constructor for class org.springframework.vault.config.AbstractVaultConfiguration

 

AbstractVaultConfiguration.ClientFactoryWrapper - Class in org.springframework.vault.config

Wrapper for ClientHttpRequestFactory to not expose the bean globally.

afterPropertiesSet() - Method in class org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper

 

afterPropertiesSet() - Method in class org.springframework.vault.core.VaultTemplate

 

API_VERSION - Static variable in class org.springframework.vault.client.VaultEndpoint

 

appId(String) - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions.AppIdAuthenticationOptionsBuilder

Configures the AppId.

AppIdAuthentication - Class in org.springframework.vault.authentication

AppId implementation of ClientAuthentication.

AppIdAuthentication(AppIdAuthenticationOptions, VaultClient) - Constructor for class org.springframework.vault.authentication.AppIdAuthentication

Creates a AppIdAuthentication using AppIdAuthenticationOptions and VaultClient.

AppIdAuthenticationOptions - Class in org.springframework.vault.authentication

Authentication options for AppIdAuthentication.

AppIdAuthenticationOptions.AppIdAuthenticationOptionsBuilder - Class in org.springframework.vault.authentication

Builder for AppIdAuthenticationOptions.

AppIdUserIdMechanism - Interface in org.springframework.vault.authentication

Interface to obtain a UserId for AppId authentication.

authMount(String, VaultMount) - Method in interface org.springframework.vault.core.VaultSysOperations

Mounts an auth backend VaultMount to path.

authMount(String, VaultMount) - Method in class org.springframework.vault.core.VaultSysTemplate

 

authUnmount(String) - Method in interface org.springframework.vault.core.VaultSysOperations

Unmounts the auth backend mount at path.

authUnmount(String) - Method in class org.springframework.vault.core.VaultSysTemplate

 

AwsEc2Authentication - Class in org.springframework.vault.authentication

AWS-EC2 login implementation.

AwsEc2Authentication(VaultClient) - Constructor for class org.springframework.vault.authentication.AwsEc2Authentication

Creates a new AwsEc2Authentication.

AwsEc2Authentication(AwsEc2AuthenticationOptions, VaultClient, RestTemplate) - Constructor for class org.springframework.vault.authentication.AwsEc2Authentication

Creates a new AwsEc2Authentication specifying AwsEc2AuthenticationOptions, VaultClient and a RestTemplate.

AwsEc2AuthenticationOptions - Class in org.springframework.vault.authentication

Authentication options for AwsEc2Authentication.

AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder - Class in org.springframework.vault.authentication

Builder for AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder.

B

build() - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions.AppIdAuthenticationOptionsBuilder

Builds a new AppIdAuthenticationOptions instance.

build() - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

Builds a new AwsEc2AuthenticationOptions instance.

build() - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Builds a new CubbyholeAuthenticationOptions instance.

build() - Method in class org.springframework.vault.support.VaultMount.VaultMountBuilder

Builds a new VaultMount instance.

builder() - Static method in class org.springframework.vault.authentication.AppIdAuthenticationOptions

 

builder() - Static method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

builder() - Static method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions

 

builder() - Static method in class org.springframework.vault.support.VaultMount

 

buildUri(String, Map<String, ?>) - Method in class org.springframework.vault.client.VaultClient

Build the Vault URI based on the given VaultEndpoint and pathTemplate.

C

ClientAuthentication - Interface in org.springframework.vault.authentication

ClientAuthentication provides VaultToken to be used for authenticated Vault access.

clientAuthentication() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

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

ClientCertificateAuthentication - Class in org.springframework.vault.authentication

TLS Client Certificate ClientAuthentication.

ClientCertificateAuthentication(VaultClient) - Constructor for class org.springframework.vault.authentication.ClientCertificateAuthentication

Creates a ClientCertificateAuthentication using VaultClient.

ClientFactoryWrapper(ClientHttpRequestFactory) - Constructor for class org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper

 

ClientHttpRequestFactoryFactory - Class in org.springframework.vault.config

Factory for ClientHttpRequestFactory that supports Apache HTTP Components, OkHttp, Netty and the JDK HTTP client (in that order).

ClientHttpRequestFactoryFactory() - Constructor for class org.springframework.vault.config.ClientHttpRequestFactoryFactory

 

clientHttpRequestFactoryWrapper() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

Creates a AbstractVaultConfiguration.ClientFactoryWrapper containing a ClientHttpRequestFactory.

clientOptions() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

 

ClientOptions - Class in org.springframework.vault.support

Client options for Vault.

ClientOptions() - Constructor for class org.springframework.vault.support.ClientOptions

Creates new ClientOptions with default timeouts of 5 TimeUnit.SECONDS connection timeout and 15 TimeUnit.SECONDS read timeout.

ClientOptions(int, int) - Constructor for class org.springframework.vault.support.ClientOptions

Creates new ClientOptions.

config(Map<String, Object>) - Method in class org.springframework.vault.support.VaultMount.VaultMountBuilder

Set additional configuration details for this mount.

configureKey(String, VaultTransitKeyConfiguration) - Method in interface org.springframework.vault.core.VaultTransitOperations

Creates a new named encryption key given a name.

configureKey(String, VaultTransitKeyConfiguration) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

create(ClientOptions, SslConfiguration) - Static method in class org.springframework.vault.config.ClientHttpRequestFactoryFactory

Creates a ClientHttpRequestFactory for the given ClientOptions and SslConfiguration.

create() - Method in interface org.springframework.vault.core.VaultTokenOperations

Create a new token.

create(VaultTokenRequest) - Method in interface org.springframework.vault.core.VaultTokenOperations

Create a new token for the given VaultTokenRequest.

create() - Method in class org.springframework.vault.core.VaultTokenTemplate

 

create(VaultTokenRequest) - Method in class org.springframework.vault.core.VaultTokenTemplate

 

create(Resource, String, Resource, String) - Method in class org.springframework.vault.support.SslConfiguration

Creates a new SslConfiguration for the given truststore.

create(String) - Static method in class org.springframework.vault.support.VaultMount

Creates a new VaultMount given a type.

createHeaders(VaultToken) - Static method in class org.springframework.vault.client.VaultClient

Create HttpHeaders for a VaultToken.

createKey(String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Creates a new named encryption key given a name.

createKey(String, VaultTransitKeyCreationRequest) - Method in interface org.springframework.vault.core.VaultTransitOperations

Creates a new named encryption key given a name and VaultTransitKeyCreationRequest.

createKey(String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

createKey(String, VaultTransitKeyCreationRequest) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

createNonce() - Method in class org.springframework.vault.authentication.AwsEc2Authentication

 

createOrphan() - Method in interface org.springframework.vault.core.VaultTokenOperations

Create a new orphan token.

createOrphan(VaultTokenRequest) - Method in interface org.springframework.vault.core.VaultTokenOperations

Create a new orphan token for the given VaultTokenRequest.

createOrphan() - Method in class org.springframework.vault.core.VaultTokenTemplate

 

createOrphan(VaultTokenRequest) - Method in class org.springframework.vault.core.VaultTokenTemplate

 

createUri(String) - Method in class org.springframework.vault.client.VaultEndpoint

Build the Vault URI based on the given path.

createUriString(String) - Method in class org.springframework.vault.client.VaultEndpoint

Build the Vault URI string based on the given path.

createUserId() - Method in interface org.springframework.vault.authentication.AppIdUserIdMechanism

Creates a UserId for AppId authentication.

createUserId() - Method in class org.springframework.vault.authentication.IpAddressUserId

 

createUserId() - Method in class org.springframework.vault.authentication.MacAddressUserId

 

createUserId() - Method in class org.springframework.vault.authentication.StaticUserId

 

CubbyholeAuthentication - Class in org.springframework.vault.authentication

Cubbyhole ClientAuthentication implementation.

CubbyholeAuthentication(CubbyholeAuthenticationOptions, VaultClient) - Constructor for class org.springframework.vault.authentication.CubbyholeAuthentication

Create a new CubbyholeAuthentication given CubbyholeAuthenticationOptions and VaultClient.

CubbyholeAuthenticationOptions - Class in org.springframework.vault.authentication

Authentication options for CubbyholeAuthentication.

CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder - Class in org.springframework.vault.authentication

Builder for CubbyholeAuthenticationOptions.

D

decrypt(String, String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Decrypts the provided plaintext using the named key.

decrypt(String, String, VaultTransitRequest) - Method in interface org.springframework.vault.core.VaultTransitOperations

Decrypts the provided plaintext using the named key.

decrypt(String, String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

decrypt(String, String, VaultTransitRequest) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

DEFAULT - Static variable in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

Default AwsEc2AuthenticationOptions using AwsEc2AuthenticationOptions.DEFAULT_AWS_AUTHENTICATION_PATH and AwsEc2AuthenticationOptions.DEFAULT_PKCS7_IDENTITY_DOCUMENT_URI.

DEFAULT_APPID_AUTHENTICATION_PATH - Static variable in class org.springframework.vault.authentication.AppIdAuthenticationOptions

 

DEFAULT_AWS_AUTHENTICATION_PATH - Static variable in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

DEFAULT_PKCS7_IDENTITY_DOCUMENT_URI - Static variable in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

DefaultSessionManager - Class in org.springframework.vault.authentication

Default implementation of SessionManager.

DefaultSessionManager(ClientAuthentication) - Constructor for class org.springframework.vault.authentication.DefaultSessionManager

Creates a new DefaultSessionManager using a ClientAuthentication.

DefaultVaultClientFactory - Class in org.springframework.vault.core

Default implementation of VaultClientFactory.

DefaultVaultClientFactory(VaultClient) - Constructor for class org.springframework.vault.core.DefaultVaultClientFactory

Creates a new DefaultVaultClientFactory returning always the same VaultClient.

DefaultVaultClientFactory() - Constructor for class org.springframework.vault.core.DefaultVaultClientFactory

Creates a new DefaultVaultClientFactory using a default VaultClient and VaultEndpoint.

delete(String) - Method in interface org.springframework.vault.core.VaultOperations

Delete a path in the secret backend.

delete(String) - Method in class org.springframework.vault.core.VaultTemplate

 

deleteForEntity(String, VaultToken, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Delete a resource by DELETEing from the path, and returns the response as VaultResponseEntity.

deleteForEntity(String, Class<T>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Delete a resource by DELETEing from the path, and returns the response as VaultResponseEntity.

deleteKey(String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Deletes a named encryption key.

deleteKey(String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

description(String) - Method in class org.springframework.vault.support.VaultMount.VaultMountBuilder

Configure a human readable description of this mount.

destroy() - Method in class org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper

 

doWithRestTemplate(URI, VaultAccessor.RestTemplateCallback<T>) - Method in class org.springframework.vault.client.VaultAccessor

Execute a VaultAccessor.RestTemplateCallback in the scope of the RestTemplate.

doWithRestTemplate(URI, RestTemplate) - Method in interface org.springframework.vault.client.VaultAccessor.RestTemplateCallback

 

doWithRestTemplate(String, Map<String, ?>, VaultAccessor.RestTemplateCallback<T>) - Method in class org.springframework.vault.client.VaultClient

Executes a RestTemplateCallback.

doWithRestTemplate(String, Map<String, ?>, VaultAccessor.RestTemplateCallback<T>) - Method in interface org.springframework.vault.core.VaultOperations

Executes VaultAccessor.RestTemplateCallback.

doWithRestTemplate(String, Map<String, ?>, VaultAccessor.RestTemplateCallback<T>) - Method in class org.springframework.vault.core.VaultTemplate

 

doWithVault(VaultClient) - Method in interface org.springframework.vault.core.VaultOperations.ClientCallback

Callback method.

doWithVault(VaultOperations.ClientCallback<T>) - Method in interface org.springframework.vault.core.VaultOperations

Executes a Vault VaultOperations.ClientCallback.

doWithVault(VaultOperations.SessionCallback<T>) - Method in interface org.springframework.vault.core.VaultOperations

Executes a Vault VaultOperations.SessionCallback.

doWithVault(VaultOperations.VaultSession) - Method in interface org.springframework.vault.core.VaultOperations.SessionCallback

Callback method.

doWithVault(VaultOperations.ClientCallback<T>) - Method in class org.springframework.vault.core.VaultTemplate

 

doWithVault(VaultOperations.SessionCallback<T>) - Method in class org.springframework.vault.core.VaultTemplate

 

E

encrypt(String, String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Encrypts the provided plaintext using the named key.

encrypt(String, byte[], VaultTransitRequest) - Method in interface org.springframework.vault.core.VaultTransitOperations

Encrypts the provided plaintext using the named key.

encrypt(String, String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

encrypt(String, byte[], VaultTransitRequest) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

exchange(URI, HttpMethod, HttpEntity<?>, Class<T>) - Method in class org.springframework.vault.client.VaultAccessor

 

exchange(URI, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>) - Method in class org.springframework.vault.client.VaultAccessor

 

exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Map<String, ?>) - Method in class org.springframework.vault.client.VaultClient

Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as VaultResponseEntity.

exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Map<String, ?>) - Method in class org.springframework.vault.client.VaultClient

Execute the HTTP method to the given path template, writing the given request entity to the request, and returns the response as VaultResponseEntity.

exchange(String, HttpMethod, HttpEntity<?>, Class<T>, Map<String, ?>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as VaultResponseEntity.

exchange(String, HttpMethod, HttpEntity<?>, ParameterizedTypeReference<T>, Map<String, ?>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Execute the HTTP method to the given path template, writing the given request entity to the request, and returns the response as VaultResponseEntity.

F

forKeyStore(Resource, String) - Static method in class org.springframework.vault.support.SslConfiguration

Creates a new SslConfiguration for the given key store.

forTrustStore(Resource, String) - Static method in class org.springframework.vault.support.SslConfiguration

Creates a new SslConfiguration for the given trust store.

G

getAppId() - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions

 

getAuth() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getAuthMounts() - Method in interface org.springframework.vault.core.VaultSysOperations

 

getAuthMounts() - Method in class org.springframework.vault.core.VaultSysTemplate

 

getBody() - Method in class org.springframework.vault.client.VaultResponseEntity

 

getCipherMode() - Method in class org.springframework.vault.support.VaultTransitKey

 

getClientHttpRequestFactory() - Method in class org.springframework.vault.config.AbstractVaultConfiguration.ClientFactoryWrapper

 

getConfig() - Method in class org.springframework.vault.support.VaultMount

 

getConnectionTimeout() - Method in class org.springframework.vault.support.ClientOptions

 

getContext() - Method in class org.springframework.vault.support.VaultTransitRequest

 

getConvergentEncryption() - Method in class org.springframework.vault.support.VaultTransitKeyCreationRequest

 

getData() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getDeletionAllowed() - Method in class org.springframework.vault.support.VaultTransitKeyConfiguration

 

getDerived() - Method in class org.springframework.vault.support.VaultTransitKeyCreationRequest

 

getDescription() - Method in class org.springframework.vault.support.VaultMount

 

getDisplayName() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getEc2Login() - Method in class org.springframework.vault.authentication.AwsEc2Authentication

 

getEndpoint() - Method in class org.springframework.vault.client.VaultClient

 

getExplicitMaxTtl() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getForEntity(String, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Retrieve a resource by GETting from the path, and returns the response as VaultResponseEntity.

getForEntity(String, VaultToken, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Retrieve a resource by GETting from the path, and returns the response as VaultResponseEntity.

getForEntity(String, Class<T>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Retrieve a resource by GETting from the path, and returns the response as VaultResponseEntity.

getHost() - Method in class org.springframework.vault.client.VaultEndpoint

 

getId() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getIdentityDocumentUri() - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

getInitialToken() - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions

 

getKey(String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Returns information about a named encryption key.

getKey(String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

getKeys() - Method in class org.springframework.vault.support.VaultInitializationResponse

 

getKeys() - Method in class org.springframework.vault.support.VaultTransitKey

 

getKeyStore() - Method in class org.springframework.vault.support.SslConfiguration

 

getKeyStorePassword() - Method in class org.springframework.vault.support.SslConfiguration

 

getLatestVersion() - Method in class org.springframework.vault.support.VaultTransitKeyConfiguration

 

getLeaseDuration() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getLeaseDuration() - Method in class org.springframework.vault.support.VaultToken

 

getLeaseId() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getMessage() - Method in class org.springframework.vault.client.VaultResponseEntity

 

getMeta() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getMetadata() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getMinDecryptionVersion() - Method in class org.springframework.vault.support.VaultTransitKey

 

getMounts() - Method in interface org.springframework.vault.core.VaultSysOperations

 

getMounts() - Method in class org.springframework.vault.core.VaultSysTemplate

 

getName() - Method in class org.springframework.vault.support.VaultTransitKey

 

getNoDefaultPolicy() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getNonce() - Method in class org.springframework.vault.support.VaultTransitRequest

 

getNoParent() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getNumUses() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getPath() - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions

 

getPath() - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

getPath() - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions

 

getPolicies() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getPort() - Method in class org.springframework.vault.client.VaultEndpoint

 

getProgress() - Method in class org.springframework.vault.support.VaultUnsealStatus

 

getReadTimeout() - Method in class org.springframework.vault.support.ClientOptions

 

getRenewable() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getRequestId() - Method in class org.springframework.vault.support.VaultResponseSupport

 

getRestTemplate() - Method in class org.springframework.vault.client.VaultAccessor

 

getRole() - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions

 

getRootToken() - Method in class org.springframework.vault.support.VaultInitializationResponse

 

getScheme() - Method in class org.springframework.vault.client.VaultEndpoint

 

getSecretShares() - Method in class org.springframework.vault.support.VaultInitializationRequest

 

getSecretShares() - Method in class org.springframework.vault.support.VaultUnsealStatus

 

getSecretThreshold() - Method in class org.springframework.vault.support.VaultInitializationRequest

 

getSecretThreshold() - Method in class org.springframework.vault.support.VaultUnsealStatus

 

getServerTimeUtc() - Method in class org.springframework.vault.support.VaultHealth

 

getSessionToken() - Method in class org.springframework.vault.authentication.DefaultSessionManager

 

getSessionToken() - Method in interface org.springframework.vault.authentication.SessionManager

Obtain a session token.

getStatusCode() - Method in class org.springframework.vault.client.VaultResponseEntity

 

getToken() - Method in class org.springframework.vault.support.VaultToken

 

getToken() - Method in class org.springframework.vault.support.VaultTokenResponse

Returns a VaultToken from the VaultResponse.

getTrustStore() - Method in class org.springframework.vault.support.SslConfiguration

 

getTrustStorePassword() - Method in class org.springframework.vault.support.SslConfiguration

 

getTtl() - Method in class org.springframework.vault.support.VaultTokenRequest

 

getType() - Method in class org.springframework.vault.support.VaultMount

 

getUnsealStatus() - Method in interface org.springframework.vault.core.VaultSysOperations

 

getUnsealStatus() - Method in class org.springframework.vault.core.VaultSysTemplate

 

getUri() - Method in class org.springframework.vault.client.VaultResponseEntity

 

getUserIdMechanism() - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions

 

getVaultClient() - Method in class org.springframework.vault.core.DefaultVaultClientFactory

 

getVaultClient() - Method in interface org.springframework.vault.core.VaultClientFactory

 

getWrapInfo() - Method in class org.springframework.vault.support.VaultResponseSupport

 

H

hasBody() - Method in class org.springframework.vault.client.VaultResponseEntity

 

health() - Method in interface org.springframework.vault.core.VaultSysOperations

Returns the health status of Vault.

health() - Method in class org.springframework.vault.core.VaultSysTemplate

 

I

identityDocumentUri(URI) - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

Configures the Identity Document URI.

initialize(VaultInitializationRequest) - Method in interface org.springframework.vault.core.VaultSysOperations

Initialize Vault with a VaultInitializationRequest.

initialize(VaultInitializationRequest) - Method in class org.springframework.vault.core.VaultSysTemplate

 

initialToken(VaultToken) - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Configures the initial VaultToken to access Cubbyhole.

IpAddressUserId - Class in org.springframework.vault.authentication

Mechanism to generate a SHA-256 hashed and hex-encoded representation of the IP address.

IpAddressUserId() - Constructor for class org.springframework.vault.authentication.IpAddressUserId

 

isDeletionAllowed() - Method in class org.springframework.vault.support.VaultTransitKey

 

isDerived() - Method in class org.springframework.vault.support.VaultTransitKey

 

isInitialized() - Method in interface org.springframework.vault.core.VaultSysOperations

 

isInitialized() - Method in class org.springframework.vault.core.VaultSysTemplate

 

isInitialized() - Method in class org.springframework.vault.support.VaultHealth

 

isLatestVersion() - Method in class org.springframework.vault.support.VaultTransitKey

 

isRenewable() - Method in class org.springframework.vault.support.VaultResponseSupport

 

isSealed() - Method in class org.springframework.vault.support.VaultHealth

 

isSealed() - Method in class org.springframework.vault.support.VaultUnsealStatus

 

isStandby() - Method in class org.springframework.vault.support.VaultHealth

 

isSuccessful() - Method in class org.springframework.vault.client.VaultResponseEntity

 

isWrappedToken() - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions

 

L

list(String) - Method in interface org.springframework.vault.core.VaultOperations

Enumerate keys from a secret backend.

list(String) - Method in class org.springframework.vault.core.VaultTemplate

 

login() - Method in class org.springframework.vault.authentication.AppIdAuthentication

 

login() - Method in class org.springframework.vault.authentication.AwsEc2Authentication

 

login() - Method in interface org.springframework.vault.authentication.ClientAuthentication

Return a VaultToken.

login() - Method in class org.springframework.vault.authentication.ClientCertificateAuthentication

 

login() - Method in class org.springframework.vault.authentication.CubbyholeAuthentication

 

login() - Method in class org.springframework.vault.authentication.TokenAuthentication

 

M

MacAddressUserId - Class in org.springframework.vault.authentication

Mechanism to generate a UserId based on the Mac address.

MacAddressUserId() - Constructor for class org.springframework.vault.authentication.MacAddressUserId

Creates a new MacAddressUserId using the NetworkInterface from the InetAddress.getLocalHost().

MacAddressUserId(int) - Constructor for class org.springframework.vault.authentication.MacAddressUserId

Creates a new MacAddressUserId using a networkInterfaceIndex.

MacAddressUserId(String) - Constructor for class org.springframework.vault.authentication.MacAddressUserId

Creates a new MacAddressUserId using a networkInterfaceName.

mount(String, VaultMount) - Method in interface org.springframework.vault.core.VaultSysOperations

Mounts a secret backend VaultMount to path.

mount(String, VaultMount) - Method in class org.springframework.vault.core.VaultSysTemplate

 

N

NONE - Static variable in class org.springframework.vault.support.SslConfiguration

Default SslConfiguration without a KeyStore/TrustStore configured.

O

of(String) - Static method in class org.springframework.vault.support.VaultToken

Creates a new VaultToken.

of(String, long) - Static method in class org.springframework.vault.support.VaultToken

Creates a new VaultToken with a leaseDuration.

opsForSys() - Method in interface org.springframework.vault.core.VaultOperations

 

opsForSys() - Method in class org.springframework.vault.core.VaultTemplate

 

opsForToken() - Method in interface org.springframework.vault.core.VaultOperations

 

opsForToken() - Method in class org.springframework.vault.core.VaultTemplate

 

opsForTransit() - Method in interface org.springframework.vault.core.VaultOperations

 

opsForTransit(String) - Method in interface org.springframework.vault.core.VaultOperations

Returns VaultTransitOperations if the transit backend is mounted on a different path than transit.

opsForTransit() - Method in class org.springframework.vault.core.VaultTemplate

 

opsForTransit(String) - Method in class org.springframework.vault.core.VaultTemplate

 

org.springframework.vault - package org.springframework.vault

Spring support for Hashicorp Vault.

org.springframework.vault.authentication - package org.springframework.vault.authentication

Support for authentication and session management.

org.springframework.vault.client - package org.springframework.vault.client

Spring Vault Client abstraction.

org.springframework.vault.config - package org.springframework.vault.config

Spring configuration for Vault.

org.springframework.vault.core - package org.springframework.vault.core

Vault core support.

org.springframework.vault.support - package org.springframework.vault.support

Classes supporting the Vault packages, such as value objects.

P

path(String) - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions.AppIdAuthenticationOptionsBuilder

Configures the mount path.

path(String) - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

Configures the mount path.

path(String) - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Configures the cubbyhole path, such as cubbyhole/token.

postForEntity(String, Object, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Issue a POST request using the given object to the path, and returns the response as VaultResponseEntity.

postForEntity(String, VaultToken, Object, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Issue a POST request using the given object to the path, and returns the response as VaultResponseEntity.

postForEntity(String, Object, Class<T>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Issue a POST request using the given object to the path, and returns the response as VaultResponseEntity.

putForEntity(String, Object, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Create a new resource by PUTting the given object to the path, and returns the response as VaultResponseEntity.

putForEntity(String, VaultToken, Object, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Create a new resource by PUTting the given object to the path, and returns the response as VaultResponseEntity.

putForEntity(String, Object, Class<T>) - Method in interface org.springframework.vault.core.VaultOperations.VaultSession

Create a new resource by PUTting the given object to the path, and returns the response as VaultResponseEntity.

R

read(String) - Method in interface org.springframework.vault.core.VaultOperations

Read from a secret backend.

read(String, Class<T>) - Method in interface org.springframework.vault.core.VaultOperations

Read from a secret backend.

read(String) - Method in class org.springframework.vault.core.VaultTemplate

 

read(String, Class<T>) - Method in class org.springframework.vault.core.VaultTemplate

 

renew(VaultToken) - Method in interface org.springframework.vault.core.VaultTokenOperations

Renew a VaultToken.

renew(VaultToken) - Method in class org.springframework.vault.core.VaultTokenTemplate

 

revoke(VaultToken) - Method in interface org.springframework.vault.core.VaultTokenOperations

Revoke a VaultToken.

revoke(VaultToken) - Method in class org.springframework.vault.core.VaultTokenTemplate

 

revokeOrphan(VaultToken) - Method in interface org.springframework.vault.core.VaultTokenOperations

Revoke a VaultToken but not its child tokens.

revokeOrphan(VaultToken) - Method in class org.springframework.vault.core.VaultTokenTemplate

 

rewrap(String, String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Rewrap the provided ciphertext using the latest version of the named key.

rewrap(String, String, VaultTransitRequest) - Method in interface org.springframework.vault.core.VaultTransitOperations

Rewrap the provided ciphertext using the latest version of the named key.

rewrap(String, String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

rewrap(String, String, VaultTransitRequest) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

role(String) - Method in class org.springframework.vault.authentication.AwsEc2AuthenticationOptions.AwsEc2AuthenticationOptionsBuilder

Configures the name of the role against which the login is being attempted.If role is not specified, then the login endpoint looks for a role bearing the name of the AMI ID of the EC2 instance that is trying to login.

rotate(String) - Method in interface org.springframework.vault.core.VaultTransitOperations

Rotates the version of the named key.

rotate(String) - Method in class org.springframework.vault.core.VaultTransitTemplate

 

S

seal() - Method in interface org.springframework.vault.core.VaultSysOperations

Seal vault.

seal() - Method in class org.springframework.vault.core.VaultSysTemplate

 

SessionManager - Interface in org.springframework.vault.authentication

Strategy interface that encapsulates the creation and management of Vault sessions based on VaultToken.

sessionManager() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

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

setAuth(Map<String, Object>) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setCipherMode(String) - Method in class org.springframework.vault.support.VaultTransitKey

 

setContext(byte[]) - Method in class org.springframework.vault.support.VaultTransitRequest

 

setConvergentEncryption(Boolean) - Method in class org.springframework.vault.support.VaultTransitKeyCreationRequest

 

setData(T) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setDeletionAllowed(boolean) - Method in class org.springframework.vault.support.VaultTransitKey

 

setDeletionAllowed(Boolean) - Method in class org.springframework.vault.support.VaultTransitKeyConfiguration

 

setDerived(boolean) - Method in class org.springframework.vault.support.VaultTransitKey

 

setDerived(Boolean) - Method in class org.springframework.vault.support.VaultTransitKeyCreationRequest

 

setDisplayName(String) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setExplicitMaxTtl(String) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setHost(String) - Method in class org.springframework.vault.client.VaultEndpoint

Sets the hostname.

setId(String) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setKeys(List<String>) - Method in class org.springframework.vault.support.VaultInitializationResponse

 

setKeys(Map<String, Long>) - Method in class org.springframework.vault.support.VaultTransitKey

 

setLatestVersion(boolean) - Method in class org.springframework.vault.support.VaultTransitKey

 

setLatestVersion(Integer) - Method in class org.springframework.vault.support.VaultTransitKeyConfiguration

 

setLeaseDuration(long) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setLeaseId(String) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setMeta(Map<String, String>) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setMetadata(Map<String, String>) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setMinDecryptionVersion(int) - Method in class org.springframework.vault.support.VaultTransitKey

 

setName(String) - Method in class org.springframework.vault.support.VaultTransitKey

 

setNoDefaultPolicy(Boolean) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setNonce(byte[]) - Method in class org.springframework.vault.support.VaultTransitRequest

 

setNoParent(Boolean) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setNumUses(Integer) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setPolicies(List<String>) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setPort(int) - Method in class org.springframework.vault.client.VaultEndpoint

 

setProgress(int) - Method in class org.springframework.vault.support.VaultUnsealStatus

 

setRenewable(boolean) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setRenewable(Boolean) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setRequestId(String) - Method in class org.springframework.vault.support.VaultResponseSupport

 

setRootToken(String) - Method in class org.springframework.vault.support.VaultInitializationResponse

 

setScheme(String) - Method in class org.springframework.vault.client.VaultEndpoint

 

setSealed(boolean) - Method in class org.springframework.vault.support.VaultUnsealStatus

 

setSecretShares(int) - Method in class org.springframework.vault.support.VaultInitializationRequest

 

setSecretShares(int) - Method in class org.springframework.vault.support.VaultUnsealStatus

 

setSecretThreshold(int) - Method in class org.springframework.vault.support.VaultInitializationRequest

 

setSecretThreshold(int) - Method in class org.springframework.vault.support.VaultUnsealStatus

 

setSessionManager(SessionManager) - Method in class org.springframework.vault.core.VaultTemplate

Set the SessionManager.

setTtl(String) - Method in class org.springframework.vault.support.VaultTokenRequest

 

setVaultClientFactory(VaultClientFactory) - Method in class org.springframework.vault.core.VaultTemplate

Set the VaultClientFactory.

setWrapInfo(Map<String, String>) - Method in class org.springframework.vault.support.VaultResponseSupport

 

sslConfiguration() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

 

SslConfiguration - Class in org.springframework.vault.support

SSL configuration.

SslConfiguration(Resource, String, Resource, String) - Constructor for class org.springframework.vault.support.SslConfiguration

 

StaticUserId - Class in org.springframework.vault.authentication

A static UserId.

StaticUserId(String) - Constructor for class org.springframework.vault.authentication.StaticUserId

Creates a new StaticUserId for a given userId.

T

TokenAuthentication - Class in org.springframework.vault.authentication

Static Token-based ClientAuthentication method.

TokenAuthentication(String) - Constructor for class org.springframework.vault.authentication.TokenAuthentication

Creates a new TokenAuthentication with a static token.

TokenAuthentication(VaultToken) - Constructor for class org.springframework.vault.authentication.TokenAuthentication

Creates a new TokenAuthentication with a static token.

toString() - Method in class org.springframework.vault.client.VaultEndpoint

 

type(String) - Method in class org.springframework.vault.support.VaultMount.VaultMountBuilder

Configure the backend type.

U

unmount(String) - Method in interface org.springframework.vault.core.VaultSysOperations

Unmounts the secret backend mount at path.

unmount(String) - Method in class org.springframework.vault.core.VaultSysTemplate

 

unseal(String) - Method in interface org.springframework.vault.core.VaultSysOperations

Unseal vault.

unseal(String) - Method in class org.springframework.vault.core.VaultSysTemplate

 

unwrap(String, Class<T>) - Method in class org.springframework.vault.client.VaultClient

Unwrap a wrapped response created by Vault Response Wrapping

userIdMechanism(AppIdUserIdMechanism) - Method in class org.springframework.vault.authentication.AppIdAuthenticationOptions.AppIdAuthenticationOptionsBuilder

Configures the AppIdUserIdMechanism.

V

VAULT_TOKEN - Static variable in class org.springframework.vault.client.VaultClient

 

VaultAccessor - Class in org.springframework.vault.client

Base class for Vault accessing helpers, defining common properties such as the RestTemplate to operate on.

VaultAccessor(RestTemplate) - Constructor for class org.springframework.vault.client.VaultAccessor

Create a VaultAccessor with a RestTemplate.

VaultAccessor.RestTemplateCallback<T> - Interface in org.springframework.vault.client

A callback for executing arbitrary operations on the RestTemplate.

VaultClient - Class in org.springframework.vault.client

Implementation of the low-level Vault client.

VaultClient() - Constructor for class org.springframework.vault.client.VaultClient

Creates a new VaultClient with a default a RestTemplate and VaultEndpoint.

VaultClient(RestTemplate, VaultEndpoint) - Constructor for class org.springframework.vault.client.VaultClient

Creates a new VaultClient for a RestTemplate and VaultEndpoint.

vaultClient() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

 

vaultClientFactory() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

Creates the VaultClientFactory to be used with VaultTemplate.

VaultClientFactory - Interface in org.springframework.vault.core

The strategy to produce a VaultClient instance(s).

VaultEndpoint - Class in org.springframework.vault.client

Value object that defines Vault connection coordinates.

VaultEndpoint() - Constructor for class org.springframework.vault.client.VaultEndpoint

 

vaultEndpoint() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

 

VaultException - Exception in org.springframework.vault.client

The Spring Vault specific NestedRuntimeException implementation.

VaultException(String) - Constructor for exception org.springframework.vault.client.VaultException

Creates a VaultException with the specified detail message.

VaultException(String, Throwable) - Constructor for exception org.springframework.vault.client.VaultException

Creates a NestedRuntimeException with the specified detail message and nested exception.

VaultHealth - Class in org.springframework.vault.support

Value object to bind HTTP API responses for sys/health.

VaultInitializationRequest - Class in org.springframework.vault.support

Value object to bind Vault HTTP Initialization API requests.

VaultInitializationRequest() - Constructor for class org.springframework.vault.support.VaultInitializationRequest

 

VaultInitializationRequest(int, int) - Constructor for class org.springframework.vault.support.VaultInitializationRequest

 

VaultInitializationResponse - Class in org.springframework.vault.support

Value object to bind Vault HTTP Initialization API responses.

VaultInitializationResponse() - Constructor for class org.springframework.vault.support.VaultInitializationResponse

 

VaultMount - Class in org.springframework.vault.support

Value object to bind Vault HTTP Mount API requests/responses.

VaultMount.VaultMountBuilder - Class in org.springframework.vault.support

Builder to build a VaultMount.

VaultOperations - Interface in org.springframework.vault.core

Interface that specifies a basic set of Vault operations, implemented by VaultTemplate.

VaultOperations.ClientCallback<T> - Interface in org.springframework.vault.core

A callback for executing arbitrary operations on the VaultClient.

VaultOperations.SessionCallback<T> - Interface in org.springframework.vault.core

A callback for executing arbitrary operations on the VaultOperations.VaultSession.

VaultOperations.VaultSession - Interface in org.springframework.vault.core

An authenticated Vault session.

VaultResponse - Class in org.springframework.vault.support

Value object to bind generic Vault HTTP API responses.

VaultResponse() - Constructor for class org.springframework.vault.support.VaultResponse

 

VaultResponseEntity<T> - Class in org.springframework.vault.client

Encapsulates the client response used in VaultAccessor.

VaultResponseSupport<T> - Class in org.springframework.vault.support

Value object to bind generic Vault HTTP API responses.

VaultResponseSupport() - Constructor for class org.springframework.vault.support.VaultResponseSupport

 

VaultSysOperations - Interface in org.springframework.vault.core

Interface that specified a basic set of Vault operations, implemented by VaultTemplate.

VaultSysTemplate - Class in org.springframework.vault.core

Default implementation of VaultSysOperations.

VaultSysTemplate(VaultOperations) - Constructor for class org.springframework.vault.core.VaultSysTemplate

Creates a new VaultSysTemplate with the given VaultOperations.

vaultTemplate() - Method in class org.springframework.vault.config.AbstractVaultConfiguration

Creates a VaultTemplate.

VaultTemplate - Class in org.springframework.vault.core

This class encapsulates main Vault interaction.

VaultTemplate() - Constructor for class org.springframework.vault.core.VaultTemplate

Creates a new VaultTemplate without setting VaultClientFactory and SessionManager.

VaultTemplate(VaultClient, ClientAuthentication) - Constructor for class org.springframework.vault.core.VaultTemplate

Creates a new VaultTemplate with a VaultClient and ClientAuthentication.

VaultTemplate(VaultClientFactory, SessionManager) - Constructor for class org.springframework.vault.core.VaultTemplate

Creates a new VaultTemplate with a VaultClientFactory and SessionManager.

VaultToken - Class in org.springframework.vault.support

Value object for a Vault token.

VaultTokenOperations - Interface in org.springframework.vault.core

Interface that specifies token-related operations.

VaultTokenRequest - Class in org.springframework.vault.support

Value object to bind Vault HTTP Token API requests.

VaultTokenRequest() - Constructor for class org.springframework.vault.support.VaultTokenRequest

 

VaultTokenResponse - Class in org.springframework.vault.support

Value object to bind Vault HTTP Token API responses.

VaultTokenResponse() - Constructor for class org.springframework.vault.support.VaultTokenResponse

 

VaultTokenTemplate - Class in org.springframework.vault.core

Default implementation of VaultTokenOperations.

VaultTokenTemplate(VaultOperations) - Constructor for class org.springframework.vault.core.VaultTokenTemplate

Creates a new VaultTokenTemplate with the given VaultOperations.

VaultTransitKey - Class in org.springframework.vault.support

Value object to bind Vault HTTP Transit Key API responses.

VaultTransitKey() - Constructor for class org.springframework.vault.support.VaultTransitKey

 

VaultTransitKeyConfiguration - Class in org.springframework.vault.support

Value object to bind Vault HTTP Transit Key Config API requests.

VaultTransitKeyConfiguration() - Constructor for class org.springframework.vault.support.VaultTransitKeyConfiguration

 

VaultTransitKeyConfiguration(Boolean, Integer) - Constructor for class org.springframework.vault.support.VaultTransitKeyConfiguration

 

VaultTransitKeyCreationRequest - Class in org.springframework.vault.support

Transit backend key creation request options.

VaultTransitKeyCreationRequest() - Constructor for class org.springframework.vault.support.VaultTransitKeyCreationRequest

Creates a new VaultTransitKeyCreationRequest.

VaultTransitKeyCreationRequest(boolean, boolean) - Constructor for class org.springframework.vault.support.VaultTransitKeyCreationRequest

Creates a new VaultTransitKeyCreationRequest and sets derived and convergentEncryption properties.

VaultTransitOperations - Interface in org.springframework.vault.core

Interface that specifies operations using the transit backend.

VaultTransitRequest - Class in org.springframework.vault.support

Transit backend encryption/decryption/rewrapping request options.

VaultTransitRequest() - Constructor for class org.springframework.vault.support.VaultTransitRequest

 

VaultTransitTemplate - Class in org.springframework.vault.core

Default implementation of VaultTransitOperations.

VaultTransitTemplate(VaultOperations, String) - Constructor for class org.springframework.vault.core.VaultTransitTemplate

 

VaultUnsealStatus - Class in org.springframework.vault.support

Value object to bind Vault HTTP Unseal API responses.

VaultUnsealStatus() - Constructor for class org.springframework.vault.support.VaultUnsealStatus

 

W

wrapped() - Method in class org.springframework.vault.authentication.CubbyholeAuthenticationOptions.CubbyholeAuthenticationOptionsBuilder

Configures whether to use wrapped token responses.

write(String, Object) - Method in interface org.springframework.vault.core.VaultOperations

Write to a secret backend.

write(String, Object) - Method in class org.springframework.vault.core.VaultTemplate