Commit 76e075dd authored by Phillip Webb's avatar Phillip Webb

Polish "Use request factory to support Basic Authentication"

Reduce the surface area of the public API by making the
`BasicAuthentication` and `BasicAuthenticationClientHttpRequestFactory`
class package private.

This commit also attempts to simplify `TestRestTemplate` by keeping
the `RestTemplateBuilder` and reusing it, rather than needing to deal
only with a `RestTemplate` instance.

See gh-17010
parent 18a0a7a2
...@@ -17,13 +17,11 @@ ...@@ -17,13 +17,11 @@
package org.springframework.boot.test.web.client; package org.springframework.boot.test.web.client;
import java.io.IOException; import java.io.IOException;
import java.lang.reflect.Field;
import java.net.URI; import java.net.URI;
import java.util.Arrays; import java.util.Arrays;
import java.util.HashSet; import java.util.HashSet;
import java.util.Map; import java.util.Map;
import java.util.Set; import java.util.Set;
import java.util.function.Supplier;
import org.apache.http.client.HttpClient; import org.apache.http.client.HttpClient;
import org.apache.http.client.config.CookieSpecs; import org.apache.http.client.config.CookieSpecs;
...@@ -36,11 +34,6 @@ import org.apache.http.impl.client.HttpClients; ...@@ -36,11 +34,6 @@ import org.apache.http.impl.client.HttpClients;
import org.apache.http.protocol.HttpContext; import org.apache.http.protocol.HttpContext;
import org.apache.http.ssl.SSLContextBuilder; import org.apache.http.ssl.SSLContextBuilder;
import org.springframework.beans.BeanInstantiationException;
import org.springframework.beans.BeanUtils;
import org.springframework.boot.web.client.BasicAuthentication;
import org.springframework.boot.web.client.BasicAuthenticationClientHttpRequestFactory;
import org.springframework.boot.web.client.ClientHttpRequestFactorySupplier;
import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.boot.web.client.RootUriTemplateHandler; import org.springframework.boot.web.client.RootUriTemplateHandler;
import org.springframework.core.ParameterizedTypeReference; import org.springframework.core.ParameterizedTypeReference;
...@@ -49,13 +42,10 @@ import org.springframework.http.HttpHeaders; ...@@ -49,13 +42,10 @@ import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod; import org.springframework.http.HttpMethod;
import org.springframework.http.RequestEntity; import org.springframework.http.RequestEntity;
import org.springframework.http.ResponseEntity; import org.springframework.http.ResponseEntity;
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
import org.springframework.http.client.ClientHttpRequestFactory; import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpResponse; import org.springframework.http.client.ClientHttpResponse;
import org.springframework.http.client.HttpComponentsClientHttpRequestFactory; import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
import org.springframework.http.client.InterceptingClientHttpRequestFactory;
import org.springframework.util.Assert; import org.springframework.util.Assert;
import org.springframework.util.ReflectionUtils;
import org.springframework.web.client.DefaultResponseErrorHandler; import org.springframework.web.client.DefaultResponseErrorHandler;
import org.springframework.web.client.RequestCallback; import org.springframework.web.client.RequestCallback;
import org.springframework.web.client.ResponseExtractor; import org.springframework.web.client.ResponseExtractor;
...@@ -89,10 +79,12 @@ import org.springframework.web.util.UriTemplateHandler; ...@@ -89,10 +79,12 @@ import org.springframework.web.util.UriTemplateHandler;
*/ */
public class TestRestTemplate { public class TestRestTemplate {
private final RestTemplate restTemplate; private final RestTemplateBuilder builder;
private final HttpClientOption[] httpClientOptions; private final HttpClientOption[] httpClientOptions;
private final RestTemplate restTemplate;
/** /**
* Create a new {@link TestRestTemplate} instance. * Create a new {@link TestRestTemplate} instance.
* @param restTemplateBuilder builder used to configure underlying * @param restTemplateBuilder builder used to configure underlying
...@@ -124,64 +116,30 @@ public class TestRestTemplate { ...@@ -124,64 +116,30 @@ public class TestRestTemplate {
/** /**
* Create a new {@link TestRestTemplate} instance with the specified credentials. * Create a new {@link TestRestTemplate} instance with the specified credentials.
* @param restTemplateBuilder builder used to configure underlying * @param builder builder used to configure underlying {@link RestTemplate}
* {@link RestTemplate}
* @param username the username to use (or {@code null}) * @param username the username to use (or {@code null})
* @param password the password (or {@code null}) * @param password the password (or {@code null})
* @param httpClientOptions client options to use if the Apache HTTP Client is used * @param httpClientOptions client options to use if the Apache HTTP Client is used
* @since 2.0.0 * @since 2.0.0
*/ */
public TestRestTemplate(RestTemplateBuilder restTemplateBuilder, String username, public TestRestTemplate(RestTemplateBuilder builder, String username, String password,
String password, HttpClientOption... httpClientOptions) {
this((restTemplateBuilder != null) ? restTemplateBuilder.build() : null, username,
password, httpClientOptions);
}
private TestRestTemplate(RestTemplate restTemplate, String username, String password,
HttpClientOption... httpClientOptions) { HttpClientOption... httpClientOptions) {
Assert.notNull(restTemplate, "RestTemplate must not be null"); Assert.notNull(builder, "Builder must not be null");
this.builder = builder;
this.httpClientOptions = httpClientOptions; this.httpClientOptions = httpClientOptions;
if (getRequestFactoryClass(restTemplate) if (httpClientOptions != null) {
.isAssignableFrom(HttpComponentsClientHttpRequestFactory.class)) { ClientHttpRequestFactory requestFactory = builder.buildRequestFactory();
restTemplate.setRequestFactory( if (requestFactory instanceof HttpComponentsClientHttpRequestFactory) {
new CustomHttpComponentsClientHttpRequestFactory(httpClientOptions)); builder = builder.requestFactory(
} () -> new CustomHttpComponentsClientHttpRequestFactory(
addAuthentication(restTemplate, username, password); httpClientOptions));
restTemplate.setErrorHandler(new NoOpResponseErrorHandler()); }
this.restTemplate = restTemplate;
}
private Class<? extends ClientHttpRequestFactory> getRequestFactoryClass(
RestTemplate restTemplate) {
return getRequestFactory(restTemplate).getClass();
}
private ClientHttpRequestFactory getRequestFactory(RestTemplate restTemplate) {
ClientHttpRequestFactory requestFactory = restTemplate.getRequestFactory();
while (requestFactory instanceof InterceptingClientHttpRequestFactory
|| requestFactory instanceof BasicAuthenticationClientHttpRequestFactory) {
requestFactory = unwrapRequestFactory(
((AbstractClientHttpRequestFactoryWrapper) requestFactory));
} }
return requestFactory; if (username != null || password != null) {
} builder = builder.basicAuthentication(username, password);
private ClientHttpRequestFactory unwrapRequestFactory(
AbstractClientHttpRequestFactoryWrapper requestFactory) {
Field field = ReflectionUtils.findField(
AbstractClientHttpRequestFactoryWrapper.class, "requestFactory");
ReflectionUtils.makeAccessible(field);
return (ClientHttpRequestFactory) ReflectionUtils.getField(field, requestFactory);
}
private void addAuthentication(RestTemplate restTemplate, String username,
String password) {
if (username == null || password == null) {
return;
} }
ClientHttpRequestFactory requestFactory = getRequestFactory(restTemplate); this.restTemplate = builder.build();
restTemplate.setRequestFactory(new BasicAuthenticationClientHttpRequestFactory( this.restTemplate.setErrorHandler(new NoOpResponseErrorHandler());
new BasicAuthentication(username, password), requestFactory));
} }
/** /**
...@@ -1038,25 +996,10 @@ public class TestRestTemplate { ...@@ -1038,25 +996,10 @@ public class TestRestTemplate {
* @since 1.4.1 * @since 1.4.1
*/ */
public TestRestTemplate withBasicAuth(String username, String password) { public TestRestTemplate withBasicAuth(String username, String password) {
RestTemplate restTemplate = new RestTemplateBuilder() TestRestTemplate template = new TestRestTemplate(this.builder, username, password,
.requestFactory(getRequestFactorySupplier())
.messageConverters(getRestTemplate().getMessageConverters())
.interceptors(getRestTemplate().getInterceptors())
.uriTemplateHandler(getRestTemplate().getUriTemplateHandler()).build();
return new TestRestTemplate(restTemplate, username, password,
this.httpClientOptions); this.httpClientOptions);
} template.setUriTemplateHandler(getRestTemplate().getUriTemplateHandler());
return template;
private Supplier<ClientHttpRequestFactory> getRequestFactorySupplier() {
return () -> {
try {
return BeanUtils
.instantiateClass(getRequestFactoryClass(getRestTemplate()));
}
catch (BeanInstantiationException ex) {
return new ClientHttpRequestFactorySupplier().get();
}
};
} }
@SuppressWarnings({ "rawtypes", "unchecked" }) @SuppressWarnings({ "rawtypes", "unchecked" })
...@@ -1078,7 +1021,7 @@ public class TestRestTemplate { ...@@ -1078,7 +1021,7 @@ public class TestRestTemplate {
} }
/** /**
* Options used to customize the Apache Http Client if it is used. * Options used to customize the Apache HTTP Client.
*/ */
public enum HttpClientOption { public enum HttpClientOption {
......
...@@ -20,13 +20,14 @@ import java.io.IOException; ...@@ -20,13 +20,14 @@ import java.io.IOException;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.lang.reflect.Modifier; import java.lang.reflect.Modifier;
import java.net.URI; import java.net.URI;
import java.util.List;
import java.util.stream.Collectors;
import org.apache.http.client.config.RequestConfig; import org.apache.http.client.config.RequestConfig;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.boot.test.web.client.TestRestTemplate.CustomHttpComponentsClientHttpRequestFactory; import org.springframework.boot.test.web.client.TestRestTemplate.CustomHttpComponentsClientHttpRequestFactory;
import org.springframework.boot.test.web.client.TestRestTemplate.HttpClientOption; import org.springframework.boot.test.web.client.TestRestTemplate.HttpClientOption;
import org.springframework.boot.web.client.BasicAuthenticationClientHttpRequestFactory;
import org.springframework.boot.web.client.RestTemplateBuilder; import org.springframework.boot.web.client.RestTemplateBuilder;
import org.springframework.core.ParameterizedTypeReference; import org.springframework.core.ParameterizedTypeReference;
import org.springframework.http.HttpEntity; import org.springframework.http.HttpEntity;
...@@ -99,25 +100,11 @@ public class TestRestTemplateTests { ...@@ -99,25 +100,11 @@ public class TestRestTemplateTests {
TestRestTemplate testRestTemplate = new TestRestTemplate(builder) TestRestTemplate testRestTemplate = new TestRestTemplate(builder)
.withBasicAuth("test", "test"); .withBasicAuth("test", "test");
RestTemplate restTemplate = testRestTemplate.getRestTemplate(); RestTemplate restTemplate = testRestTemplate.getRestTemplate();
assertThat(restTemplate.getRequestFactory().getClass().getName())
.contains("BasicAuth");
Object requestFactory = ReflectionTestUtils Object requestFactory = ReflectionTestUtils
.getField(restTemplate.getRequestFactory(), "requestFactory"); .getField(restTemplate.getRequestFactory(), "requestFactory");
assertThat(requestFactory).isNotEqualTo(customFactory) assertThat(requestFactory).isEqualTo(customFactory).hasSameClassAs(customFactory);
.hasSameClassAs(customFactory);
}
@Test
public void withBasicAuthWhenRequestFactoryTypeCannotBeInstantiatedShouldFallback() {
TestClientHttpRequestFactory customFactory = new TestClientHttpRequestFactory(
"my-request-factory");
RestTemplateBuilder builder = new RestTemplateBuilder()
.requestFactory(() -> customFactory);
TestRestTemplate testRestTemplate = new TestRestTemplate(builder)
.withBasicAuth("test", "test");
RestTemplate restTemplate = testRestTemplate.getRestTemplate();
Object requestFactory = ReflectionTestUtils
.getField(restTemplate.getRequestFactory(), "requestFactory");
assertThat(requestFactory).isNotEqualTo(customFactory)
.isInstanceOf(CustomHttpComponentsClientHttpRequestFactory.class);
} }
@Test @Test
...@@ -145,9 +132,10 @@ public class TestRestTemplateTests { ...@@ -145,9 +132,10 @@ public class TestRestTemplateTests {
@Test @Test
public void authenticated() { public void authenticated() {
assertThat(new TestRestTemplate("user", "password").getRestTemplate() RestTemplate restTemplate = new TestRestTemplate("user", "password")
.getRequestFactory()) .getRestTemplate();
.isInstanceOf(BasicAuthenticationClientHttpRequestFactory.class); ClientHttpRequestFactory factory = restTemplate.getRequestFactory();
assertThat(factory.getClass().getName()).contains("BasicAuthentication");
} }
@Test @Test
...@@ -225,22 +213,17 @@ public class TestRestTemplateTests { ...@@ -225,22 +213,17 @@ public class TestRestTemplateTests {
@Test @Test
public void withBasicAuthAddsBasicAuthClientFactoryWhenNotAlreadyPresent() { public void withBasicAuthAddsBasicAuthClientFactoryWhenNotAlreadyPresent() {
TestRestTemplate originalTemplate = new TestRestTemplate(); TestRestTemplate original = new TestRestTemplate();
TestRestTemplate basicAuthTemplate = originalTemplate.withBasicAuth("user", TestRestTemplate basicAuth = original.withBasicAuth("user", "password");
"password"); assertThat(getConverterClasses(original))
assertThat(basicAuthTemplate.getRestTemplate().getMessageConverters()) .containsExactlyElementsOf(getConverterClasses(basicAuth));
.containsExactlyElementsOf( assertThat(basicAuth.getRestTemplate().getRequestFactory().getClass().getName())
originalTemplate.getRestTemplate().getMessageConverters()); .contains("BasicAuth");
assertThat(basicAuthTemplate.getRestTemplate().getRequestFactory())
.isInstanceOf(BasicAuthenticationClientHttpRequestFactory.class);
assertThat(ReflectionTestUtils.getField( assertThat(ReflectionTestUtils.getField(
basicAuthTemplate.getRestTemplate().getRequestFactory(), basicAuth.getRestTemplate().getRequestFactory(), "requestFactory"))
"requestFactory"))
.isInstanceOf(CustomHttpComponentsClientHttpRequestFactory.class); .isInstanceOf(CustomHttpComponentsClientHttpRequestFactory.class);
assertThat(basicAuthTemplate.getRestTemplate().getUriTemplateHandler()) assertThat(basicAuth.getRestTemplate().getInterceptors()).isEmpty();
.isSameAs(originalTemplate.getRestTemplate().getUriTemplateHandler()); assertBasicAuthorizationCredentials(basicAuth, "user", "password");
assertThat(basicAuthTemplate.getRestTemplate().getInterceptors()).isEmpty();
assertBasicAuthorizationCredentials(basicAuthTemplate, "user", "password");
} }
@Test @Test
...@@ -248,20 +231,22 @@ public class TestRestTemplateTests { ...@@ -248,20 +231,22 @@ public class TestRestTemplateTests {
TestRestTemplate original = new TestRestTemplate("foo", "bar") TestRestTemplate original = new TestRestTemplate("foo", "bar")
.withBasicAuth("replace", "replace"); .withBasicAuth("replace", "replace");
TestRestTemplate basicAuth = original.withBasicAuth("user", "password"); TestRestTemplate basicAuth = original.withBasicAuth("user", "password");
assertThat(basicAuth.getRestTemplate().getMessageConverters()) assertThat(getConverterClasses(basicAuth))
.containsExactlyElementsOf( .containsExactlyElementsOf(getConverterClasses(original));
original.getRestTemplate().getMessageConverters()); assertThat(basicAuth.getRestTemplate().getRequestFactory().getClass().getName())
assertThat(basicAuth.getRestTemplate().getRequestFactory()) .contains("BasicAuth");
.isInstanceOf(BasicAuthenticationClientHttpRequestFactory.class);
assertThat(ReflectionTestUtils.getField( assertThat(ReflectionTestUtils.getField(
basicAuth.getRestTemplate().getRequestFactory(), "requestFactory")) basicAuth.getRestTemplate().getRequestFactory(), "requestFactory"))
.isInstanceOf(CustomHttpComponentsClientHttpRequestFactory.class); .isInstanceOf(CustomHttpComponentsClientHttpRequestFactory.class);
assertThat(basicAuth.getRestTemplate().getUriTemplateHandler())
.isSameAs(original.getRestTemplate().getUriTemplateHandler());
assertThat(basicAuth.getRestTemplate().getInterceptors()).isEmpty(); assertThat(basicAuth.getRestTemplate().getInterceptors()).isEmpty();
assertBasicAuthorizationCredentials(basicAuth, "user", "password"); assertBasicAuthorizationCredentials(basicAuth, "user", "password");
} }
private List<Class<?>> getConverterClasses(TestRestTemplate testRestTemplate) {
return testRestTemplate.getRestTemplate().getMessageConverters().stream()
.map(Object::getClass).collect(Collectors.toList());
}
@Test @Test
public void withBasicAuthShouldUseNoOpErrorHandler() throws Exception { public void withBasicAuthShouldUseNoOpErrorHandler() throws Exception {
TestRestTemplate originalTemplate = new TestRestTemplate("foo", "bar"); TestRestTemplate originalTemplate = new TestRestTemplate("foo", "bar");
......
...@@ -18,6 +18,8 @@ package org.springframework.boot.web.client; ...@@ -18,6 +18,8 @@ package org.springframework.boot.web.client;
import java.nio.charset.Charset; import java.nio.charset.Charset;
import org.springframework.http.HttpHeaders;
import org.springframework.http.client.ClientHttpRequest;
import org.springframework.util.Assert; import org.springframework.util.Assert;
/** /**
...@@ -25,10 +27,9 @@ import org.springframework.util.Assert; ...@@ -25,10 +27,9 @@ import org.springframework.util.Assert;
* {@link BasicAuthenticationClientHttpRequestFactory}. * {@link BasicAuthenticationClientHttpRequestFactory}.
* *
* @author Dmytro Nosan * @author Dmytro Nosan
* @since 2.2.0
* @see BasicAuthenticationClientHttpRequestFactory * @see BasicAuthenticationClientHttpRequestFactory
*/ */
public class BasicAuthentication { class BasicAuthentication {
private final String username; private final String username;
...@@ -36,22 +37,7 @@ public class BasicAuthentication { ...@@ -36,22 +37,7 @@ public class BasicAuthentication {
private final Charset charset; private final Charset charset;
/** BasicAuthentication(String username, String password, Charset charset) {
* Create a new {@link BasicAuthentication}.
* @param username the username to use
* @param password the password to use
*/
public BasicAuthentication(String username, String password) {
this(username, password, null);
}
/**
* Create a new {@link BasicAuthentication}.
* @param username the username to use
* @param password the password to use
* @param charset the charset to use
*/
public BasicAuthentication(String username, String password, Charset charset) {
Assert.notNull(username, "Username must not be null"); Assert.notNull(username, "Username must not be null");
Assert.notNull(password, "Password must not be null"); Assert.notNull(password, "Password must not be null");
this.username = username; this.username = username;
...@@ -59,28 +45,11 @@ public class BasicAuthentication { ...@@ -59,28 +45,11 @@ public class BasicAuthentication {
this.charset = charset; this.charset = charset;
} }
/** void applyTo(ClientHttpRequest request) {
* The username to use. HttpHeaders headers = request.getHeaders();
* @return the username, never {@code null} or {@code empty}. if (!headers.containsKey(HttpHeaders.AUTHORIZATION)) {
*/ headers.setBasicAuth(this.username, this.password, this.charset);
public String getUsername() { }
return this.username;
}
/**
* The password to use.
* @return the password, never {@code null} or {@code empty}.
*/
public String getPassword() {
return this.password;
}
/**
* The charset to use.
* @return the charset, or {@code null}.
*/
public Charset getCharset() {
return this.charset;
} }
} }
...@@ -19,7 +19,6 @@ package org.springframework.boot.web.client; ...@@ -19,7 +19,6 @@ package org.springframework.boot.web.client;
import java.io.IOException; import java.io.IOException;
import java.net.URI; import java.net.URI;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod; import org.springframework.http.HttpMethod;
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper; import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
import org.springframework.http.client.ClientHttpRequest; import org.springframework.http.client.ClientHttpRequest;
...@@ -31,20 +30,13 @@ import org.springframework.util.Assert; ...@@ -31,20 +30,13 @@ import org.springframework.util.Assert;
* username/password pair, unless a custom Authorization header has been set before. * username/password pair, unless a custom Authorization header has been set before.
* *
* @author Dmytro Nosan * @author Dmytro Nosan
* @since 2.2.0
*/ */
public class BasicAuthenticationClientHttpRequestFactory class BasicAuthenticationClientHttpRequestFactory
extends AbstractClientHttpRequestFactoryWrapper { extends AbstractClientHttpRequestFactoryWrapper {
private final BasicAuthentication authentication; private final BasicAuthentication authentication;
/** BasicAuthenticationClientHttpRequestFactory(BasicAuthentication authentication,
* Create a new {@link BasicAuthenticationClientHttpRequestFactory} which adds
* {@link HttpHeaders#AUTHORIZATION} header for the given authentication.
* @param authentication the authentication to use
* @param clientHttpRequestFactory the factory to use
*/
public BasicAuthenticationClientHttpRequestFactory(BasicAuthentication authentication,
ClientHttpRequestFactory clientHttpRequestFactory) { ClientHttpRequestFactory clientHttpRequestFactory) {
super(clientHttpRequestFactory); super(clientHttpRequestFactory);
Assert.notNull(authentication, "Authentication must not be null"); Assert.notNull(authentication, "Authentication must not be null");
...@@ -54,13 +46,8 @@ public class BasicAuthenticationClientHttpRequestFactory ...@@ -54,13 +46,8 @@ public class BasicAuthenticationClientHttpRequestFactory
@Override @Override
protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod, protected ClientHttpRequest createRequest(URI uri, HttpMethod httpMethod,
ClientHttpRequestFactory requestFactory) throws IOException { ClientHttpRequestFactory requestFactory) throws IOException {
BasicAuthentication authentication = this.authentication;
ClientHttpRequest request = requestFactory.createRequest(uri, httpMethod); ClientHttpRequest request = requestFactory.createRequest(uri, httpMethod);
HttpHeaders headers = request.getHeaders(); this.authentication.applyTo(request);
if (!headers.containsKey(HttpHeaders.AUTHORIZATION)) {
headers.setBasicAuth(authentication.getUsername(),
authentication.getPassword(), authentication.getCharset());
}
return request; return request;
} }
......
...@@ -19,12 +19,14 @@ package org.springframework.boot.web.client; ...@@ -19,12 +19,14 @@ package org.springframework.boot.web.client;
import java.lang.reflect.Constructor; import java.lang.reflect.Constructor;
import java.lang.reflect.Field; import java.lang.reflect.Field;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.nio.charset.Charset;
import java.time.Duration; import java.time.Duration;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays; import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.LinkedHashSet; import java.util.LinkedHashSet;
import java.util.List;
import java.util.Set; import java.util.Set;
import java.util.function.Consumer; import java.util.function.Consumer;
import java.util.function.Supplier; import java.util.function.Supplier;
...@@ -33,7 +35,6 @@ import org.springframework.beans.BeanUtils; ...@@ -33,7 +35,6 @@ import org.springframework.beans.BeanUtils;
import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper; import org.springframework.http.client.AbstractClientHttpRequestFactoryWrapper;
import org.springframework.http.client.ClientHttpRequestFactory; import org.springframework.http.client.ClientHttpRequestFactory;
import org.springframework.http.client.ClientHttpRequestInterceptor; import org.springframework.http.client.ClientHttpRequestInterceptor;
import org.springframework.http.client.InterceptingClientHttpRequestFactory;
import org.springframework.http.converter.HttpMessageConverter; import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.util.Assert; import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils; import org.springframework.util.CollectionUtils;
...@@ -372,26 +373,32 @@ public class RestTemplateBuilder { ...@@ -372,26 +373,32 @@ public class RestTemplateBuilder {
} }
/** /**
* Add HTTP basic authentication to requests. See * Add HTTP Basic Authentication to requests with the given username/password pair,
* {@link BasicAuthenticationClientHttpRequestFactory} for details. * unless a custom Authorization header has been set before.
* @param username the user name * @param username the user name
* @param password the password * @param password the password
* @return a new builder instance * @return a new builder instance
* @since 2.1.0 * @since 2.1.0
* @see #basicAuthentication(String, String, Charset)
*/ */
public RestTemplateBuilder basicAuthentication(String username, String password) { public RestTemplateBuilder basicAuthentication(String username, String password) {
return basicAuthentication(new BasicAuthentication(username, password)); return basicAuthentication(username, password, null);
} }
/** /**
* Add HTTP basic authentication to requests. See * Add HTTP Basic Authentication to requests with the given username/password pair,
* {@link BasicAuthenticationClientHttpRequestFactory} for details. * unless a custom Authorization header has been set before.
* @param basicAuthentication the authentication * @param username the user name
* @param password the password
* @param charset the charset to use
* @return a new builder instance * @return a new builder instance
* @since 2.2.0 * @since 2.2.0
* @see #basicAuthentication(String, String)
*/ */
public RestTemplateBuilder basicAuthentication( public RestTemplateBuilder basicAuthentication(String username, String password,
BasicAuthentication basicAuthentication) { Charset charset) {
BasicAuthentication basicAuthentication = new BasicAuthentication(username,
password, charset);
return new RestTemplateBuilder(this.detectRequestFactory, this.rootUri, return new RestTemplateBuilder(this.detectRequestFactory, this.rootUri,
this.messageConverters, this.requestFactorySupplier, this.messageConverters, this.requestFactorySupplier,
this.uriTemplateHandler, this.errorHandler, basicAuthentication, this.uriTemplateHandler, this.errorHandler, basicAuthentication,
...@@ -518,7 +525,6 @@ public class RestTemplateBuilder { ...@@ -518,7 +525,6 @@ public class RestTemplateBuilder {
* @see RestTemplateBuilder#build() * @see RestTemplateBuilder#build()
* @see #configure(RestTemplate) * @see #configure(RestTemplate)
*/ */
public <T extends RestTemplate> T build(Class<T> restTemplateClass) { public <T extends RestTemplate> T build(Class<T> restTemplateClass) {
return configure(BeanUtils.instantiateClass(restTemplateClass)); return configure(BeanUtils.instantiateClass(restTemplateClass));
} }
...@@ -532,7 +538,13 @@ public class RestTemplateBuilder { ...@@ -532,7 +538,13 @@ public class RestTemplateBuilder {
* @see RestTemplateBuilder#build(Class) * @see RestTemplateBuilder#build(Class)
*/ */
public <T extends RestTemplate> T configure(T restTemplate) { public <T extends RestTemplate> T configure(T restTemplate) {
configureRequestFactory(restTemplate); ClientHttpRequestFactory requestFactory = buildRequestFactory();
if (requestFactory != null) {
restTemplate.setRequestFactory(requestFactory);
}
if (this.basicAuthentication != null) {
configureBasicAuthentication(restTemplate);
}
if (!CollectionUtils.isEmpty(this.messageConverters)) { if (!CollectionUtils.isEmpty(this.messageConverters)) {
restTemplate.setMessageConverters(new ArrayList<>(this.messageConverters)); restTemplate.setMessageConverters(new ArrayList<>(this.messageConverters));
} }
...@@ -545,9 +557,6 @@ public class RestTemplateBuilder { ...@@ -545,9 +557,6 @@ public class RestTemplateBuilder {
if (this.rootUri != null) { if (this.rootUri != null) {
RootUriTemplateHandler.addTo(restTemplate, this.rootUri); RootUriTemplateHandler.addTo(restTemplate, this.rootUri);
} }
if (this.basicAuthentication != null) {
configureBasicAuthentication(restTemplate);
}
restTemplate.getInterceptors().addAll(this.interceptors); restTemplate.getInterceptors().addAll(this.interceptors);
if (!CollectionUtils.isEmpty(this.restTemplateCustomizers)) { if (!CollectionUtils.isEmpty(this.restTemplateCustomizers)) {
for (RestTemplateCustomizer customizer : this.restTemplateCustomizers) { for (RestTemplateCustomizer customizer : this.restTemplateCustomizers) {
...@@ -557,7 +566,13 @@ public class RestTemplateBuilder { ...@@ -557,7 +566,13 @@ public class RestTemplateBuilder {
return restTemplate; return restTemplate;
} }
private void configureRequestFactory(RestTemplate restTemplate) { /**
* Build a new {@link ClientHttpRequestFactory} instance using the settings of this
* builder.
* @return a {@link ClientHttpRequestFactory} or {@code null}
* @since 2.2.0
*/
public ClientHttpRequestFactory buildRequestFactory() {
ClientHttpRequestFactory requestFactory = null; ClientHttpRequestFactory requestFactory = null;
if (this.requestFactorySupplier != null) { if (this.requestFactorySupplier != null) {
requestFactory = this.requestFactorySupplier.get(); requestFactory = this.requestFactorySupplier.get();
...@@ -569,27 +584,24 @@ public class RestTemplateBuilder { ...@@ -569,27 +584,24 @@ public class RestTemplateBuilder {
if (this.requestFactoryCustomizer != null) { if (this.requestFactoryCustomizer != null) {
this.requestFactoryCustomizer.accept(requestFactory); this.requestFactoryCustomizer.accept(requestFactory);
} }
restTemplate.setRequestFactory(requestFactory);
} }
return requestFactory;
} }
private void configureBasicAuthentication(RestTemplate restTemplate) { private void configureBasicAuthentication(RestTemplate restTemplate) {
ClientHttpRequestFactory requestFactory = restTemplate.getRequestFactory(); List<ClientHttpRequestInterceptor> interceptors = null;
while (requestFactory instanceof InterceptingClientHttpRequestFactory if (!restTemplate.getInterceptors().isEmpty()) {
|| requestFactory instanceof BasicAuthenticationClientHttpRequestFactory) { // Stash and clear the interceptors so we can access the real factory
requestFactory = unwrapRequestFactory( interceptors = new ArrayList<>(restTemplate.getInterceptors());
((AbstractClientHttpRequestFactoryWrapper) requestFactory)); restTemplate.getInterceptors().clear();
} }
ClientHttpRequestFactory requestFactory = restTemplate.getRequestFactory();
restTemplate.setRequestFactory(new BasicAuthenticationClientHttpRequestFactory( restTemplate.setRequestFactory(new BasicAuthenticationClientHttpRequestFactory(
this.basicAuthentication, requestFactory)); this.basicAuthentication, requestFactory));
} // Restore the original interceptors
if (interceptors != null) {
private static ClientHttpRequestFactory unwrapRequestFactory( restTemplate.getInterceptors().addAll(interceptors);
AbstractClientHttpRequestFactoryWrapper requestFactory) { }
Field field = ReflectionUtils.findField(
AbstractClientHttpRequestFactoryWrapper.class, "requestFactory");
ReflectionUtils.makeAccessible(field);
return (ClientHttpRequestFactory) ReflectionUtils.getField(field, requestFactory);
} }
private <T> Set<T> append(Set<T> set, Collection<? extends T> additions) { private <T> Set<T> append(Set<T> set, Collection<? extends T> additions) {
...@@ -638,10 +650,16 @@ public class RestTemplateBuilder { ...@@ -638,10 +650,16 @@ public class RestTemplateBuilder {
private ClientHttpRequestFactory unwrapRequestFactoryIfNecessary( private ClientHttpRequestFactory unwrapRequestFactoryIfNecessary(
ClientHttpRequestFactory requestFactory) { ClientHttpRequestFactory requestFactory) {
if (!(requestFactory instanceof AbstractClientHttpRequestFactoryWrapper)) {
return requestFactory;
}
Field field = ReflectionUtils.findField(
AbstractClientHttpRequestFactoryWrapper.class, "requestFactory");
ReflectionUtils.makeAccessible(field);
ClientHttpRequestFactory unwrappedRequestFactory = requestFactory; ClientHttpRequestFactory unwrappedRequestFactory = requestFactory;
while (unwrappedRequestFactory instanceof AbstractClientHttpRequestFactoryWrapper) { while (unwrappedRequestFactory instanceof AbstractClientHttpRequestFactoryWrapper) {
unwrappedRequestFactory = unwrapRequestFactory( unwrappedRequestFactory = (ClientHttpRequestFactory) ReflectionUtils
((AbstractClientHttpRequestFactoryWrapper) unwrappedRequestFactory)); .getField(field, unwrappedRequestFactory);
} }
return unwrappedRequestFactory; return unwrappedRequestFactory;
} }
......
...@@ -29,7 +29,7 @@ import org.springframework.http.client.ClientHttpRequestFactory; ...@@ -29,7 +29,7 @@ import org.springframework.http.client.ClientHttpRequestFactory;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.any;
import static org.mockito.BDDMockito.when; import static org.mockito.BDDMockito.given;
import static org.mockito.Mockito.mock; import static org.mockito.Mockito.mock;
/** /**
...@@ -42,7 +42,7 @@ public class BasicAuthenticationClientHttpRequestFactoryTests { ...@@ -42,7 +42,7 @@ public class BasicAuthenticationClientHttpRequestFactoryTests {
private final HttpHeaders headers = new HttpHeaders(); private final HttpHeaders headers = new HttpHeaders();
private final BasicAuthentication authentication = new BasicAuthentication("spring", private final BasicAuthentication authentication = new BasicAuthentication("spring",
"boot"); "boot", null);
private ClientHttpRequestFactory requestFactory; private ClientHttpRequestFactory requestFactory;
...@@ -50,8 +50,8 @@ public class BasicAuthenticationClientHttpRequestFactoryTests { ...@@ -50,8 +50,8 @@ public class BasicAuthenticationClientHttpRequestFactoryTests {
public void setUp() throws IOException { public void setUp() throws IOException {
ClientHttpRequestFactory requestFactory = mock(ClientHttpRequestFactory.class); ClientHttpRequestFactory requestFactory = mock(ClientHttpRequestFactory.class);
ClientHttpRequest request = mock(ClientHttpRequest.class); ClientHttpRequest request = mock(ClientHttpRequest.class);
when(requestFactory.createRequest(any(), any())).thenReturn(request); given(requestFactory.createRequest(any(), any())).willReturn(request);
when(request.getHeaders()).thenReturn(this.headers); given(request.getHeaders()).willReturn(this.headers);
this.requestFactory = new BasicAuthenticationClientHttpRequestFactory( this.requestFactory = new BasicAuthenticationClientHttpRequestFactory(
this.authentication, requestFactory); this.authentication, requestFactory);
} }
...@@ -74,7 +74,7 @@ public class BasicAuthenticationClientHttpRequestFactoryTests { ...@@ -74,7 +74,7 @@ public class BasicAuthenticationClientHttpRequestFactoryTests {
} }
private ClientHttpRequest createRequest() throws IOException { private ClientHttpRequest createRequest() throws IOException {
return this.requestFactory.createRequest(URI.create("http://localhost:8080"), return this.requestFactory.createRequest(URI.create("https://localhost:8080"),
HttpMethod.POST); HttpMethod.POST);
} }
......
...@@ -324,13 +324,13 @@ public class RestTemplateBuilderTests { ...@@ -324,13 +324,13 @@ public class RestTemplateBuilderTests {
@Test @Test
public void basicAuthenticationShouldApply() { public void basicAuthenticationShouldApply() {
BasicAuthentication basicAuthentication = new BasicAuthentication("spring", RestTemplate template = this.builder
"boot", StandardCharsets.UTF_8); .basicAuthentication("spring", "boot", StandardCharsets.UTF_8).build();
RestTemplate template = this.builder.basicAuthentication(basicAuthentication)
.build();
ClientHttpRequestFactory requestFactory = template.getRequestFactory(); ClientHttpRequestFactory requestFactory = template.getRequestFactory();
assertThat(requestFactory).hasFieldOrPropertyWithValue("authentication", Object authentication = ReflectionTestUtils.getField(requestFactory,
basicAuthentication); "authentication");
assertThat(authentication).extracting("username", "password", "charset")
.containsExactly("spring", "boot", StandardCharsets.UTF_8);
} }
@Test @Test
...@@ -413,13 +413,15 @@ public class RestTemplateBuilderTests { ...@@ -413,13 +413,15 @@ public class RestTemplateBuilderTests {
assertThat(restTemplate.getUriTemplateHandler()) assertThat(restTemplate.getUriTemplateHandler())
.isInstanceOf(RootUriTemplateHandler.class); .isInstanceOf(RootUriTemplateHandler.class);
assertThat(restTemplate.getErrorHandler()).isEqualTo(errorHandler); assertThat(restTemplate.getErrorHandler()).isEqualTo(errorHandler);
ClientHttpRequestFactory interceptingRequestFactory = restTemplate ClientHttpRequestFactory actualRequestFactory = restTemplate
.getRequestFactory(); .getRequestFactory();
assertThat(interceptingRequestFactory) assertThat(actualRequestFactory)
.isInstanceOf(InterceptingClientHttpRequestFactory.class); .isInstanceOf(InterceptingClientHttpRequestFactory.class);
Object basicAuthRequestFactory = ReflectionTestUtils ClientHttpRequestFactory authRequestFactory = (ClientHttpRequestFactory) ReflectionTestUtils
.getField(interceptingRequestFactory, "requestFactory"); .getField(actualRequestFactory, "requestFactory");
assertThat(basicAuthRequestFactory).hasFieldOrPropertyWithValue( assertThat(authRequestFactory).isInstanceOf(
BasicAuthenticationClientHttpRequestFactory.class);
assertThat(authRequestFactory).hasFieldOrPropertyWithValue(
"requestFactory", requestFactory); "requestFactory", requestFactory);
}).build(); }).build();
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment