Interface RestClient.ResponseSpec

Enclosing interface:

RestClient

public static interface RestClient.ResponseSpec

Contract for specifying response operations following the exchange.

Since:

6.1

Author:

Arjen Poutsma, Sebastien Deleuze

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RestClient.ResponseSpec.ErrorHandler	Used in onStatus(Predicate, ErrorHandler).

Method Summary

Modifier and Type	Method	Description
<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.
RestClient.ResponseSpec	onStatus(Predicate<HttpStatusCode> statusPredicate, RestClient.ResponseSpec.ErrorHandler errorHandler)	Provide a function to map specific error status codes to an error handler.
RestClient.ResponseSpec	onStatus(ResponseErrorHandler errorHandler)	Provide a function to map specific error status codes to an error handler.
ResponseEntity<Void>	toBodilessEntity()	Return a ResponseEntity without a body.
<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.

Method Details

onStatus

RestClient.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 wil throw a RestClientResponseException.

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

Parameters:

statusPredicate - to match responses with

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

Returns:

this builder

onStatus

RestClient.ResponseSpec onStatus(ResponseErrorHandler 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 wil throw a RestClientResponseException.

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

Parameters:

errorHandler - the error handler

Returns:

this builder

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:

RestClientResponseException - by default when receiving a response with a status code of 4xx or 5xx. Use onStatus(Predicate, ErrorHandler) to customize error response handling.

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:

RestClientResponseException - by default when receiving a response with a status code of 4xx or 5xx. Use onStatus(Predicate, ErrorHandler) to customize error response handling.

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:

RestClientResponseException - by default when receiving a response with a status code of 4xx or 5xx. Use onStatus(Predicate, ErrorHandler) to customize error response handling.

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:

RestClientResponseException - by default when receiving a response with a status code of 4xx or 5xx. Use onStatus(Predicate, ErrorHandler) to customize error response handling.

toBodilessEntity

ResponseEntity<Void> toBodilessEntity()

Return a ResponseEntity without a body.

Returns:

the ResponseEntity

Throws:

RestClientResponseException - by default when receiving a response with a status code of 4xx or 5xx. Use onStatus(Predicate, ErrorHandler) to customize error response handling.