Polishing

This commit is contained in:
Sam Brannen
2024-02-16 13:37:39 +01:00
parent 6791ea94a0
commit 7c07c43201
16 changed files with 120 additions and 124 deletions

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -43,11 +43,9 @@ public interface ClientHttpRequestInterceptor {
* wrap} the request to filter HTTP attributes.</li>
* <li>Optionally modify the body of the request.</li>
* <ul>
* <li><strong>Either</strong>
* <li>execute the request using
* {@link ClientHttpRequestExecution#execute(org.springframework.http.HttpRequest, byte[])},</li>
* <li><strong>or</strong></li>
* <li>do not execute the request to block the execution altogether.</li>
* <li><strong>either</strong> execute the request using
* {@link ClientHttpRequestExecution#execute(HttpRequest, byte[])}</li>
* <li><strong>or</strong> do not execute the request to block the execution altogether</li>
* </ul>
* <li>Optionally wrap the response to filter HTTP attributes.</li>
* </ol>

View File

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2023 the original author or authors.
* Copyright 2002-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -155,16 +155,17 @@ public interface RestClient {
}
/**
* Create a new {@code RestClient} based on the configuration of the
* given {@code RestTemplate}. The returned builder is configured with the
* template's
* Create a new {@code RestClient} based on the configuration of the given
* {@code RestTemplate}.
* <p>The returned builder is configured with the following attributes of
* the template.
* <ul>
* <li>{@link RestTemplate#getRequestFactory() ClientHttpRequestFactory},</li>
* <li>{@link RestTemplate#getMessageConverters() HttpMessageConverters},</li>
* <li>{@link RestTemplate#getInterceptors() ClientHttpRequestInterceptors},</li>
* <li>{@link RestTemplate#getClientHttpRequestInitializers() ClientHttpRequestInitializers},</li>
* <li>{@link RestTemplate#getUriTemplateHandler() UriBuilderFactory}, and</li>
* <li>{@linkplain RestTemplate#getErrorHandler() error handler}.</li>
* <li>{@link RestTemplate#getRequestFactory() ClientHttpRequestFactory}</li>
* <li>{@link RestTemplate#getMessageConverters() HttpMessageConverters}</li>
* <li>{@link RestTemplate#getInterceptors() ClientHttpRequestInterceptors}</li>
* <li>{@link RestTemplate#getClientHttpRequestInitializers() ClientHttpRequestInitializers}</li>
* <li>{@link RestTemplate#getUriTemplateHandler() UriBuilderFactory}</li>
* <li>{@linkplain RestTemplate#getErrorHandler() error handler}</li>
* </ul>
* @param restTemplate the rest template to base the returned client's
* configuration on
@@ -184,15 +185,16 @@ public interface RestClient {
/**
* Obtain a {@code RestClient} builder based on the configuration of the
* given {@code RestTemplate}. The returned builder is configured with the
* template's
* given {@code RestTemplate}.
* <p>The returned builder is configured with the following attributes of
* the template.
* <ul>
* <li>{@link RestTemplate#getRequestFactory() ClientHttpRequestFactory},</li>
* <li>{@link RestTemplate#getMessageConverters() HttpMessageConverters},</li>
* <li>{@link RestTemplate#getInterceptors() ClientHttpRequestInterceptors},</li>
* <li>{@link RestTemplate#getClientHttpRequestInitializers() ClientHttpRequestInitializers},</li>
* <li>{@link RestTemplate#getUriTemplateHandler() UriBuilderFactory}, and</li>
* <li>{@linkplain RestTemplate#getErrorHandler() error handler}.</li>
* <li>{@link RestTemplate#getRequestFactory() ClientHttpRequestFactory}</li>
* <li>{@link RestTemplate#getMessageConverters() HttpMessageConverters}</li>
* <li>{@link RestTemplate#getInterceptors() ClientHttpRequestInterceptors}</li>
* <li>{@link RestTemplate#getClientHttpRequestInitializers() ClientHttpRequestInitializers}</li>
* <li>{@link RestTemplate#getUriTemplateHandler() UriBuilderFactory}</li>
* <li>{@linkplain RestTemplate#getErrorHandler() error handler}</li>
* </ul>
* @param restTemplate the rest template to base the returned builder's
* configuration on