InterceptingClientHttpRequest adapts to StreamingHttpOutputMessage

Issue: SPR-16582

Author: jhoeller

spring-web/src/main/java/org/springframework/http/HttpInputMessage.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -34,7 +34,7 @@ public interface HttpInputMessage extends HttpMessage {
 	/**
 	 * Return the body of the message as an input stream.
 	 * @return the input stream body (never {@code null})
-	 * @throws IOException in case of I/O Errors
+	 * @throws IOException in case of I/O errors
 	 */
 	InputStream getBody() throws IOException;
 

spring-web/src/main/java/org/springframework/http/HttpOutputMessage.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -34,7 +34,7 @@ public interface HttpOutputMessage extends HttpMessage {
 	/**
 	 * Return the body of the message as an output stream.
 	 * @return the output stream body (never {@code null})
-	 * @throws IOException in case of I/O Errors
+	 * @throws IOException in case of I/O errors
 	 */
 	OutputStream getBody() throws IOException;
 

spring-web/src/main/java/org/springframework/http/StreamingHttpOutputMessage.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -30,24 +30,24 @@
 public interface StreamingHttpOutputMessage extends HttpOutputMessage {
 
 	/**
-	 * Set the streaming body for this message.
-	 * @param body the streaming body
+	 * Set the streaming body callback for this message.
+	 * @param body the streaming body callback
 	 */
 	void setBody(Body body);
 
 
 	/**
-	 * Defines the contract for bodies that can be written directly to an {@link OutputStream}.
-	 * It is useful with HTTP client libraries that provide indirect access to an
-	 * {@link OutputStream} via a callback mechanism.
+	 * Defines the contract for bodies that can be written directly to an
+	 * {@link OutputStream}. Useful with HTTP client libraries that provide
+	 * indirect access to an {@link OutputStream} via a callback mechanism.
 	 */
 	@FunctionalInterface
 	interface Body {
 
 		/**
 		 * Write this body to the given {@link OutputStream}.
 		 * @param outputStream the output stream to write to
-		 * @throws IOException in case of errors
+		 * @throws IOException in case of I/O errors
 		 */
 		void writeTo(OutputStream outputStream) throws IOException;
 	}

spring-web/src/main/java/org/springframework/http/client/ClientHttpRequestInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -22,8 +22,8 @@
 
 /**
  * Intercepts client-side HTTP requests. Implementations of this interface can be
- * {@linkplain org.springframework.web.client.RestTemplate#setInterceptors(java.util.List)
- * registered} with the {@link org.springframework.web.client.RestTemplate RestTemplate},
+ * {@linkplain org.springframework.web.client.RestTemplate#setInterceptors registered}
+ * with the {@link org.springframework.web.client.RestTemplate RestTemplate},
  * as to modify the outgoing {@link ClientHttpRequest} and/or the incoming
  * {@link ClientHttpResponse}.
  *
@@ -40,7 +40,6 @@ public interface ClientHttpRequestInterceptor {
 	 * Intercept the given request, and return a response. The given
 	 * {@link ClientHttpRequestExecution} allows the interceptor to pass on the
 	 * request and response to the next entity in the chain.
-	 *
 	 * <p>A typical implementation of this method would follow the following pattern:
 	 * <ol>
 	 * <li>Examine the {@linkplain HttpRequest request} and body</li>
@@ -56,7 +55,6 @@ public interface ClientHttpRequestInterceptor {
 	 * </ul>
 	 * <li>Optionally wrap the response to filter HTTP attributes.</li>
 	 * </ol>
-	 *
 	 * @param request the request, containing method, URI, and headers
 	 * @param body the body of the request
 	 * @param execution the request execution

spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -145,6 +145,7 @@ public void setReadTimeout(int timeout) {
 	 * Indicates whether this request factory should buffer the request body internally.
 	 * <p>Default is {@code true}. When sending large amounts of data via POST or PUT, it is
 	 * recommended to change this property to {@code false}, so as not to run out of memory.
+	 * @since 4.0
 	 */
 	public void setBufferRequestBody(boolean bufferRequestBody) {
 		this.bufferRequestBody = bufferRequestBody;

spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -20,11 +20,11 @@
 import java.net.URI;
 import java.util.Iterator;
 import java.util.List;
-import java.util.Map;
 
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpMethod;
 import org.springframework.http.HttpRequest;
+import org.springframework.http.StreamingHttpOutputMessage;
 import org.springframework.util.Assert;
 import org.springframework.util.StreamUtils;
 
@@ -95,11 +95,15 @@ public ClientHttpResponse execute(HttpRequest request, byte[] body) throws IOExc
 				HttpMethod method = request.getMethod();
 				Assert.state(method != null, "No standard HTTP method");
 				ClientHttpRequest delegate = requestFactory.createRequest(request.getURI(), method);
-				for (Map.Entry<String, List<String>> entry : request.getHeaders().entrySet()) {
-					delegate.getHeaders().addAll(entry.getKey(), entry.getValue());
-				}
+				request.getHeaders().forEach((key, value) -> delegate.getHeaders().addAll(key, value));
 				if (body.length > 0) {
-					StreamUtils.copy(body, delegate.getBody());
+					if (delegate instanceof StreamingHttpOutputMessage) {
+						StreamingHttpOutputMessage streamingOutputMessage = (StreamingHttpOutputMessage) delegate;
+						streamingOutputMessage.setBody(outputStream -> StreamUtils.copy(body, outputStream));
+					}
+					else {
+						StreamUtils.copy(body, delegate.getBody());
+					}
 				}
 				return delegate.execute();
 			}

spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -208,23 +208,17 @@ public final void write(final T t, @Nullable MediaType contentType, HttpOutputMe
 		addDefaultHeaders(headers, t, contentType);
 
 		if (outputMessage instanceof StreamingHttpOutputMessage) {
-			StreamingHttpOutputMessage streamingOutputMessage =
-					(StreamingHttpOutputMessage) outputMessage;
-			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
+			StreamingHttpOutputMessage streamingOutputMessage = (StreamingHttpOutputMessage) outputMessage;
+			streamingOutputMessage.setBody(outputStream -> writeInternal(t, new HttpOutputMessage() {
 				@Override
-				public void writeTo(final OutputStream outputStream) throws IOException {
-					writeInternal(t, new HttpOutputMessage() {
-						@Override
-						public OutputStream getBody() throws IOException {
-							return outputStream;
-						}
-						@Override
-						public HttpHeaders getHeaders() {
-							return headers;
-						}
-					});
+				public OutputStream getBody() {
+					return outputStream;
 				}
-			});
+				@Override
+				public HttpHeaders getHeaders() {
+					return headers;
+				}
+			}));
 		}
 		else {
 			writeInternal(t, outputMessage);

spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -221,12 +221,7 @@ public void write(final BufferedImage image, @Nullable final MediaType contentTy
 
 		if (outputMessage instanceof StreamingHttpOutputMessage) {
 			StreamingHttpOutputMessage streamingOutputMessage = (StreamingHttpOutputMessage) outputMessage;
-			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
-				@Override
-				public void writeTo(OutputStream outputStream) throws IOException {
-					writeInternal(image, selectedContentType, outputStream);
-				}
-			});
+			streamingOutputMessage.setBody(outputStream -> writeInternal(image, selectedContentType, outputStream));
 		}
 		else {
 			writeInternal(image, selectedContentType, outputMessage.getBody());

spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -319,12 +319,7 @@ private void writeForm(MultiValueMap<String, String> form, @Nullable MediaType c
 
 		if (outputMessage instanceof StreamingHttpOutputMessage) {
 			StreamingHttpOutputMessage streamingOutputMessage = (StreamingHttpOutputMessage) outputMessage;
-			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
-				@Override
-				public void writeTo(OutputStream outputStream) throws IOException {
-					StreamUtils.copy(bytes, outputStream);
-				}
-			});
+			streamingOutputMessage.setBody(outputStream -> StreamUtils.copy(bytes, outputStream));
 		}
 		else {
 			StreamUtils.copy(bytes, outputMessage.getBody());
@@ -347,12 +342,9 @@ private void writeMultipart(final MultiValueMap<String, Object> parts,
 
 		if (outputMessage instanceof StreamingHttpOutputMessage) {
 			StreamingHttpOutputMessage streamingOutputMessage = (StreamingHttpOutputMessage) outputMessage;
-			streamingOutputMessage.setBody(new StreamingHttpOutputMessage.Body() {
-				@Override
-				public void writeTo(OutputStream outputStream) throws IOException {
-					writeParts(outputStream, parts, boundary);
-					writeEnd(outputStream, boundary);
-				}
+			streamingOutputMessage.setBody(outputStream -> {
+				writeParts(outputStream, parts, boundary);
+				writeEnd(outputStream, boundary);
 			});
 		}
 		else {

spring-web/src/test/java/org/springframework/http/client/AbstractHttpRequestFactoryTestCase.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.
@@ -16,8 +16,6 @@
 
 package org.springframework.http.client;
 
-import java.io.IOException;
-import java.io.OutputStream;
 import java.net.URI;
 import java.util.Arrays;
 import java.util.Locale;
@@ -69,6 +67,7 @@ public void status() throws Exception {
 		ClientHttpRequest request = factory.createRequest(uri, HttpMethod.GET);
 		assertEquals("Invalid HTTP method", HttpMethod.GET, request.getMethod());
 		assertEquals("Invalid HTTP URI", uri, request.getURI());
+
 		ClientHttpResponse response = request.execute();
 		try {
 			assertEquals("Invalid status code", HttpStatus.NOT_FOUND, response.getStatusCode());
@@ -82,26 +81,23 @@ public void status() throws Exception {
 	public void echo() throws Exception {
 		ClientHttpRequest request = factory.createRequest(new URI(baseUrl + "/echo"), HttpMethod.PUT);
 		assertEquals("Invalid HTTP method", HttpMethod.PUT, request.getMethod());
+
 		String headerName = "MyHeader";
 		String headerValue1 = "value1";
 		request.getHeaders().add(headerName, headerValue1);
 		String headerValue2 = "value2";
 		request.getHeaders().add(headerName, headerValue2);
 		final byte[] body = "Hello World".getBytes("UTF-8");
 		request.getHeaders().setContentLength(body.length);
+
 		if (request instanceof StreamingHttpOutputMessage) {
-			StreamingHttpOutputMessage streamingRequest =
-					(StreamingHttpOutputMessage) request;
-			streamingRequest.setBody(new StreamingHttpOutputMessage.Body() {
-				@Override
-				public void writeTo(OutputStream outputStream) throws IOException {
-					StreamUtils.copy(body, outputStream);
-				}
-			});
+			StreamingHttpOutputMessage streamingRequest = (StreamingHttpOutputMessage) request;
+			streamingRequest.setBody(outputStream -> StreamUtils.copy(body, outputStream));
 		}
 		else {
 			StreamUtils.copy(body, request.getBody());
 		}
+
 		ClientHttpResponse response = request.execute();
 		try {
 			assertEquals("Invalid status code", HttpStatus.OK, response.getStatusCode());
@@ -119,17 +115,14 @@ public void writeTo(OutputStream outputStream) throws IOException {
 	@Test(expected = IllegalStateException.class)
 	public void multipleWrites() throws Exception {
 		ClientHttpRequest request = factory.createRequest(new URI(baseUrl + "/echo"), HttpMethod.POST);
+
 		final byte[] body = "Hello World".getBytes("UTF-8");
 		if (request instanceof StreamingHttpOutputMessage) {
-			StreamingHttpOutputMessage streamingRequest =
-					(StreamingHttpOutputMessage) request;
-			streamingRequest.setBody(new StreamingHttpOutputMessage.Body() {
-				@Override
-				public void writeTo(OutputStream outputStream) throws IOException {
-					StreamUtils.copy(body, outputStream);
-					outputStream.flush();
-					outputStream.close();
-				}
+			StreamingHttpOutputMessage streamingRequest = (StreamingHttpOutputMessage) request;
+			streamingRequest.setBody(outputStream -> {
+				StreamUtils.copy(body, outputStream);
+				outputStream.flush();
+				outputStream.close();
 			});
 		}
 		else {
@@ -143,9 +136,11 @@ public void writeTo(OutputStream outputStream) throws IOException {
 	@Test(expected = UnsupportedOperationException.class)
 	public void headersAfterExecute() throws Exception {
 		ClientHttpRequest request = factory.createRequest(new URI(baseUrl + "/echo"), HttpMethod.POST);
+
 		request.getHeaders().add("MyHeader", "value");
 		byte[] body = "Hello World".getBytes("UTF-8");
 		FileCopyUtils.copy(body, request.getBody());
+
 		ClientHttpResponse response = request.execute();
 		try {
 			request.getHeaders().add("MyHeader", "value");

spring-web/src/test/java/org/springframework/http/client/InterceptingStreamingHttpComponentsTests.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2002-2018 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.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.http.client;
+
+import org.junit.Test;
+
+import org.springframework.http.HttpMethod;
+
+/**
+ * @author Juergen Hoeller
+ */
+public class InterceptingStreamingHttpComponentsTests extends AbstractHttpRequestFactoryTestCase {
+
+	@Override
+	protected ClientHttpRequestFactory createRequestFactory() {
+		HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory();
+		requestFactory.setBufferRequestBody(false);
+		return new InterceptingClientHttpRequestFactory(requestFactory, null);
+	}
+
+	@Override
+	@Test
+	public void httpMethods() throws Exception {
+		assertHttpMethod("patch", HttpMethod.PATCH);
+	}
+
+}