Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document exception handling for HTTP Interface client with RestClient and RestTemplate #31991

Closed
wants to merge 1 commit into from
Closed

Document exception handling for HTTP Interface client with RestClient and RestTemplate #31991

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 40 additions & 5 deletions framework-docs/modules/ROOT/pages/integration/rest-clients.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1079,10 +1079,30 @@ underlying HTTP client, which operates at a lower level and provides more contro

[[rest-http-interface-exceptions]]
=== Exception Handling
In order to provide a custom way of handling errors, you can register response
status handlers on the underlying HTTP clients.

By default, `WebClient` raises `WebClientResponseException` for 4xx and 5xx HTTP status
codes. To customize this, you can register a response status handler that applies to all
responses performed through the client:
For `RestClient`:

By default, `RestClient` raises `RestClientException` for 4xx and 5xx HTTP status codes. To customize this, you can register a response status handler that applies to all responses performed through the client:

[source,java,indent=0,subs="verbatim,quotes"]
----
RestClient restClient = RestClient.builder()
.defaultStatusHandler(HttpStatusCode::isError,
(request, response) -> ...)
.build();

RestClientAdapter clientAdapter = RestClientAdapter.create(restClient);
HttpServiceProxyFactory factory = HttpServiceProxyFactory
.builderFor(clientAdapter).build();
----

For more details and options, such as suppressing error status codes, see the Javadoc of `defaultStatusHandler` in `RestClient.Builder`.

For `WebClient`:

By default, `WebClient` raises `WebClientResponseException` for 4xx and 5xx HTTP status codes. To customize this, you can register a response status handler that applies to all responses performed through the client:

[source,java,indent=0,subs="verbatim,quotes"]
----
Expand All @@ -1095,5 +1115,20 @@ responses performed through the client:
.builder(clientAdapter).build();
----

For more details and options, such as suppressing error status codes, see the Javadoc of
`defaultStatusHandler` in `WebClient.Builder`.
For more details and options, such as suppressing error status codes, see the Javadoc of `defaultStatusHandler` in `WebClient.Builder`.

For `RestTemplate`:

By default, `RestTemplate` raises `RestClientException` for 4xx and 5xx HTTP status codes. To customize this, you can register an error handler that applies to all responses performed through the client:

[source,java,indent=0,subs="verbatim,quotes"]
----
RestTemplate restTemplate = new RestTemplate();
restTemplate.setErrorHandler(aCustomErrorHandler);

RestTemplateAdapter clientAdapter = RestTemplateAdapter.create(restTemplate);
HttpServiceProxyFactory factory = HttpServiceProxyFactory
.builderFor(clientAdapter).build();
----

For more details and options, see the Javadoc of `setErrorHandler` in `RestTemplate`.