Spring Vault

https://docs.spring.io/spring-vault/reference/
Admin
Spring Vault provides client-side integration for HashiCorp Vault, enabling Spring applications to...
Tokens:572,847
Snippets:7,638
Trust Score:10
Update:1 hour ago
Show doc for...
Tokens:
Raw
### get()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.html

Starts building an HTTP GET request. This is an instance method.

```APIDOC
## get()

### Description
Start building an HTTP GET request.

### Method
GET

### Signature
`ReactiveVaultClient.RequestHeadersPathSpec<?> get()`

### Returns
A spec for specifying the target path.
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/certificate/CertificateContainer.html

Starts the CertificateContainer.

```APIDOC
## start()

### Description
Start the CertificateContainer.

### Method
public void start()
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/certificate/CertificateContainer.html

Starts the CertificateContainer. Starting the container will initially obtain certificates for the requested certificates. A started container publishes events through CertificateListener. Additional certificates can be requested at any time.

```APIDOC
## start()

### Description
Starts the CertificateContainer. Starting the container will initially obtain certificates for the requested certificates. A started container publishes events through CertificateListener. Additional certificates can be requested at any time.

### Method
start

### Notes
- Multiple calls are synchronized to start the container only once.
- Container start requires initialization and cannot be started once the container was destroyed.
- Specified by: `start` in interface `Lifecycle`
- See Also: `afterPropertiesSet()`, `stop()`
```

--------------------------------

### CertificateContainer usage example

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/certificate/CertificateContainer.html

Shows how to create a CertificateContainer, register a trust anchor, add a certificate listener, and start the container. Events are triggered after starting the container.

```java
 CertificateContainer container = new CertificateContainer(vaultOperations.opsForPki());
 RequestedCertificate cert = container
                .register(RequestedCertificate.trustAnchor("vault-ca"));
 container.addCertificateListener(new CertificateListenerAdapter() {
        @Override
        public void onCertificateEvent(CertificateEvent event) {
                if (cert.equals(event.getSource())) {
                        if (event instanceof CertificateObtainedEvent) {
                                // certificate obtained
                        }
                }
        }
 });
 container.afterPropertiesSet();
 container.start(); // events are triggered after starting the container
```

--------------------------------

### start()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/lease/SecretLeaseContainer.html

Starts the SecretLeaseContainer. Starting the container will initially obtain secrets and leases for the requested secrets. A started container publishes events through LeaseListener. Additional secrets can be requested at any time. Multiple calls are synchronized to start the container only once. Container start requires initialization and cannot be started once the container was destroyed.

```APIDOC
## start()

### Description
Starts the SecretLeaseContainer. Starting the container will initially obtain secrets and leases for the requested secrets. A started container publishes events through LeaseListener. Additional secrets can be requested at any time. Multiple calls are synchronized to start the container only once. Container start requires initialization and cannot be started once the container was destroyed.

### Method
start

### See Also
- afterPropertiesSet()
- stop()
```

--------------------------------

### ReactiveVaultClient.get()

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Start building an HTTP GET request.

```APIDOC
## get() - Method in interface org.springframework.vault.client.ReactiveVaultClient

### Description
Start building an HTTP GET request.

### Method
`WebClient.RequestHeadersSpec<?> get()`
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/VaultClient.html

Starts building an HTTP GET request. Returns a spec for specifying the target path.

```APIDOC
## GET Request

### Description
Starts building an HTTP GET request.

### Method
GET

### Returns
A spec for specifying the target path.
```

--------------------------------

### VaultClient.get()

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Start building an HTTP GET request.

```APIDOC
## get() - Method in interface org.springframework.vault.client.VaultClient

### Description
Start building an HTTP GET request.

### Method
`RestTemplate get()`
```

--------------------------------

### post()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.html

Starts building an HTTP POST request. This is an instance method.

```APIDOC
## post()

### Description
Start building an HTTP POST request.

### Method
POST

### Signature
`ReactiveVaultClient.RequestHeadersBodyPathSpec post()`

### Returns
A spec for specifying the target path.
```

--------------------------------

### post()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/VaultClient.html

Starts building an HTTP POST request. Returns a spec for specifying the target path.

```APIDOC
## POST Request

### Description
Starts building an HTTP POST request.

### Method
POST

### Returns
A spec for specifying the target path.
```

--------------------------------

### SslConfiguration.KeyStoreConfiguration.of(Resource)

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Create a new SslConfiguration.KeyStoreConfiguration given Resource.

```APIDOC
## SslConfiguration.KeyStoreConfiguration.of(Resource)

### Description
Create a new `SslConfiguration.KeyStoreConfiguration` given `Resource`.

### Method
Static factory method

### Signature
`public static KeyStoreConfiguration of(Resource resource)`

### Parameters
- **resource** (Resource) - Required - The resource for the keystore.

### Returns
- **SslConfiguration.KeyStoreConfiguration** - A new KeyStoreConfiguration instance.
```

--------------------------------

### method(HttpMethod method)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.html

Starts building a request for the given HttpMethod. This is an instance method.

```APIDOC
## method(HttpMethod method)

### Description
Start building a request for the given `HttpMethod`.

### Method
CUSTOM

### Signature
`ReactiveVaultClient.RequestHeadersBodyPathSpec method(HttpMethod method)`

### Parameters
- **method** (HttpMethod) - Required - The HTTP method to use.

### Returns
A spec for specifying the target path.
```

--------------------------------

### createKeyStore(String keyAlias, CharSequence password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore with a password.

```APIDOC
## createKeyStore(String keyAlias, CharSequence password)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias, CharSequence password)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.
- **password** (CharSequence) - Required - the password to use.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.

### Since
2.4
```

--------------------------------

### create(Resource, char[], Resource, char[])

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store and trust store with the default KeyStore type.

```APIDOC
## create(Resource, char[], Resource, char[])

### Description
Creates a new SslConfiguration for the given key store and trust store with the default KeyStore type.

### Method
Static factory method

### Signature
`public static SslConfiguration create(Resource keyStore, char @Nullable [] keyStorePassword, Resource trustStore, char @Nullable [] trustStorePassword)`

### Parameters
- **keyStore** (Resource) - Required - resource pointing to an existing keystore, must not be null.
- **keyStorePassword** (char[]) - Optional - may be null.
- **trustStore** (Resource) - Required - resource pointing to an existing trust store, must not be null.
- **trustStorePassword** (char[]) - Optional - may be null.

### Returns
- **SslConfiguration** - the created SslConfiguration.

### See Also
- KeyStore
```

--------------------------------

### AWS-EC2 authentication flow composition

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/AuthenticationSteps.html

Shows how to start an authentication flow using AuthenticationSteps.fromHttpRequest, map the response to a login map, and finish with loginAt. The example uses a nonce and pkcs7 from an identity document.

```java
 String nonce = "";
 return AuthenticationSteps
                .fromHttpRequest(
                                HttpRequestBuilder.get(options.getIdentityDocumentUri().toString()) //
                                                .as(String.class)) //
                .map(pkcs7 -> pkcs7.replaceAll("\\r", "")) //
                .map(pkcs7 -> {

                        Map<String, String> login = new HashMap<>();

                        login.put("nonce", new String(nonce));
                        login.put("pkcs7", pkcs7);

                        return login;
                }).loginAt(options.getPath());
 
```

--------------------------------

### build()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/PcfAuthenticationOptions.PcfAuthenticationOptionsBuilder.html

Builds a new PcfAuthenticationOptions instance. Falls back to environment variables CF_INSTANCE_CERT and CF_INSTANCE_KEY if suppliers are not configured.

```APIDOC
## build()

### Description
Builds a new PcfAuthenticationOptions instance.

### Method
Builder method

### Returns
A new `PcfAuthenticationOptions`.

### Throws
- `IllegalStateException` - if `instanceCertificate(Supplier)` or `instanceKey(Supplier)` are not set and the corresponding environment variable `CF_INSTANCE_CERT` respective `CF_INSTANCE_KEY` is not set.
```

--------------------------------

### Setup CubbyholeAuthentication

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/CubbyholeAuthentication.html

Java code to configure and instantiate CubbyholeAuthentication using CubbyholeAuthenticationOptions and a VaultClient. The initial token is the one created in the previous example, and the path points to the Cubbyhole secret where the token is stored.

```java
CubbyholeAuthenticationOptions options = CubbyholeAuthenticationOptions
                .builder()
                .initialToken(VaultToken.of("895cb88b-aef4-0e33-ba65-d50007290780"))
                .path("cubbyhole/token")
                .build();
CubbyholeAuthentication authentication = new CubbyholeAuthentication(options, vaultClient);
```

--------------------------------

### Retrieve response as entity using retrieve().toEntity()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.RequestHeadersSpec.html

Shows how to use retrieve() to obtain a Mono<ResponseEntity<Person>> from a GET request. The example sets the URI and Accept header, then calls toEntity(Person.class). By default, 4xx and 5xx responses result in a VaultClientResponseException.

```java
Mono<ResponseEntity<Person>> entityMono = client.get()
    .uri("/persons/1")
    .accept(MediaType.APPLICATION_JSON)
    .retrieve()
    .toEntity(Person.class);
```

--------------------------------

### Retrieve response body using retrieve().bodyToMono()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.RequestHeadersSpec.html

Shows how to use retrieve() to obtain a Mono<Person> from a GET request when only the body is needed. The example sets the URI and Accept header, then calls bodyToMono(Person.class). By default, 4xx and 5xx responses result in a VaultClientResponseException.

```java
Mono<Person> entityMono = client.get()
    .uri("/persons/1")
    .accept(MediaType.APPLICATION_JSON)
    .retrieve()
    .bodyToMono(Person.class);
```

--------------------------------

### createKeyStore(String keyAlias, char[] password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore with a char array password.

```APIDOC
## createKeyStore(String keyAlias, char[] password)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias, char[] password)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.
- **password** (char[]) - Required - the password to use.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.

### Since
2.4
```

--------------------------------

### createKeyStore(String keyAlias, boolean includeCaChain, CharSequence password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore with CA chain option and password.

```APIDOC
## createKeyStore(String keyAlias, boolean includeCaChain, CharSequence password)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias, boolean includeCaChain, CharSequence password)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.
- **includeCaChain** (boolean) - Required - whether to include the certificate authority chain instead of just the issuer certificate.
- **password** (CharSequence) - Required - the password to use.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.

### Since
2.4
```

--------------------------------

### get(URI uri)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/AuthenticationSteps.HttpRequestBuilder.html

Builder entry point to GET from a URI. Creates a new HttpRequestBuilder for a GET request.

```APIDOC
## GET (Builder entry point)

### Description
Builder entry point to `GET` from `uri`. Returns a new `AuthenticationSteps.HttpRequestBuilder`.

### Method
GET

### Endpoint
`uri`

### Parameters
#### Path Parameters
- `uri` (URI) - Required - must not be null.

### Returns
A new `AuthenticationSteps.HttpRequestBuilder`.
```

--------------------------------

### createKeyStore(String keyAlias, char[] password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with a password.

```APIDOC
## [INSTANCE] createKeyStore(String keyAlias, char[] password)

### Description
Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with a password.

### Method
Instance method

### Parameters
- **keyAlias** (String) - Required - the alias for the key in the KeyStore.
- **password** (char[]) - Required - the password for the KeyStore.

### Returns
- **KeyStore** - the created KeyStore.
```

--------------------------------

### get(String uriTemplate, String... uriVariables)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/AuthenticationSteps.HttpRequestBuilder.html

Builder entry point to GET from a URI template. Creates a new HttpRequestBuilder for a GET request.

```APIDOC
## GET (Builder entry point)

### Description
Builder entry point to `GET` from `uriTemplate`. Returns a new `AuthenticationSteps.HttpRequestBuilder`.

### Method
GET

### Endpoint
`uriTemplate` (with optional `uriVariables` for expansion)

### Parameters
#### Path Parameters
- `uriTemplate` (String) - Required - must not be null or empty.
- `uriVariables` (String...) - Optional - variables to expand the template.

### Returns
A new `AuthenticationSteps.HttpRequestBuilder`.
```

--------------------------------

### createKeyStore(String keyAlias, boolean includeCaChain, char[] password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore with CA chain option and char array password.

```APIDOC
## createKeyStore(String keyAlias, boolean includeCaChain, char[] password)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias, boolean includeCaChain, char[] password)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.
- **includeCaChain** (boolean) - Required - whether to include the certificate authority chain instead of just the issuer certificate.
- **password** (char[]) - Required - the password to use.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.

### Since
2.4
```

--------------------------------

### getAuthMounts

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/VaultSysOperations.html

Gets all auth method mounts. Maps to GET /sys/auth/.

```APIDOC
## GET /sys/auth/

### Description
Returns a `Map` of all auth method `mounts`.

### Method
GET

### Endpoint
/sys/auth/

### Response
#### Success Response (200)
- **Map<String,VaultMount>** - map of all auth method mounts.

### Throws
- `VaultException`
```

--------------------------------

### getMounts

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/VaultSysOperations.html

Gets all secrets engine mounts. Maps to GET /sys/mounts/.

```APIDOC
## GET /sys/mounts/

### Description
Returns a `Map` of all secrets engine `mounts`.

### Method
GET

### Endpoint
/sys/mounts/

### Response
#### Success Response (200)
- **Map<String,VaultMount>** - map of all secrets engine mounts.

### Throws
- `VaultException`
```

--------------------------------

### getUnsealStatus

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/VaultSysOperations.html

Gets the current unseal status. Maps to GET /sys/unseal.

```APIDOC
## GET /sys/unseal

### Description
Returns the `VaultUnsealStatus`.

### Method
GET

### Endpoint
/sys/unseal

### Response
#### Success Response (200)
- **VaultUnsealStatus** - the unseal status.

### Throws
- `VaultException`
```

--------------------------------

### forKeyStore(Resource, char[], KeyConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store with the default KeyStore type and key configuration.

```APIDOC
## forKeyStore(Resource, char[], KeyConfiguration)

### Description
Creates a new SslConfiguration for the given key store with the default KeyStore type and key configuration.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(Resource keyStore, char @Nullable [] keyStorePassword, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- **keyStore** (Resource) - Required - resource pointing to an existing key store, must not be null.
- **keyStorePassword** (char[]) - Optional - may be null.
- **keyConfiguration** (SslConfiguration.KeyConfiguration) - Required - the configuration for a specific key in keyStoreConfiguration to use.

### Returns
- **SslConfiguration** - the created SslConfiguration.

### Since
2.2

### See Also
- KeyStore
```

--------------------------------

### SslConfiguration.withKeyStore(KeyStoreConfiguration, KeyConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration with the given key store and key configuration applied, retaining the trust store configuration.

```APIDOC
## [METHOD] SslConfiguration.withKeyStore(KeyStoreConfiguration, KeyConfiguration)

### Description
Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` and `SslConfiguration.KeyConfiguration` applied, retaining the `trust store` configuration.

### Method
Instance method

### Signature
`SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- `configuration` (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.
- `keyConfiguration` (SslConfiguration.KeyConfiguration) - Required - The key configuration.

### Returns
A new `SslConfiguration` instance.

```

--------------------------------

### Example Vault properties

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/config/EnvironmentVaultConfiguration.html

Example properties for configuring Vault URI and token.

```properties
vault.uri=https://localhost:8200
vault.token=00000000-0000-0000-0000-000000000000
```

--------------------------------

### createKeyStore(String keyAlias, boolean includeCaChain)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore with option to include CA chain.

```APIDOC
## createKeyStore(String keyAlias, boolean includeCaChain)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias, boolean includeCaChain)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.
- **includeCaChain** (boolean) - Required - whether to include the certificate authority chain instead of just the issuer certificate.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.

### Since
2.3.3
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/GoogleCredentialsSupplier.html

Exception-safe helper to get ServiceAccountCredentials from getCredentials(). This method is a default method that wraps the getCredentials() call.

```APIDOC
## get()

### Description
Exception-safe helper to get `ServiceAccountCredentials` from `getCredentials()`.

### Method
`default com.google.auth.oauth2.GoogleCredentials get()`

### Returns
- `com.google.auth.oauth2.GoogleCredentials` - the ServiceAccountCredentials for JWT signing.

### Specified By
- `get` in interface `Supplier<com.google.auth.oauth2.GoogleCredentials>`
```

--------------------------------

### get()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/CredentialSupplier.html

Get a credential to be used with an authentication mechanism. This method is specified by the Supplier interface and returns the credential as a String.

```APIDOC
## get()

### Description
Get a credential to be used with an authentication mechanism.

### Method
`String get()`

### Returns
- **String** - the credential.

```

--------------------------------

### PcfAuthenticationOptions.getInstanceKeySupplier()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/PcfAuthenticationOptions.html

Returns the supplier for the instance key.

```APIDOC
## getInstanceKeySupplier()

### Description
Returns the supplier for the instance key.

### Method
getInstanceKeySupplier

### Signature
`public Supplier<String> getInstanceKeySupplier()`

### Returns
The instance key `Supplier`.
```

--------------------------------

### SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.html

Creates a new SslConfiguration with the key store configuration applied retaining the trust store configuration.

```APIDOC
## [INSTANCE] SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)

### Description
Creates a new SslConfiguration with SslConfiguration.KeyStoreConfiguration applied retaining the trust store configuration.

### Method
INSTANCE

### Signature
`SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)`

### Parameters
- **configuration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.

### Returns
- **SslConfiguration** - A new SslConfiguration instance with the applied key store configuration.
```

--------------------------------

### Retrieve ResponseEntity with VaultClient.RequestHeadersSpec.retrieve()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/VaultClient.RequestHeadersSpec.html

Shows how to use retrieve() to get a ResponseEntity<Person> from a GET request. The request is not executed until a method on the returned ResponseSpec is called.

```java
ResponseEntity<Person> entity = client.get()
    .path("/persons/1")
    .retrieve()
    .toEntity(Person.class);
```

--------------------------------

### bodyValue(Object) example

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.RequestBodySpec.html

Shows how to use bodyValue(Object) to set a request body with a value inserter. The example posts a Person object and retrieves a Mono<Void> response.

```java
Person person = ... ;

Mono<Void> result = client.post()
  .uri("/persons/{id}", id)
  .contentType(MediaType.APPLICATION_JSON)
  .bodyValue(person)
  .retrieve()
  .bodyToMono(Void.class);
```

--------------------------------

### SslConfiguration.forKeyStore(SslConfiguration.KeyStoreConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.html

Creates a new SslConfiguration for the given key store.

```APIDOC
## [STATIC] SslConfiguration.forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)

### Description
Creates a new SslConfiguration for the given key store.

### Method
STATIC

### Signature
`static SslConfiguration forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)`

### Parameters
- **keyStore** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.

### Returns
- **SslConfiguration** - A new SslConfiguration instance.
```

--------------------------------

### SslConfiguration.forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new SslConfiguration for the given key store.

```APIDOC
## [STATIC] SslConfiguration.forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)

### Description
Creates a new `SslConfiguration` for the given key store.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore)`

### Parameters
- **keyStore** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.

### Returns
- **SslConfiguration** - A new SSL configuration with the specified key store.

```

--------------------------------

### Register ManagedSecret with SecretLeaseContainer

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/lease/SecretLeaseContainer.html

Creates a SecretLeaseContainer, defines a rotating ManagedSecret for 'mysql/creds/my-role' that extracts the 'key' string, registers it with the container, then initializes and starts the container. Events are triggered after starting the container.

```java
 SecretLeaseContainer container = new SecretLeaseContainer(vaultOperations,
                taskScheduler);
 ManagedSecret managedSecret = ManagedSecret.rotating("mysql/creds/my-role", secret -> secret.getRequiredString("key"));
 managedSecret.register(container);
 container.afterPropertiesSet();
 container.start(); // events are triggered after starting the container
```

--------------------------------

### body(Publisher, Class) example

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.RequestBodySpec.html

Shows how to use body(Publisher, Class) to set a request body with a Publisher inserter. The example posts a Mono<Person> and retrieves a Mono<Void> response.

```java
Mono<Person> personMono = ... ;

Mono<Void> result = client.post()
  .uri("/persons/{id}", id)
  .contentType(MediaType.APPLICATION_JSON)
  .body(personMono, Person.class)
  .retrieve()
  .bodyToMono(Void.class);
```

--------------------------------

### forKeyStore(KeyStoreConfiguration, KeyConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.html

Creates a new SslConfiguration for the given key store and key configuration.

```APIDOC
## forKeyStore(KeyStoreConfiguration, KeyConfiguration)

### Description
Creates a new SslConfiguration for the given key store and key configuration.

### Method
Static factory method

### Signature
`public static SslConfiguration forKeyStore(SslConfiguration.KeyStoreConfiguration keyStore, SslConfiguration.KeyConfiguration keyConfiguration)`

### Parameters
- **keyStore** (SslConfiguration.KeyStoreConfiguration) - Required - must not be null.
- **keyConfiguration** (SslConfiguration.KeyConfiguration) - Required - the configuration for a specific key in keyStoreConfiguration to use.

### Returns
- **SslConfiguration** - the created SslConfiguration.

### Since
2.2

### See Also
- KeyStore
```

--------------------------------

### bodyValue(T, ParameterizedTypeReference) example

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.RequestBodySpec.html

Shows how to use bodyValue(T, ParameterizedTypeReference) to set a request body with a value inserter and capture generic type information. The example posts a List<Person> and retrieves a Mono<Void> response.

```java
List<Person> list = ... ;

Mono<Void> result = client.post()
  .uri("/persons/{id}", id)
  .contentType(MediaType.APPLICATION_JSON)
  .bodyValue(list, new ParameterizedTypeReference<List<Person>>() {};)
  .retrieve()
  .bodyToMono(Void.class);
```

--------------------------------

### createKeyStore(String keyAlias, CharSequence password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with a password as CharSequence.

```APIDOC
## [INSTANCE] createKeyStore(String keyAlias, CharSequence password)

### Description
Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with a password as CharSequence.

### Method
Instance method

### Parameters
- **keyAlias** (String) - Required - the alias for the key in the KeyStore.
- **password** (CharSequence) - Required - the password for the KeyStore.

### Returns
- **KeyStore** - the created KeyStore.
```

--------------------------------

### Request rotating secret with SecretLeaseContainer

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/lease/SecretLeaseContainer.html

Creates a SecretLeaseContainer with VaultOperations and a TaskScheduler, requests a rotating secret for 'mysql/creds/my-role', adds a lease listener to handle created and expired events, then initializes and starts the container. Events are triggered after starting the container.

```java
 SecretLeaseContainer container = new SecretLeaseContainer(vaultOperations,
                taskScheduler);
 RequestedSecret requestedSecret = container
                .requestRotatingSecret("mysql/creds/my-role");
 container.addLeaseListener(new LeaseListenerAdapter() {
        @Override
        public void onLeaseEvent(SecretLeaseEvent secretLeaseEvent) {
                if (requestedSecret.equals(secretLeaseEvent.getSource())) {
                        if (secretLeaseEvent instanceof SecretLeaseCreatedEvent) {
                        }
                        if (secretLeaseEvent instanceof SecretLeaseExpiredEvent) {
                        }
                }
        }
 });
 container.afterPropertiesSet();
 container.start(); // events are triggered after starting the container
```

--------------------------------

### create()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/WebClientFactory.html

Creates a WebClient instance with default configuration. This method is a default method that can be overridden.

```APIDOC
## create()

### Description
Creates a WebClient instance with default configuration.

### Method
create()

### Signature
`default WebClient create()`

### Parameters
None

### Returns
- **WebClient** - a WebClient instance.

```

--------------------------------

### build() - VaultTransitKeyConfiguration.VaultTransitKeyConfigurationBuilder

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Builds a new VaultTransitKeyConfiguration instance.

```APIDOC
## build() - VaultTransitKeyConfiguration.VaultTransitKeyConfigurationBuilder

### Description
Build a new `VaultTransitKeyConfiguration` instance.

### Method
build()

### Return Value
A new `VaultTransitKeyConfiguration` instance.
```

--------------------------------

### getKeys()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/VaultTransitOperations.html

Gets a List of transit key names.

```APIDOC
## getKeys()

### Description
Gets a List of transit key names.

### Method
getKeys

### Returns
List<String> - List of transit key names.
```

--------------------------------

### GoogleCredentialsSupplier.get()

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Exception-safe helper to get `ServiceAccountCredentials` from `GoogleCredentialsSupplier.getCredentials()`.

```APIDOC
## get() - Method in interface org.springframework.vault.authentication.GoogleCredentialsSupplier

### Description
Exception-safe helper to get `ServiceAccountCredentials` from `GoogleCredentialsSupplier.getCredentials()`.

### Method
`ServiceAccountCredentials get()`
```

--------------------------------

### KeyStoreConfiguration(Resource resource, char @Nullable [] storePassword, String storeType)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.KeyStoreConfiguration.html

Constructor to create a new SslConfiguration.KeyStoreConfiguration with the given resource, store password, and store type.

```APIDOC
## Constructor: KeyStoreConfiguration(Resource resource, char @Nullable [] storePassword, String storeType)

### Description
Creates a new `SslConfiguration.KeyStoreConfiguration` with the specified resource, store password, and store type.

### Parameters
- `resource` (Resource) - Required - The resource referencing the key store.
- `storePassword` (char @Nullable []) - Optional - The key store password, may be null.
- `storeType` (String) - Required - The key store type.

### Since
1.1
```

--------------------------------

### CredentialSupplier.get()

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Get a credential to be used with an authentication mechanism.

```APIDOC
## get() - Method in interface org.springframework.vault.authentication.CredentialSupplier

### Description
Get a credential to be used with an authentication mechanism.

### Method
`Object get()`
```

--------------------------------

### delete() - VaultClient

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Starts building an HTTP DELETE request.

```APIDOC
## delete()

### Description
Start building an HTTP DELETE request.

### Method
DELETE

### Endpoint
N/A (SDK method)

### Parameters
None

### Return
Returns a request builder for the DELETE request.

### Usage Example
```java
VaultClient client = ...;
client.delete().uri("/secret/my-secret").send();
```
```

--------------------------------

### createClient(ClientOptions, SslConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Creates a client using the provided options and SSL configuration.

```APIDOC
## createClient(ClientOptions, SslConfiguration)

### Description
Creates a client using the provided options and SSL configuration.

### Method
Static method

### Class
org.springframework.vault.client.ClientHttpConnectorFactory.ReactorNetty

### Parameters
- **options** (ClientOptions) - Required - The client options.
- **sslConfiguration** (SslConfiguration) - Required - The SSL configuration.

### Returns
A client instance.
```

--------------------------------

### delete() - ReactiveVaultClient

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Starts building an HTTP DELETE request.

```APIDOC
## delete()

### Description
Start building an HTTP DELETE request.

### Method
DELETE

### Endpoint
N/A (SDK method)

### Parameters
None

### Return
Returns a request builder for the DELETE request.

### Usage Example
```java
ReactiveVaultClient client = ...;
client.delete().uri("/secret/my-secret").send();
```
```

--------------------------------

### PcfAuthenticationOptions.getInstanceCertSupplier()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/PcfAuthenticationOptions.html

Returns the supplier for the instance certificate.

```APIDOC
## getInstanceCertSupplier()

### Description
Returns the supplier for the instance certificate.

### Method
getInstanceCertSupplier

### Signature
`public Supplier<String> getInstanceCertSupplier()`

### Returns
The instance certificate `Supplier`.
```

--------------------------------

### createKeyStore(String keyAlias)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain.

```APIDOC
## [INSTANCE] createKeyStore(String keyAlias)

### Description
Creates a KeyStore from this CertificateBundle containing the private key and certificate chain.

### Method
Instance method

### Parameters
- **keyAlias** (String) - Required - the alias for the key in the KeyStore.

### Returns
- **KeyStore** - the created KeyStore.
```

--------------------------------

### ClientHttpRequestFactoryFactory.JdkHttpClient.getBuilder

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.html

Gets a JDK HttpClient.Builder for the given ClientOptions and SslConfiguration.

```APIDOC
## ClientHttpRequestFactoryFactory.JdkHttpClient.getBuilder

### Description
Gets a JDK `HttpClient.Builder` for the given `ClientOptions` and `SslConfiguration`.

### Method
static

### Signature
`static HttpClient.Builder getBuilder(ClientOptions options, SslConfiguration sslConfiguration)`

### Parameters
- **options** (ClientOptions) - Required - The client options.
- **sslConfiguration** (SslConfiguration) - Required - The SSL configuration.

### Returns
- **HttpClient.Builder** - The JDK HttpClient.Builder.
```

--------------------------------

### getStoreType()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.KeyStoreConfiguration.html

Instance method to get the trust store type.

```APIDOC
## Method: getStoreType()

### Description
Returns the trust store type.

### Returns
The trust store type.
```

--------------------------------

### createKeyStore(String keyAlias)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain.

```APIDOC
## createKeyStore(String keyAlias)

### Description
Create a `KeyStore` from this `CertificateBundle` containing the private key and certificate chain.

### Method
public KeyStore createKeyStore(String keyAlias)

### Parameters
- **keyAlias** (String) - Required - the key alias to use.

### Returns
- **KeyStore** - the `KeyStore` containing the private key and certificate chain.
```

--------------------------------

### getResource()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/SslConfiguration.KeyStoreConfiguration.html

Instance method to get the key store resource.

```APIDOC
## Method: getResource()

### Description
Returns the key store resource.

### Returns
The key store resource or `null` if not configured.
```

--------------------------------

### build()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/KubernetesAuthenticationOptions.KubernetesAuthenticationOptionsBuilder.html

Builds a new KubernetesAuthenticationOptions instance with the configured settings.

```APIDOC
## build()

### Description
Builds a new KubernetesAuthenticationOptions instance.

### Method
N/A (Builder method)

### Parameters
None

### Returns
A new KubernetesAuthenticationOptions instance.

```

--------------------------------

### Lease.toString

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/lease/domain/Lease.html

Instance method to get a string representation of the lease.

```APIDOC
## Lease.toString

### Description
Returns a string representation of this Lease.

### Method
String toString()

### Returns
A string representation.

### Overrides
toString in class Object
```

--------------------------------

### SslConfiguration.KeyStoreConfiguration.of(Resource, char[], String)

Source: https://docs.spring.io/spring-vault/reference/api/java/index-all.html

Create a new SslConfiguration.KeyStoreConfiguration given Resource, storePassword, and keyStoreType.

```APIDOC
## SslConfiguration.KeyStoreConfiguration.of(Resource, char[], String)

### Description
Create a new `SslConfiguration.KeyStoreConfiguration` given `Resource`, `storePassword`, and `keyStoreType`.

### Method
Static factory method

### Signature
`public static KeyStoreConfiguration of(Resource resource, char[] storePassword, String keyStoreType)`

### Parameters
- **resource** (Resource) - Required - The resource for the keystore.
- **storePassword** (char[]) - Required - The store password.
- **keyStoreType** (String) - Required - The keystore type.

### Returns
- **SslConfiguration.KeyStoreConfiguration** - A new KeyStoreConfiguration instance.
```

--------------------------------

### SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new SslConfiguration with the given key store, key configuration, and trust store.

```APIDOC
## [CONSTRUCTOR] SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration)

### Description
Creates a new `SslConfiguration` with the specified key store configuration, key configuration, and trust store configuration.

### Method
Constructor

### Signature
`public SslConfiguration(SslConfiguration.KeyStoreConfiguration keyStoreConfiguration, SslConfiguration.KeyConfiguration keyConfiguration, SslConfiguration.KeyStoreConfiguration trustStoreConfiguration)`

### Parameters
- **keyStoreConfiguration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration.
- **keyConfiguration** (SslConfiguration.KeyConfiguration) - Required - The key configuration.
- **trustStoreConfiguration** (SslConfiguration.KeyStoreConfiguration) - Required - The trust store configuration.

```

--------------------------------

### Lease.hashCode

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/core/lease/domain/Lease.html

Instance method to get the hash code of the lease.

```APIDOC
## Lease.hashCode

### Description
Returns the hash code of this Lease.

### Method
int hashCode()

### Returns
The hash code.

### Overrides
hashCode in class Object
```

--------------------------------

### createKeyStore(String keyAlias, boolean includeCaChain, char[] password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with option to include the CA chain and a password.

```APIDOC
## [INSTANCE] createKeyStore(String keyAlias, boolean includeCaChain, char[] password)

### Description
Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with option to include the CA chain and a password.

### Method
Instance method

### Parameters
- **keyAlias** (String) - Required - the alias for the key in the KeyStore.
- **includeCaChain** (boolean) - Required - whether to include the CA chain.
- **password** (char[]) - Required - the password for the KeyStore.

### Returns
- **KeyStore** - the created KeyStore.
```

--------------------------------

### getRight()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/AuthenticationSteps.Pair.html

Type-safe way to get the second object of this AuthenticationSteps.Pair.

```APIDOC
## getRight()

### Description
Type-safe way to get the second object of this `AuthenticationSteps.Pair`.

### Method
Instance method

### Signature
`public R getRight()`

### Returns
The second object.
```

--------------------------------

### getLeft()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/authentication/AuthenticationSteps.Pair.html

Type-safe way to get the first object of this AuthenticationSteps.Pair.

```APIDOC
## getLeft()

### Description
Type-safe way to get the first object of this `AuthenticationSteps.Pair`.

### Method
Instance method

### Signature
`public L getLeft()`

### Returns
The first object.
```

--------------------------------

### createKeyStore(String keyAlias, boolean includeCaChain, CharSequence password)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/CertificateBundle.html

Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with option to include the CA chain and a password as CharSequence.

```APIDOC
## [INSTANCE] createKeyStore(String keyAlias, boolean includeCaChain, CharSequence password)

### Description
Creates a KeyStore from this CertificateBundle containing the private key and certificate chain, with option to include the CA chain and a password as CharSequence.

### Method
Instance method

### Parameters
- **keyAlias** (String) - Required - the alias for the key in the KeyStore.
- **includeCaChain** (boolean) - Required - whether to include the CA chain.
- **password** (CharSequence) - Required - the password for the KeyStore.

### Returns
- **KeyStore** - the created KeyStore.
```

--------------------------------

### delete()

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/client/ReactiveVaultClient.html

Starts building an HTTP DELETE request. This is an instance method.

```APIDOC
## delete()

### Description
Start building an HTTP DELETE request.

### Method
DELETE

### Signature
`ReactiveVaultClient.RequestHeadersPathSpec<?> delete()`

### Returns
A spec for specifying the target path.
```

--------------------------------

### SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)

Source: https://docs.spring.io/spring-vault/reference/api/java/org/springframework/vault/support/class-use/SslConfiguration.KeyStoreConfiguration.html

Creates a new SslConfiguration with the given key store configuration, retaining the trust store configuration.

```APIDOC
## [INSTANCE] SslConfiguration.withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)

### Description
Creates a new `SslConfiguration` with `SslConfiguration.KeyStoreConfiguration` applied retaining the `trust store` configuration.

### Method
Instance method

### Signature
`public SslConfiguration withKeyStore(SslConfiguration.KeyStoreConfiguration configuration)`

### Parameters
- **configuration** (SslConfiguration.KeyStoreConfiguration) - Required - The key store configuration to apply.

### Returns
- **SslConfiguration** - A new SSL configuration with the specified key store and the existing trust store.

```
Tokens:
Raw