ResourceHttpMessageConverter reads Content-Disposition header to expose filename through Resource

Issue: SPR-15191

Author: jhoeller

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

@@ -82,12 +82,23 @@ protected boolean supports(Class<?> clazz) {
 	protected Resource readInternal(Class<? extends Resource> clazz, HttpInputMessage inputMessage)
 			throws IOException, HttpMessageNotReadableException {
 
+		final String filename = inputMessage.getHeaders().getContentDisposition().getFilename();
 		if (this.supportsReadStreaming && InputStreamResource.class == clazz) {
-			return new InputStreamResource(inputMessage.getBody());
+			return new InputStreamResource(inputMessage.getBody()) {
+				@Override
+				public String getFilename() {
+					return filename;
+				}
+			};
 		}
 		else if (clazz.isAssignableFrom(ByteArrayResource.class)) {
 			byte[] body = StreamUtils.copyToByteArray(inputMessage.getBody());
-			return new ByteArrayResource(body);
+			return new ByteArrayResource(body) {
+				@Override
+				public String getFilename() {
+					return filename;
+				}
+			};
 		}
 		else {
 			throw new IllegalStateException("Unsupported resource class: " + clazz);

spring-web/src/test/java/org/springframework/http/converter/ResourceHttpMessageConverterTests.java

@@ -29,6 +29,7 @@
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.InputStreamResource;
 import org.springframework.core.io.Resource;
+import org.springframework.http.ContentDisposition;
 import org.springframework.http.MediaType;
 import org.springframework.http.MockHttpInputMessage;
 import org.springframework.http.MockHttpOutputMessage;
@@ -69,18 +70,24 @@ public void shouldReadImageResource() throws IOException {
 		byte[] body = FileCopyUtils.copyToByteArray(getClass().getResourceAsStream("logo.jpg"));
 		MockHttpInputMessage inputMessage = new MockHttpInputMessage(body);
 		inputMessage.getHeaders().setContentType(MediaType.IMAGE_JPEG);
+		inputMessage.getHeaders().setContentDisposition(
+				ContentDisposition.builder("attachment").filename("yourlogo.jpg").build());
 		Resource actualResource = converter.read(Resource.class, inputMessage);
 		assertThat(FileCopyUtils.copyToByteArray(actualResource.getInputStream()), is(body));
+		assertEquals("yourlogo.jpg", actualResource.getFilename());
 	}
 
 	@Test  // SPR-13443
 	public void shouldReadInputStreamResource() throws IOException {
 		try (InputStream body = getClass().getResourceAsStream("logo.jpg") ) {
 			MockHttpInputMessage inputMessage = new MockHttpInputMessage(body);
 			inputMessage.getHeaders().setContentType(MediaType.IMAGE_JPEG);
+			inputMessage.getHeaders().setContentDisposition(
+					ContentDisposition.builder("attachment").filename("yourlogo.jpg").build());
 			Resource actualResource = converter.read(InputStreamResource.class, inputMessage);
 			assertThat(actualResource, instanceOf(InputStreamResource.class));
 			assertThat(actualResource.getInputStream(), is(body));
+			assertEquals("yourlogo.jpg", actualResource.getFilename());
 		}
 	}
 
@@ -100,6 +107,7 @@ public void shouldWriteImageResource() throws IOException {
 		MockHttpOutputMessage outputMessage = new MockHttpOutputMessage();
 		Resource body = new ClassPathResource("logo.jpg", getClass());
 		converter.write(body, null, outputMessage);
+
 		assertEquals("Invalid content-type", MediaType.IMAGE_JPEG,
 				outputMessage.getHeaders().getContentType());
 		assertEquals("Invalid content-length", body.getFile().length(), outputMessage.getHeaders().getContentLength());
@@ -111,45 +119,42 @@ public void writeByteArrayNullMediaType() throws IOException {
 		byte[] byteArray = {1, 2, 3};
 		Resource body = new ByteArrayResource(byteArray);
 		converter.write(body, null, outputMessage);
+
 		assertTrue(Arrays.equals(byteArray, outputMessage.getBodyAsBytes()));
 	}
 
-	// SPR-12999
-	@Test @SuppressWarnings("unchecked")
+	@Test  // SPR-12999
+	@SuppressWarnings("unchecked")
 	public void writeContentNotGettingInputStream() throws Exception {
 		MockHttpOutputMessage outputMessage = new MockHttpOutputMessage();
 		Resource resource = mock(Resource.class);
 		given(resource.getInputStream()).willThrow(FileNotFoundException.class);
-
 		converter.write(resource, MediaType.APPLICATION_OCTET_STREAM, outputMessage);
 
 		assertEquals(0, outputMessage.getHeaders().getContentLength());
 	}
 
-	// SPR-12999
-	@Test
+	@Test  // SPR-12999
 	public void writeContentNotClosingInputStream() throws Exception {
 		MockHttpOutputMessage outputMessage = new MockHttpOutputMessage();
 		Resource resource = mock(Resource.class);
 		InputStream inputStream = mock(InputStream.class);
 		given(resource.getInputStream()).willReturn(inputStream);
 		given(inputStream.read(any())).willReturn(-1);
 		doThrow(new NullPointerException()).when(inputStream).close();
-
 		converter.write(resource, MediaType.APPLICATION_OCTET_STREAM, outputMessage);
 
 		assertEquals(0, outputMessage.getHeaders().getContentLength());
 	}
 
-	// SPR-13620
-	@Test @SuppressWarnings("unchecked")
+	@Test  // SPR-13620
+	@SuppressWarnings("unchecked")
 	public void writeContentInputStreamThrowingNullPointerException() throws Exception {
 		MockHttpOutputMessage outputMessage = new MockHttpOutputMessage();
 		Resource resource = mock(Resource.class);
 		InputStream in = mock(InputStream.class);
 		given(resource.getInputStream()).willReturn(in);
 		given(in.read(any())).willThrow(NullPointerException.class);
-
 		converter.write(resource, MediaType.APPLICATION_OCTET_STREAM, outputMessage);
 
 		assertEquals(0, outputMessage.getHeaders().getContentLength());