Package org.springframework.vault.client

Interface VaultClient.ResponseSpec

Enclosing interface:

VaultClient

public static interface VaultClient.ResponseSpec

Contract for specifying response operations following the exchange.

Method Summary

Modifier and Type	Method	Description
@Nullable VaultResponse	body()	Extract the body as an object of the given type.
<T> @Nullable T	body(Class<T> bodyType)	Extract the body as an object of the given type.
<T> @Nullable T	body(ParameterizedTypeReference<T> bodyType)	Extract the body as an object of the given type.
VaultClient.ResponseSpec	onStatus(Predicate<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)	Provide a function to map specific error status codes to an error handler.
VaultResponse	requiredBody()	Extract the required body as an object of the given type.
<T> T	requiredBody(Class<T> bodyType)	Extract the required body as an object of the given type.
<T> T	requiredBody(ParameterizedTypeReference<T> bodyType)	Extract the required body as an object of the given type.
ResponseEntity<Void>	toBodilessEntity()	Return a ResponseEntity without a body.
default ResponseEntity<VaultResponse>	toEntity()	Return a ResponseEntity with the body decoded to VaultResponse.
<T> ResponseEntity<T>	toEntity(Class<T> bodyType)	Return a ResponseEntity with the body decoded to an Object of the given type.
<T> ResponseEntity<T>	toEntity(ParameterizedTypeReference<T> bodyType)	Return a ResponseEntity with the body decoded to an Object of the given type.
WrappedMetadata	wrap(Duration ttl)	Wrap the response in a cubbyhole token with the requested TTL.

Method Details

onStatus

VaultClient.ResponseSpec onStatus(Predicate<HttpStatusCode> statusPredicate,
 RestClient.ResponseSpec.ErrorHandler errorHandler)

Provide a function to map specific error status codes to an error handler.

By default, if there are no matching status handlers, responses with status codes >= 400 will throw a VaultClientResponseException.

Note that IOExceptions, UncheckedIOExceptions, and HttpMessageNotReadableExceptions thrown from errorHandler will be wrapped in a VaultClientResponseException.

Parameters:

statusPredicate - to match responses with

errorHandler - handler that typically, though not necessarily, throws an exception

Returns:

this builder

wrap

WrappedMetadata wrap(Duration ttl)

Wrap the response in a cubbyhole token with the requested TTL.

Parameters:

ttl - the time to live for the wrapped response.

Returns:

the cubbyhole WrappedMetadata providing a token and metadata for the wrapped response.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

IllegalStateException - if no response body was available.

requiredBody

VaultResponse requiredBody()

Extract the required body as an object of the given type.

Returns:

the body or IllegalStateException if no response body was available.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

NoSuchElementException - if no response body was available.

body

@Nullable VaultResponse body()

Extract the body as an object of the given type.

Returns:

the body, or null if no response body was available.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

requiredBody

<T> T requiredBody(Class<T> bodyType)

Extract the required body as an object of the given type.

Returns:

the body or IllegalStateException if no response body was available.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

NoSuchElementException - if no response body was available.

requiredBody

<T> T requiredBody(ParameterizedTypeReference<T> bodyType)

Extract the required body as an object of the given type.

Returns:

the body or IllegalStateException if no response body was available.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

NoSuchElementException - if no response body was available.

body

<T> @Nullable T body(Class<T> bodyType)

Extract the body as an object of the given type.

Type Parameters:

T - the body type.

Parameters:

bodyType - the type of return value.

Returns:

the body, or null if no response body was available

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

body

<T> @Nullable T body(ParameterizedTypeReference<T> bodyType)

Extract the body as an object of the given type.

Type Parameters:

T - the body type.

Parameters:

bodyType - the type of return value.

Returns:

the body, or null if no response body was available.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

toEntity

default ResponseEntity<VaultResponse> toEntity()

Return a ResponseEntity with the body decoded to VaultResponse.

Returns:

the ResponseEntity with the decoded body.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

toEntity

<T> ResponseEntity<T> toEntity(Class<T> bodyType)

Return a ResponseEntity with the body decoded to an Object of the given type.

Type Parameters:

T - response body type.

Parameters:

bodyType - the expected response body type.

Returns:

the ResponseEntity with the decoded body

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

toEntity

<T> ResponseEntity<T> toEntity(ParameterizedTypeReference<T> bodyType)

Return a ResponseEntity with the body decoded to an Object of the given type.

Type Parameters:

T - response body type.

Parameters:

bodyType - the expected response body type.

Returns:

the ResponseEntity with the decoded body.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.

toBodilessEntity

ResponseEntity<Void> toBodilessEntity()

Return a ResponseEntity without a body.

Returns:

the ResponseEntity.

Throws:

VaultClientResponseException - when receiving a response with a status code of 4xx or 5xx.