Introduce HttpHeaders get/setContentDisposition()

This commit introduces a new ContentDisposition class designed
to parse and generate Content-Disposition header value as defined
in RFC 2183. It supports the disposition type and the name,
filename (or filename* when encoded according to RFC 5987) and
size parameters.

This new class is usually used thanks to
HttpHeaders#getContentDisposition() and
HttpHeaders#setContentDisposition(ContentDisposition).

Issue: SPR-14408

spring-web/src/test/java/org/springframework/http/ContentDispositionTests.java

@@ -0,0 +1,135 @@
+/*
+ * Copyright 2002-2016 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;
+
+import java.lang.reflect.Method;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+
+import org.springframework.util.ReflectionUtils;
+
+/**
+ * Unit tests for {@link ContentDisposition}
+ *
+ * @author Sebastien Deleuze
+ */
+public class ContentDispositionTests {
+
+	@Test
+	public void parse() {
+		ContentDisposition disposition = ContentDisposition
+				.parse("form-data; name=\"foo\"; filename=\"foo.txt\"; size=123");
+		assertEquals(ContentDisposition.builder("form-data").name("foo").filename("foo.txt").size(123L).build(), disposition);
+	}
+
+	@Test
+	public void parseType() {
+		ContentDisposition disposition = ContentDisposition.parse("form-data");
+		assertEquals(ContentDisposition.builder("form-data").build(), disposition);
+	}
+
+	@Test
+	public void parseUnquotedFilename() {
+		ContentDisposition disposition = ContentDisposition
+				.parse("form-data; filename=unquoted");
+		assertEquals(ContentDisposition.builder("form-data").filename("unquoted").build(), disposition);
+	}
+
+	@Test
+	public void parseEncodedFilename() {
+		ContentDisposition disposition = ContentDisposition
+				.parse("form-data; name=\"name\"; filename*=UTF-8''%E4%B8%AD%E6%96%87.txt");
+		assertEquals(ContentDisposition.builder("form-data").name("name")
+				.filename("中文.txt", StandardCharsets.UTF_8).build(), disposition);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void parseEmpty() {
+		ContentDisposition.parse("");
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void parseNoType() {
+		ContentDisposition.parse(";");
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void parseInvalidParameter() {
+		ContentDisposition.parse("foo;bar");
+	}
+
+	@Test
+	public void headerValue() {
+		ContentDisposition disposition = ContentDisposition.builder("form-data")
+				.name("foo").filename("foo.txt").size(123L).build();
+		assertEquals("form-data; name=\"foo\"; filename=\"foo.txt\"; size=123", disposition.toString());
+	}
+
+	@Test
+	public void headerValueWithEncodedFilename() {
+		ContentDisposition disposition = ContentDisposition.builder("form-data")
+				.name("name").filename("中文.txt", StandardCharsets.UTF_8).build();
+		assertEquals("form-data; name=\"name\"; filename*=UTF-8''%E4%B8%AD%E6%96%87.txt", disposition.toString());
+	}
+
+	@Test  // SPR-14547
+	public void encodeHeaderFieldParam() {
+		Method encode = ReflectionUtils.findMethod(ContentDisposition.class,
+				"encodeHeaderFieldParam", String.class, Charset.class);
+		ReflectionUtils.makeAccessible(encode);
+
+		String result = (String)ReflectionUtils.invokeMethod(encode, null, "test.txt",
+				StandardCharsets.US_ASCII);
+		assertEquals("test.txt", result);
+
+		result = (String)ReflectionUtils.invokeMethod(encode, null, "中文.txt", StandardCharsets.UTF_8);
+		assertEquals("UTF-8''%E4%B8%AD%E6%96%87.txt", result);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void encodeHeaderFieldParamInvalidCharset() {
+		Method encode = ReflectionUtils.findMethod(ContentDisposition.class,
+				"encodeHeaderFieldParam", String.class, Charset.class);
+		ReflectionUtils.makeAccessible(encode);
+		ReflectionUtils.invokeMethod(encode, null, "test", StandardCharsets.UTF_16);
+	}
+
+	@Test  // SPR-14408
+	public void decodeHeaderFieldParam() {
+		Method decode = ReflectionUtils.findMethod(ContentDisposition.class,
+				"decodeHeaderFieldParam", String.class);
+		ReflectionUtils.makeAccessible(decode);
+
+		String result = (String)ReflectionUtils.invokeMethod(decode, null, "test.txt");
+		assertEquals("test.txt", result);
+
+		result = (String)ReflectionUtils.invokeMethod(decode, null, "UTF-8''%E4%B8%AD%E6%96%87.txt");
+		assertEquals("中文.txt", result);
+	}
+
+	@Test(expected = IllegalArgumentException.class)
+	public void decodeHeaderFieldParamInvalidCharset() {
+		Method decode = ReflectionUtils.findMethod(ContentDisposition.class,
+				"decodeHeaderFieldParam", String.class);
+		ReflectionUtils.makeAccessible(decode);
+		ReflectionUtils.invokeMethod(decode, null, "UTF-16''test");
+	}
+
+}

spring-web/src/test/java/org/springframework/http/HttpHeadersTests.java

@@ -331,18 +331,13 @@ public class HttpHeadersTests {
 
 	@Test
 	public void contentDisposition() {
-		headers.setContentDispositionFormData("name", null);
-		assertEquals("Invalid Content-Disposition header", "form-data; name=\"name\"",
-				headers.getFirst("Content-Disposition"));
+		ContentDisposition disposition = headers.getContentDisposition();
+		assertNotNull(disposition);
+		assertEquals("Invalid Content-Disposition header", ContentDisposition.empty(), headers.getContentDisposition());
 
-		headers.setContentDispositionFormData("name", "filename");
-		assertEquals("Invalid Content-Disposition header", "form-data; name=\"name\"; filename=\"filename\"",
-				headers.getFirst("Content-Disposition"));
-
-		headers.setContentDispositionFormData("name", "中文.txt", StandardCharsets.UTF_8);
-		assertEquals("Invalid Content-Disposition header",
-				"form-data; name=\"name\"; filename*=UTF-8''%E4%B8%AD%E6%96%87.txt",
-				headers.getFirst("Content-Disposition"));
+		disposition = ContentDisposition.builder("attachment").name("foo").filename("foo.txt").size(123L).build();
+		headers.setContentDisposition(disposition);
+		assertEquals("Invalid Content-Disposition header", disposition, headers.getContentDisposition());
 	}
 
 	@Test  // SPR-11917
@@ -427,18 +422,4 @@ public class HttpHeadersTests {
 		assertEquals(HttpMethod.POST, headers.getAccessControlRequestMethod());
 	}
 
-	@Test  // SPR-14547
-	public void encodeHeaderFieldParam() {
-		String result = HttpHeaders.encodeHeaderFieldParam("test.txt", StandardCharsets.US_ASCII);
-		assertEquals("test.txt", result);
-
-		result = HttpHeaders.encodeHeaderFieldParam("中文.txt", StandardCharsets.UTF_8);
-		assertEquals("UTF-8''%E4%B8%AD%E6%96%87.txt", result);
-	}
-
-	@Test(expected = IllegalArgumentException.class)
-	public void encodeHeaderFieldParamInvalidCharset() {
-		HttpHeaders.encodeHeaderFieldParam("test", StandardCharsets.UTF_16);
-	}
-
 }