VaultClient (Spring Vault 1.0.0.BUILD-SNAPSHOT API)

java.lang.Object
- org.springframework.vault.client.VaultAccessor
- - org.springframework.vault.client.VaultClient

```
public class VaultClient
extends VaultAccessor
```
Implementation of the low-level Vault client. This client uses the Vault HTTP API to issue requests using different HTTP methods. VaultClient is configured with an VaultEndpoint and RestTemplate. It does not maintain any session or token state. See VaultTemplate and SessionManager for authenticated and stateful Vault access. VaultClient encapsulates base URI and path construction and uses VaultAccessor for request and error handling by returning VaultResponseEntity for requests.

Author:

Mark Paluch

See Also:

VaultResponseEntity, VaultTemplate

Nested Class Summary
- Nested classes/interfaces inherited from class org.springframework.vault.client.VaultAccessor
  VaultAccessor.RestTemplateCallback<T>

Field Summary

Fields
Modifier and Type Field and Description

static String VAULT_TOKEN

Fields
Modifier and Type	Field and Description
`static String`	`VAULT_TOKEN`

Constructor Summary

Constructors
Constructor and Description
`VaultClient()` Creates a new `VaultClient` with a default a `RestTemplate` and `VaultEndpoint`.
`VaultClient(RestTemplate restTemplate, VaultEndpoint endpoint)` Creates a new `VaultClient` for a `RestTemplate` and `VaultEndpoint`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected URI`	`buildUri(String pathTemplate, Map<String,?> uriVariables)` Build the Vault `URI` based on the given `VaultEndpoint` and `pathTemplate`.
`static HttpHeaders`	`createHeaders(VaultToken vaultToken)` Create `HttpHeaders` for a `VaultToken`.
`<T,S extends T> VaultResponseEntity<S>`	`deleteForEntity(String path, VaultToken vaultToken, Class<T> responseType)` Delete a resource by DELETEing from the path, and returns the response as `VaultResponseEntity`.
`<T> T`	`doWithRestTemplate(String pathTemplate, Map<String,?> uriVariables, VaultAccessor.RestTemplateCallback<T> callback)` Executes a `RestTemplateCallback`.
`<T,S extends T> VaultResponseEntity<S>`	`exchange(String pathTemplate, HttpMethod method, HttpEntity<?> requestEntity, Class<T> responseType, Map<String,?> uriVariables)` Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`exchange(String pathTemplate, HttpMethod method, HttpEntity<?> requestEntity, ParameterizedTypeReference<T> responseType, Map<String,?> uriVariables)` Execute the HTTP method to the given path template, writing the given request entity to the request, and returns the response as `VaultResponseEntity`.
`VaultEndpoint`	`getEndpoint()`
`<T,S extends T> VaultResponseEntity<S>`	`getForEntity(String path, Class<T> responseType)` Retrieve a resource by GETting from the path, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`getForEntity(String path, VaultToken vaultToken, Class<T> responseType)` Retrieve a resource by GETting from the path, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`postForEntity(String path, Object request, Class<T> responseType)` Issue a POST request using the given object to the path, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`postForEntity(String path, VaultToken vaultToken, Object request, Class<T> responseType)` Issue a POST request using the given object to the path, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`putForEntity(String path, Object request, Class<T> responseType)` Create a new resource by PUTting the given object to the path, and returns the response as `VaultResponseEntity`.
`<T,S extends T> VaultResponseEntity<S>`	`putForEntity(String path, VaultToken vaultToken, Object request, Class<T> responseType)` Create a new resource by PUTting the given object to the path, and returns the response as `VaultResponseEntity`.
`<T> T`	`unwrap(String wrappedResponse, Class<T> responseType)` Unwrap a wrapped response created by Vault Response Wrapping

Methods inherited from class org.springframework.vault.client.VaultAccessor
doWithRestTemplate, exchange, exchange, getRestTemplate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- VAULT_TOKEN
```
public static final String VAULT_TOKEN
```
  See Also:
  
  Constant Field Values

Constructor Detail
- VaultClient
```
public VaultClient()
```
  Creates a new VaultClient with a default a RestTemplate and VaultEndpoint.
  
  See Also:
  
  VaultEndpoint
- VaultClient
```
public VaultClient(RestTemplate restTemplate,
                   VaultEndpoint endpoint)
```
  Creates a new VaultClient for a RestTemplate and VaultEndpoint.
  
  Parameters:
  
  restTemplate - must not be null.
  
  endpoint - must not be null.

Method Detail

getForEntity
```
public <T,S extends T> VaultResponseEntity<S> getForEntity(String path,
                                                           Class<T> responseType)
```
Retrieve a resource by GETting from the path, and returns the response as VaultResponseEntity.

Parameters:

path - the path.

responseType - the type of the return value

Returns:

the response as entity.

See Also:

VaultResponseEntity

getForEntity

public <T,S extends T> VaultResponseEntity<S> getForEntity(String path,
                                                           VaultToken vaultToken,
                                                           Class<T> responseType)

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

Parameters:: path - the path.; vaultToken - the VaultToken.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

postForEntity

public <T,S extends T> VaultResponseEntity<S> postForEntity(String path,
                                                            Object request,
                                                            Class<T> responseType)

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

Parameters:: path - the path.; request - the Object to be POSTed, may be null.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

postForEntity

public <T,S extends T> VaultResponseEntity<S> postForEntity(String path,
                                                            VaultToken vaultToken,
                                                            Object request,
                                                            Class<T> responseType)

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

Parameters:: path - the path.; vaultToken - the VaultToken.; request - the Object to be POSTed, may be null.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

putForEntity

public <T,S extends T> VaultResponseEntity<S> putForEntity(String path,
                                                           Object request,
                                                           Class<T> responseType)

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

Parameters:: path - the path.; request - the Object to be PUT.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

putForEntity

public <T,S extends T> VaultResponseEntity<S> putForEntity(String path,
                                                           VaultToken vaultToken,
                                                           Object request,
                                                           Class<T> responseType)

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

Parameters:: path - the path.; vaultToken - the VaultToken.; request - the Object to be PUT.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

deleteForEntity

public <T,S extends T> VaultResponseEntity<S> deleteForEntity(String path,
                                                              VaultToken vaultToken,
                                                              Class<T> responseType)

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

Parameters:: path - the path.; vaultToken - the VaultToken.; responseType - the type of the return value
Returns:: the response as entity.
See Also:: VaultResponseEntity

exchange

public <T,S extends T> VaultResponseEntity<S> exchange(String pathTemplate,
                                                       HttpMethod method,
                                                       HttpEntity<?> requestEntity,
                                                       Class<T> responseType,
                                                       Map<String,?> uriVariables)
                                                throws RestClientException

Execute the HTTP method to the given URI template, writing the given request entity to the request, and returns the response as VaultResponseEntity. URI Template variables are using the given URI variables, if any.

Parameters:: pathTemplate - the path template.; method - the HTTP method (GET, POST, etc).; requestEntity - the entity (headers and/or body) to write to the request, may be null.; responseType - the type of the return value.; uriVariables - the variables to expand in the template.
Returns:: the response as entity.
Throws:: RestClientException

exchange

public <T,S extends T> VaultResponseEntity<S> exchange(String pathTemplate,
                                                       HttpMethod method,
                                                       HttpEntity<?> requestEntity,
                                                       ParameterizedTypeReference<T> responseType,
                                                       Map<String,?> uriVariables)
                                                throws RestClientException

Execute the HTTP method to the given path template, writing the given request entity to the request, and returns the response as VaultResponseEntity. The given ParameterizedTypeReference is used to pass generic type information:

 ParameterizedTypeReference<List<MyBean>> myBean = new ParameterizedTypeReference<List<MyBean>>() {};
 ResponseEntity<List<MyBean>> response = client.exchange("http://example.com", HttpMethod.GET, null, myBean, null);

Parameters:: pathTemplate - the path template.; method - the HTTP method (GET, POST, etc).; requestEntity - the entity (headers and/or body) to write to the request, may be null.; responseType - the type of the return value.; uriVariables - the variables to expand in the template.
Returns:: the response as entity.
Throws:: RestClientException

doWithRestTemplate
```
public <T> T doWithRestTemplate(String pathTemplate,
                                Map<String,?> uriVariables,
                                VaultAccessor.RestTemplateCallback<T> callback)
```
Executes a RestTemplateCallback. Allows to interact with the underlying RestTemplate and benefit from optional parameter expansion.

Parameters:

pathTemplate - the path template.

uriVariables - the variables to expand in the template

callback - the request.

Returns:

the RestTemplateCallback return value.

getEndpoint
```
public VaultEndpoint getEndpoint()
```
Returns:

the configured VaultEndpoint.

buildUri
```
protected URI buildUri(String pathTemplate,
                       Map<String,?> uriVariables)
```
Build the Vault URI based on the given VaultEndpoint and pathTemplate. URI template variables will be expanded using uriVariables.

Parameters:

pathTemplate - must not be empty or null.

uriVariables - must not be null.

Returns:

See Also:

UriComponentsBuilder

createHeaders
```
public static HttpHeaders createHeaders(VaultToken vaultToken)
```
Create HttpHeaders for a VaultToken.

Parameters:

vaultToken - must not be null.

Returns:

HttpHeaders for a VaultToken.

unwrap
```
public <T> T unwrap(String wrappedResponse,
                    Class<T> responseType)
```
Unwrap a wrapped response created by Vault Response Wrapping

Parameters:

wrappedResponse - the wrapped response , must not be empty or null.

responseType - the type of the return value.

Returns:

the unwrapped response.

Class VaultClient

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.vault.client.VaultAccessor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.springframework.vault.client.VaultAccessor

Methods inherited from class java.lang.Object

Field Detail

VAULT_TOKEN

Constructor Detail

VaultClient

VaultClient

Method Detail

getForEntity

getForEntity

postForEntity

postForEntity

putForEntity

putForEntity

deleteForEntity

exchange

exchange

doWithRestTemplate

getEndpoint

buildUri

createHeaders

unwrap