Make it easier to set bufferRequestBody

Update `RestTemplateBuilder` to make it easier to set
the `bufferRequestBody` value on a underlying `ClientHttpRequestFactory`

See gh-16972

Author: kstrijbos

spring-boot-project/spring-boot/src/main/java/org/springframework/boot/web/client/RestTemplateBuilder.java

@@ -60,6 +60,7 @@
  * @author Andy Wilkinson
  * @author Brian Clozel
  * @author Dmytro Nosan
+ * @author Kevin Strijbos
  * @since 1.4.0
  */
 public class RestTemplateBuilder {
@@ -506,6 +507,22 @@ public RestTemplateBuilder setReadTimeout(Duration readTimeout) {
 				this.interceptors);
 	}
 
+	/**
+	 * Sets the bufferrequestbody value on the underlying
+	 * {@link ClientHttpRequestFactory}.
+	 * @param bufferRequestBody value of the bufferRequestBody parameter
+	 * @return a new builder instance.
+	 * @since 2.1.0
+	 */
+	public RestTemplateBuilder setBufferRequestBody(boolean bufferRequestBody) {
+		return new RestTemplateBuilder(this.detectRequestFactory, this.rootUri,
+				this.messageConverters, this.requestFactorySupplier,
+				this.uriTemplateHandler, this.errorHandler, this.basicAuthentication,
+				this.restTemplateCustomizers,
+				this.requestFactoryCustomizer.bufferRequestBody(bufferRequestBody),
+				this.interceptors);
+	}
+
 	/**
 	 * Build a new {@link RestTemplate} instance and configure it using this builder.
 	 * @return a configured {@link RestTemplate} instance.
@@ -617,21 +634,35 @@ private static class RequestFactoryCustomizer
 
 		private final Duration readTimeout;
 
+		private final boolean bufferRequestBody;
+
+		private final boolean bufferRequestBodyFlag;
+
 		RequestFactoryCustomizer() {
-			this(null, null);
+			this(null, null, true, false);
 		}
 
-		private RequestFactoryCustomizer(Duration connectTimeout, Duration readTimeout) {
+		private RequestFactoryCustomizer(Duration connectTimeout, Duration readTimeout,
+				boolean bufferRequestBody, boolean bufferRequestBodyFlag) {
 			this.connectTimeout = connectTimeout;
 			this.readTimeout = readTimeout;
+			this.bufferRequestBody = bufferRequestBody;
+			this.bufferRequestBodyFlag = bufferRequestBodyFlag;
 		}
 
 		public RequestFactoryCustomizer connectTimeout(Duration connectTimeout) {
-			return new RequestFactoryCustomizer(connectTimeout, this.readTimeout);
+			return new RequestFactoryCustomizer(connectTimeout, this.readTimeout,
+					this.bufferRequestBody, this.bufferRequestBodyFlag);
 		}
 
 		public RequestFactoryCustomizer readTimeout(Duration readTimeout) {
-			return new RequestFactoryCustomizer(this.connectTimeout, readTimeout);
+			return new RequestFactoryCustomizer(this.connectTimeout, readTimeout,
+					this.bufferRequestBody, this.bufferRequestBodyFlag);
+		}
+
+		public RequestFactoryCustomizer bufferRequestBody(boolean bufferRequestBody) {
+			return new RequestFactoryCustomizer(this.connectTimeout, this.readTimeout,
+					bufferRequestBody, true);
 		}
 
 		@Override
@@ -646,6 +677,10 @@ public void accept(ClientHttpRequestFactory requestFactory) {
 				new TimeoutRequestFactoryCustomizer(this.readTimeout, "setReadTimeout")
 						.customize(unwrappedRequestFactory);
 			}
+			if (this.bufferRequestBodyFlag) {
+				new BufferRequestBodyFactoryCustomizer(this.bufferRequestBody,
+						"setBufferRequestBody").customize(unwrappedRequestFactory);
+			}
 		}
 
 		private ClientHttpRequestFactory unwrapRequestFactoryIfNecessary(
@@ -695,6 +730,39 @@ private Method findMethod(ClientHttpRequestFactory factory) {
 
 		}
 
+		/**
+		 * {@link ClientHttpRequestFactory} customizer to call a "set buffer request body"
+		 * method.
+		 */
+		private static final class BufferRequestBodyFactoryCustomizer {
+
+			private final boolean bufferRequestBody;
+
+			private final String methodName;
+
+			BufferRequestBodyFactoryCustomizer(boolean bufferRequestBody,
+					String methodName) {
+				this.bufferRequestBody = bufferRequestBody;
+				this.methodName = methodName;
+			}
+
+			void customize(ClientHttpRequestFactory factory) {
+				ReflectionUtils.invokeMethod(findMethod(factory), factory,
+						this.bufferRequestBody);
+			}
+
+			private Method findMethod(ClientHttpRequestFactory factory) {
+				Method method = ReflectionUtils.findMethod(factory.getClass(),
+						this.methodName, boolean.class);
+				if (method != null) {
+					return method;
+				}
+				throw new IllegalStateException("Request factory " + factory.getClass()
+						+ " does not have a " + this.methodName + "(boolean) method");
+			}
+
+		}
+
 	}
 
 }

spring-boot-project/spring-boot/src/test/java/org/springframework/boot/web/client/RestTemplateBuilderTests.java

@@ -47,6 +47,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
+import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.inOrder;
 import static org.mockito.Mockito.mock;
@@ -63,6 +64,7 @@
  * @author Phillip Webb
  * @author Andy Wilkinson
  * @author Dmytro Nosan
+ * @author Kevin Strijbos
  */
 public class RestTemplateBuilderTests {
 
@@ -480,6 +482,23 @@ public void readTimeoutCanBeConfiguredOnHttpComponentsRequestFactory() {
 				"requestConfig")).getSocketTimeout()).isEqualTo(1234);
 	}
 
+	@Test
+	public void bufferRequestBodyCanBeConfiguredOnHttpComponentsRequestFactory() {
+		ClientHttpRequestFactory requestFactory = this.builder
+				.requestFactory(HttpComponentsClientHttpRequestFactory.class)
+				.setBufferRequestBody(false).build().getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody",
+				false);
+		requestFactory = this.builder
+				.requestFactory(HttpComponentsClientHttpRequestFactory.class)
+				.setBufferRequestBody(true).build().getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+		requestFactory = this.builder
+				.requestFactory(HttpComponentsClientHttpRequestFactory.class).build()
+				.getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+	}
+
 	@Test
 	public void connectTimeoutCanBeConfiguredOnSimpleRequestFactory() {
 		ClientHttpRequestFactory requestFactory = this.builder
@@ -496,6 +515,21 @@ public void readTimeoutCanBeConfiguredOnSimpleRequestFactory() {
 		assertThat(requestFactory).hasFieldOrPropertyWithValue("readTimeout", 1234);
 	}
 
+	@Test
+	public void bufferRequestBodyCanBeConfiguredOnSimpleRequestFactory() {
+		ClientHttpRequestFactory requestFactory = this.builder
+				.requestFactory(SimpleClientHttpRequestFactory.class)
+				.setBufferRequestBody(false).build().getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody",
+				false);
+		requestFactory = this.builder.requestFactory(SimpleClientHttpRequestFactory.class)
+				.setBufferRequestBody(true).build().getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+		requestFactory = this.builder.requestFactory(SimpleClientHttpRequestFactory.class)
+				.build().getRequestFactory();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+	}
+
 	@Test
 	public void connectTimeoutCanBeConfiguredOnOkHttp3RequestFactory() {
 		ClientHttpRequestFactory requestFactory = this.builder
@@ -516,6 +550,15 @@ public void readTimeoutCanBeConfiguredOnOkHttp3RequestFactory() {
 						.isEqualTo(1234);
 	}
 
+	@Test
+	public void bufferRequestBodyCanNotBeConfiguredOnOkHttp3RequestFactory() {
+		assertThatIllegalStateException()
+				.isThrownBy(() -> this.builder
+						.requestFactory(OkHttp3ClientHttpRequestFactory.class)
+						.setBufferRequestBody(false).build().getRequestFactory())
+				.withMessageContaining(OkHttp3ClientHttpRequestFactory.class.getName());
+	}
+
 	@Test
 	public void connectTimeoutCanBeConfiguredOnAWrappedRequestFactory() {
 		SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
@@ -536,6 +579,27 @@ public void readTimeoutCanBeConfiguredOnAWrappedRequestFactory() {
 		assertThat(requestFactory).hasFieldOrPropertyWithValue("readTimeout", 1234);
 	}
 
+	@Test
+	public void bufferRequestBodyCanBeConfiguredOnAWrappedRequestFactory() {
+		SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
+		this.builder
+				.requestFactory(
+						() -> new BufferingClientHttpRequestFactory(requestFactory))
+				.setBufferRequestBody(false).build();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody",
+				false);
+		this.builder
+				.requestFactory(
+						() -> new BufferingClientHttpRequestFactory(requestFactory))
+				.setBufferRequestBody(true).build();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+		this.builder
+				.requestFactory(
+						() -> new BufferingClientHttpRequestFactory(requestFactory))
+				.build();
+		assertThat(requestFactory).hasFieldOrPropertyWithValue("bufferRequestBody", true);
+	}
+
 	@Test
 	public void unwrappingDoesNotAffectRequestFactoryThatIsSetOnTheBuiltTemplate() {
 		SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();