Package org.springframework.vault.client

Interface ReactiveVaultClient.ResponseSpec

Enclosing interface:

ReactiveVaultClient

public static interface ReactiveVaultClient.ResponseSpec

Contract for specifying response operations following the exchange.

Method Summary

Modifier and Type	Method	Description
Mono<VaultResponse>	body()	Decode the body to VaultResponse.
<T> Flux<T>	bodyToFlux(Class<T> elementClass)	Decode the body to a Flux with elements of the given type.
<T> Flux<T>	bodyToFlux(ParameterizedTypeReference<T> elementTypeRef)	Variant of bodyToFlux(Class) with a ParameterizedTypeReference.
<T> Mono<T>	bodyToMono(Class<T> elementClass)	Decode the body to the given target type.
<T> Mono<T>	bodyToMono(ParameterizedTypeReference<T> elementTypeRef)	Variant of bodyToMono(Class) with a ParameterizedTypeReference.
ReactiveVaultClient.ResponseSpec	onStatus(Predicate<HttpStatusCode> statusPredicate, Function<ClientResponse,Mono<? extends Throwable>> exceptionFunction)	Provide a function to map specific error status codes to an error signal to be propagated downstream instead of the response.
Mono<ResponseEntity<Void>>	toBodilessEntity()	Return a ResponseEntity without a body.
<T> Mono<ResponseEntity<T>>	toEntity(Class<T> bodyClass)	Return a ResponseEntity with the body decoded to an Object of the given type.
<T> Mono<ResponseEntity<T>>	toEntity(ParameterizedTypeReference<T> bodyTypeRef)	Variant of toEntity(Class) with a ParameterizedTypeReference.
<T> Mono<ResponseEntity<Flux<T>>>	toEntityFlux(Class<T> elementType)	Return a ResponseEntity with the body decoded to a Flux of elements of the given type.
<T> Mono<ResponseEntity<Flux<T>>>	toEntityFlux(ParameterizedTypeReference<T> elementTypeRef)	Variant of toEntityFlux(Class) with a ParameterizedTypeReference.
<T> Mono<ResponseEntity<List<T>>>	toEntityList(Class<T> elementClass)	Return a ResponseEntity with the body decoded to a List of elements of the given type.
<T> Mono<ResponseEntity<List<T>>>	toEntityList(ParameterizedTypeReference<T> elementTypeRef)	Variant of toEntityList(Class) with a ParameterizedTypeReference.
Mono<WrappedMetadata>	wrap(Duration ttl)	Wrap the response in a cubbyhole token with the requested TTL.

Method Details

onStatus

ReactiveVaultClient.ResponseSpec onStatus(Predicate<HttpStatusCode> statusPredicate,
 Function<ClientResponse,Mono<? extends Throwable>> exceptionFunction)

Provide a function to map specific error status codes to an error signal to be propagated downstream instead of the response.

By default, if there are no matching status handlers, responses with status codes >= 400 are mapped to VaultClientResponseException which is created with ClientResponse.createException().

To suppress the treatment of a status code as an error and process it as a normal response, return Mono.empty() from the function. The response will then propagate downstream to be processed.

To ignore an error response completely, and propagate neither response nor error, use a filter, or add onErrorResume downstream, for example:

 webClient.get()
   .path("https://abc.com/account/123")
   .retrieve()
   .bodyToMono(Account.class)
   .onErrorResume(VaultClientResponseException.class,
     ex -> ex.getStatusCode().value() == 404 ? Mono.empty() : Mono.error(ex));
 

Parameters:

statusPredicate - to match responses with

exceptionFunction - to map the response to an error signal

Returns:

this builder

See Also:

• ClientResponse.createException()

wrap

Mono<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.

body

Mono<VaultResponse> body()

Decode the body to VaultResponse. For an error response (status code of 4xx or 5xx), the Mono emits a VaultException. Use onStatus(Predicate, Function) to customize error response handling.

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.

bodyToMono

<T> Mono<T> bodyToMono(Class<T> elementClass)

Decode the body to the given target type. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Type Parameters:

T - the target body type.

Parameters:

elementClass - the type to decode to.

Returns:

the decoded body.

bodyToMono

<T> Mono<T> bodyToMono(ParameterizedTypeReference<T> elementTypeRef)

Variant of bodyToMono(Class) with a ParameterizedTypeReference.

Type Parameters:

T - the target body type

Parameters:

elementTypeRef - the type to decode to

Returns:

the decoded body

bodyToFlux

<T> Flux<T> bodyToFlux(Class<T> elementClass)

Decode the body to a Flux with elements of the given type. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Type Parameters:

T - the body element type.

Parameters:

elementClass - the type of element to decode to.

Returns:

the decoded body.

bodyToFlux

<T> Flux<T> bodyToFlux(ParameterizedTypeReference<T> elementTypeRef)

Variant of bodyToFlux(Class) with a ParameterizedTypeReference.

Type Parameters:

T - the body element type.

Parameters:

elementTypeRef - the type of element to decode to.

Returns:

the decoded body.

toEntity

<T> Mono<ResponseEntity<T>> toEntity(Class<T> bodyClass)

Return a ResponseEntity with the body decoded to an Object of the given type. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Type Parameters:

T - response body type.

Parameters:

bodyClass - the expected response body type.

Returns:

the ResponseEntity with the decoded body.

toEntity

<T> Mono<ResponseEntity<T>> toEntity(ParameterizedTypeReference<T> bodyTypeRef)

Variant of toEntity(Class) with a ParameterizedTypeReference.

Type Parameters:

T - the response body type.

Parameters:

bodyTypeRef - the expected response body type.

Returns:

the ResponseEntity with the decoded body.

toEntityList

<T> Mono<ResponseEntity<List<T>>> toEntityList(Class<T> elementClass)

Return a ResponseEntity with the body decoded to a List of elements of the given type. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Type Parameters:

T - the body element type.

Parameters:

elementClass - the type of element to decode the target Flux to.

Returns:

the ResponseEntity.

toEntityList

<T> Mono<ResponseEntity<List<T>>> toEntityList(ParameterizedTypeReference<T> elementTypeRef)

Variant of toEntityList(Class) with a ParameterizedTypeReference.

Type Parameters:

T - the body element type.

Parameters:

elementTypeRef - the type of element to decode the target Flux to

Returns:

the ResponseEntity.

toEntityFlux

<T> Mono<ResponseEntity<Flux<T>>> toEntityFlux(Class<T> elementType)

Return a ResponseEntity with the body decoded to a Flux of elements of the given type. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Note: The Flux representing the body must be subscribed to or else associated resources will not be released.

Type Parameters:

T - the body element type.

Parameters:

elementType - the type of element to decode the target Flux to.

Returns:

the ResponseEntity

toEntityFlux

<T> Mono<ResponseEntity<Flux<T>>> toEntityFlux(ParameterizedTypeReference<T> elementTypeRef)

Variant of toEntityFlux(Class) with a ParameterizedTypeReference.

Type Parameters:

T - the body element type.

Parameters:

elementTypeRef - the type of element to decode the target Flux to.

Returns:

the ResponseEntity

toBodilessEntity

Mono<ResponseEntity<Void>> toBodilessEntity()

Return a ResponseEntity without a body. For an error response (status code of 4xx or 5xx), the Mono emits a VaultClientResponseException. Use onStatus(Predicate, Function) to customize error response handling.

Returns:

the ResponseEntity.