diff --git a/spring-web/src/main/java/org/springframework/http/HttpInputMessage.java b/spring-web/src/main/java/org/springframework/http/HttpInputMessage.java index 9aeab46b9a1..61874849f71 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpInputMessage.java +++ b/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; diff --git a/spring-web/src/main/java/org/springframework/http/HttpOutputMessage.java b/spring-web/src/main/java/org/springframework/http/HttpOutputMessage.java index fdee15b0c96..f8c7f866c8d 100644 --- a/spring-web/src/main/java/org/springframework/http/HttpOutputMessage.java +++ b/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; diff --git a/spring-web/src/main/java/org/springframework/http/StreamingHttpOutputMessage.java b/spring-web/src/main/java/org/springframework/http/StreamingHttpOutputMessage.java index abe13051bfa..c4787b2fdd0 100644 --- a/spring-web/src/main/java/org/springframework/http/StreamingHttpOutputMessage.java +++ b/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,16 +30,16 @@ import java.io.OutputStream; 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 { @@ -47,7 +47,7 @@ public interface StreamingHttpOutputMessage extends HttpOutputMessage { /** * 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; } diff --git a/spring-web/src/main/java/org/springframework/http/client/ClientHttpRequestInterceptor.java b/spring-web/src/main/java/org/springframework/http/client/ClientHttpRequestInterceptor.java index 81e2d618bb2..cab167e2f69 100644 --- a/spring-web/src/main/java/org/springframework/http/client/ClientHttpRequestInterceptor.java +++ b/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 @@ import org.springframework.http.HttpRequest; /** * 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. - * *

A typical implementation of this method would follow the following pattern: *

    *
  1. Examine the {@linkplain HttpRequest request} and body
    2. @@ -56,7 +55,6 @@ public interface ClientHttpRequestInterceptor { * *
  2. Optionally wrap the response to filter HTTP attributes.
    3. *
- * * @param request the request, containing method, URI, and headers * @param body the body of the request * @param execution the request execution diff --git a/spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.java b/spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.java index 27815f69a9a..095b10a8539 100644 --- a/spring-web/src/main/java/org/springframework/http/client/HttpComponentsClientHttpRequestFactory.java +++ b/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 class HttpComponentsClientHttpRequestFactory implements ClientHttpRequest * Indicates whether this request factory should buffer the request body internally. *

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; diff --git a/spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequest.java b/spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequest.java index 3d73648314d..dd4d564c051 100644 --- a/spring-web/src/main/java/org/springframework/http/client/InterceptingClientHttpRequest.java +++ b/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.io.IOException; 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 @@ class InterceptingClientHttpRequest extends AbstractBufferingClientHttpRequest { HttpMethod method = request.getMethod(); Assert.state(method != null, "No standard HTTP method"); ClientHttpRequest delegate = requestFactory.createRequest(request.getURI(), method); - for (Map.Entry> 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(); } diff --git a/spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java index 3761dc17dce..78d05eceedb 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/AbstractHttpMessageConverter.java +++ b/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 abstract class AbstractHttpMessageConverter implements HttpMessageConv 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); diff --git a/spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java index 5f4a6627318..7bbe9064dfa 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/BufferedImageHttpMessageConverter.java +++ b/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 class BufferedImageHttpMessageConverter implements HttpMessageConverter writeInternal(image, selectedContentType, outputStream)); } else { writeInternal(image, selectedContentType, outputMessage.getBody()); diff --git a/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java b/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java index 3c22c994900..3972641a988 100644 --- a/spring-web/src/main/java/org/springframework/http/converter/FormHttpMessageConverter.java +++ b/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 @@ public class FormHttpMessageConverter implements HttpMessageConverter StreamUtils.copy(bytes, outputStream)); } else { StreamUtils.copy(bytes, outputMessage.getBody()); @@ -347,12 +342,9 @@ public class FormHttpMessageConverter implements HttpMessageConverter { + writeParts(outputStream, parts, boundary); + writeEnd(outputStream, boundary); }); } else { diff --git a/spring-web/src/test/java/org/springframework/http/client/AbstractHttpRequestFactoryTestCase.java b/spring-web/src/test/java/org/springframework/http/client/AbstractHttpRequestFactoryTestCase.java index 5b4fab2a3fb..954d0ed5b09 100644 --- a/spring-web/src/test/java/org/springframework/http/client/AbstractHttpRequestFactoryTestCase.java +++ b/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 abstract class AbstractHttpRequestFactoryTestCase extends AbstractMockWeb 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,6 +81,7 @@ public abstract class AbstractHttpRequestFactoryTestCase extends AbstractMockWeb 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); @@ -89,19 +89,15 @@ public abstract class AbstractHttpRequestFactoryTestCase extends AbstractMockWeb 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 abstract class AbstractHttpRequestFactoryTestCase extends AbstractMockWeb @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 abstract class AbstractHttpRequestFactoryTestCase extends AbstractMockWeb @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"); diff --git a/spring-web/src/test/java/org/springframework/http/client/InterceptingStreamingHttpComponentsTests.java b/spring-web/src/test/java/org/springframework/http/client/InterceptingStreamingHttpComponentsTests.java new file mode 100644 index 00000000000..9416c818745 --- /dev/null +++ b/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); + } + +} diff --git a/spring-web/src/test/java/org/springframework/http/client/StreamingHttpComponentsClientHttpRequestFactoryTests.java b/spring-web/src/test/java/org/springframework/http/client/StreamingHttpComponentsClientHttpRequestFactoryTests.java index 090e3fe5b44..5ad9eab2d7c 100644 --- a/spring-web/src/test/java/org/springframework/http/client/StreamingHttpComponentsClientHttpRequestFactoryTests.java +++ b/spring-web/src/test/java/org/springframework/http/client/StreamingHttpComponentsClientHttpRequestFactoryTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 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,13 +20,14 @@ import org.junit.Test; import org.springframework.http.HttpMethod; -public class StreamingHttpComponentsClientHttpRequestFactoryTests - extends AbstractHttpRequestFactoryTestCase { +/** + * @author Arjen Poutsma + */ +public class StreamingHttpComponentsClientHttpRequestFactoryTests extends AbstractHttpRequestFactoryTestCase { @Override protected ClientHttpRequestFactory createRequestFactory() { - HttpComponentsClientHttpRequestFactory requestFactory = - new HttpComponentsClientHttpRequestFactory(); + HttpComponentsClientHttpRequestFactory requestFactory = new HttpComponentsClientHttpRequestFactory(); requestFactory.setBufferRequestBody(false); return requestFactory; } diff --git a/spring-web/src/test/java/org/springframework/http/client/StreamingSimpleHttpRequestFactoryTests.java b/spring-web/src/test/java/org/springframework/http/client/StreamingSimpleClientHttpRequestFactoryTests.java similarity index 76% rename from spring-web/src/test/java/org/springframework/http/client/StreamingSimpleHttpRequestFactoryTests.java rename to spring-web/src/test/java/org/springframework/http/client/StreamingSimpleClientHttpRequestFactoryTests.java index 2c6cc6699a9..e494e462917 100644 --- a/spring-web/src/test/java/org/springframework/http/client/StreamingSimpleHttpRequestFactoryTests.java +++ b/spring-web/src/test/java/org/springframework/http/client/StreamingSimpleClientHttpRequestFactoryTests.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2013 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,7 +16,6 @@ package org.springframework.http.client; -import java.io.IOException; import java.io.OutputStream; import java.net.URI; import java.util.Collections; @@ -27,12 +26,14 @@ import org.junit.Test; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpMethod; -import org.springframework.http.HttpRequest; import org.springframework.http.HttpStatus; import static org.junit.Assert.*; -public class StreamingSimpleHttpRequestFactoryTests extends AbstractHttpRequestFactoryTestCase { +/** + * @author Arjen Poutsma + */ +public class StreamingSimpleClientHttpRequestFactoryTests extends AbstractHttpRequestFactoryTestCase { @Override protected ClientHttpRequestFactory createRequestFactory() { @@ -41,21 +42,16 @@ public class StreamingSimpleHttpRequestFactoryTests extends AbstractHttpRequestF return factory; } - // SPR-8809 - @Test + @Test // SPR-8809 public void interceptor() throws Exception { final String headerName = "MyHeader"; final String headerValue = "MyValue"; - ClientHttpRequestInterceptor interceptor = new ClientHttpRequestInterceptor() { - @Override - public ClientHttpResponse intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution) - throws IOException { - request.getHeaders().add(headerName, headerValue); - return execution.execute(request, body); - } + ClientHttpRequestInterceptor interceptor = (request, body, execution) -> { + request.getHeaders().add(headerName, headerValue); + return execution.execute(request, body); }; - InterceptingClientHttpRequestFactory factory = new InterceptingClientHttpRequestFactory(createRequestFactory(), - Collections.singletonList(interceptor)); + InterceptingClientHttpRequestFactory factory = new InterceptingClientHttpRequestFactory( + createRequestFactory(), Collections.singletonList(interceptor)); ClientHttpResponse response = null; try { @@ -81,8 +77,8 @@ public class StreamingSimpleHttpRequestFactoryTests extends AbstractHttpRequestF ClientHttpRequest request = factory.createRequest(new URI(baseUrl + "/methods/post"), HttpMethod.POST); final int BUF_SIZE = 4096; final int ITERATIONS = Integer.MAX_VALUE / BUF_SIZE; -// final int contentLength = ITERATIONS * BUF_SIZE; -// request.getHeaders().setContentLength(contentLength); + // final int contentLength = ITERATIONS * BUF_SIZE; + // request.getHeaders().setContentLength(contentLength); OutputStream body = request.getBody(); for (int i = 0; i < ITERATIONS; i++) { byte[] buffer = new byte[BUF_SIZE];