Polish MultipartConfigElement support

Polish MultipartConfigElement changes introduced in commit e8e59ea6
as follows:

- Fix javadoc formatting
- Fix tab/spaces formatting
- Fix asciidoc formatting
- Move creation of MultipartConfigElement into MultipartProperties
- Add @Since tags
- Restore random port in tests

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java

@@ -25,11 +25,9 @@ import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.embedded.EmbeddedWebApplicationContext;
-import org.springframework.boot.context.embedded.MultipartConfigFactory;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.util.StringUtils;
 import org.springframework.web.multipart.support.StandardServletMultipartResolver;
 
 /**
@@ -57,25 +55,7 @@ public class MultipartAutoConfiguration {
 	@Bean
 	@ConditionalOnMissingBean
 	public MultipartConfigElement multipartConfigElement() {
-		MultipartConfigFactory factory = new MultipartConfigFactory();
+		return this.multipartProperties.createMultipartConfig();
-
-		if (StringUtils.hasText(this.multipartProperties.getFileSizeThreshold())) {
-			factory.setFileSizeThreshold(this.multipartProperties.getFileSizeThreshold());
-		}
-
-		if (StringUtils.hasText(this.multipartProperties.getLocation())) {
-			factory.setLocation(this.multipartProperties.getLocation());
-		}
-
-		if (StringUtils.hasText(this.multipartProperties.getMaxRequestSize())) {
-			factory.setMaxRequestSize(this.multipartProperties.getMaxRequestSize());
-		}
-
-		if (StringUtils.hasText(this.multipartProperties.getMaxFileSize())) {
-			factory.setMaxFileSize(this.multipartProperties.getMaxFileSize());
-		}
-
-		return factory.createMultipartConfig();
 	}
 
 	@Bean
@@ -83,4 +63,5 @@ public class MultipartAutoConfiguration {
 	public StandardServletMultipartResolver multipartResolver() {
 		return new StandardServletMultipartResolver();
 	}
+
 }

spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartProperties.java

@@ -16,48 +16,62 @@
 
 package org.springframework.boot.autoconfigure.web;
 
+import javax.servlet.MultipartConfigElement;
+
+import org.springframework.boot.context.embedded.MultipartConfigFactory;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.util.StringUtils;
 
 /**
- * Properties to be used in configuring
+ * Properties to be used in configuring a {@link MultipartConfigElement}.
- * a <A href="http://docs.oracle.com/javaee/6/api/javax/servlet/MultipartConfigElement.html">javax.servlet.MultipartConfigElement</a>.
+ * <ul>
- * <p/>
+ * <li>{@literal multipart.location} specifies the directory where files will be stored.
- * {@literal multipart.fileSizeThreshold} specifies the size threshold after which files will be written to disk. Default is 0, which means that the file will be written to disk immediately.
+ * The default is "". A common value is to use the system's temporary directory, which can
- * {@literal multipart.location} specifies the directory where files will be stored. The default is "". A common value is to use the system's temporary directory, which can be obtained
+ * be obtained.</li>
- * {@literal multipart.maxFileSize} specifies the maximum size permitted for uploaded files. The default is unlimited.
+ * <li>{@literal multipart.maxFileSize} specifies the maximum size permitted for uploaded
- * {@literal multipart.maxRequestSize} specifies the maximum size allowed for {@literal multipart/form-data} requests.
+ * files. The default is 1Mb.</li>
- * <p/>
+ * <li>
- * These properties are ultimately passed through {@link org.springframework.boot.context.embedded.MultipartConfigFactory}
+ * {@literal multipart.maxRequestSize} specifies the maximum size allowed for
- * which means you may specify the values using {@literal long} values or using more readable {@literal String}
+ * {@literal multipart/form-data} requests. The default is 10Mb</li>
- * variants that accept {@literal KB} or {@literal MB} suffixes.
+ * <li>
+ * {@literal multipart.fileSizeThreshold} specifies the size threshold after which files
+ * will be written to disk. Default is 0, which means that the file will be written to
+ * disk immediately.</li>
+ * </ul>
+ * <p>
+ * These properties are ultimately passed through
+ * {@link org.springframework.boot.context.embedded.MultipartConfigFactory} which means
+ * you may specify the values using {@literal long} values or using more readable
+ * {@literal String} variants that accept {@literal Kb} or {@literal Mb} suffixes.
  * 
  * @author Josh Long
+ * @since 1.1.0
  */
 @ConfigurationProperties(prefix = "multipart", ignoreUnknownFields = false)
 public class MultipartProperties {
 
+	private String location;
+
 	private String maxFileSize = "1Mb";
 
 	private String maxRequestSize = "10Mb";
 
-    private String fileSizeThreshold = null;
+	private String fileSizeThreshold = "0";
-
-    private String location = null;
 
 	public String getMaxFileSize() {
-        return maxFileSize;
+		return this.maxFileSize;
 	}
 
 	public String getMaxRequestSize() {
-        return maxRequestSize;
+		return this.maxRequestSize;
 	}
 
 	public String getFileSizeThreshold() {
-        return fileSizeThreshold;
+		return this.fileSizeThreshold;
 	}
 
 	public String getLocation() {
-        return location;
+		return this.location;
 	}
 
 	public void setMaxFileSize(String maxFileSize) {
@@ -76,5 +90,25 @@ public class MultipartProperties {
 		this.fileSizeThreshold = fileSizeThreshold;
 	}
 
-}
+	/**
+	 * Create a new {@link MultipartConfigElement} using the
+	 * @return a new {@link MultipartConfigElement} configured using there properties
+	 */
+	public MultipartConfigElement createMultipartConfig() {
+		MultipartConfigFactory factory = new MultipartConfigFactory();
+		if (StringUtils.hasText(this.fileSizeThreshold)) {
+			factory.setFileSizeThreshold(this.fileSizeThreshold);
+		}
+		if (StringUtils.hasText(this.location)) {
+			factory.setLocation(this.location);
+		}
+		if (StringUtils.hasText(this.maxRequestSize)) {
+			factory.setMaxRequestSize(this.maxRequestSize);
+		}
+		if (StringUtils.hasText(this.maxFileSize)) {
+			factory.setMaxFileSize(this.maxFileSize);
+		}
+		return factory.createMultipartConfig();
+	}
 
+}

spring-boot-autoconfigure/src/test/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfigurationTests.java

@@ -38,10 +38,12 @@ import org.springframework.web.multipart.support.StandardServletMultipartResolve
 import org.springframework.web.servlet.DispatcherServlet;
 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 
+import static org.hamcrest.Matchers.equalTo;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertThat;
 
 /**
  * Tests for {@link MultipartAutoConfiguration}. Tests an empty configuration, no
@@ -71,10 +73,10 @@ public class MultipartAutoConfigurationTests {
 				ContainerWithNothing.class, BaseConfiguration.class);
 		DispatcherServlet servlet = this.context.getBean(DispatcherServlet.class);
 		assertNotNull(servlet.getMultipartResolver());
-		assertEquals(1,
+		assertThat(this.context.getBeansOfType(StandardServletMultipartResolver.class)
-				this.context.getBeansOfType(StandardServletMultipartResolver.class)
+				.size(), equalTo(1));
-						.size());
+		assertThat(this.context.getBeansOfType(MultipartResolver.class).size(),
-		assertEquals(1, this.context.getBeansOfType(MultipartResolver.class).size());
+				equalTo(1));
 	}
 
 	@Configuration
@@ -87,10 +89,10 @@ public class MultipartAutoConfigurationTests {
 				ContainerWithNoMultipartJetty.class, BaseConfiguration.class);
 		DispatcherServlet servlet = this.context.getBean(DispatcherServlet.class);
 		assertNotNull(servlet.getMultipartResolver());
-		assertEquals(1,
+		assertThat(this.context.getBeansOfType(StandardServletMultipartResolver.class)
-				this.context.getBeansOfType(StandardServletMultipartResolver.class)
+				.size(), equalTo(1));
-						.size());
+		assertThat(this.context.getBeansOfType(MultipartResolver.class).size(),
-		assertEquals(1, this.context.getBeansOfType(MultipartResolver.class).size());
+				equalTo(1));
 		verifyServletWorks();
 	}
 
@@ -113,10 +115,10 @@ public class MultipartAutoConfigurationTests {
 				ContainerWithNoMultipartTomcat.class, BaseConfiguration.class);
 		DispatcherServlet servlet = this.context.getBean(DispatcherServlet.class);
 		assertNull(servlet.getMultipartResolver());
-		assertEquals(1,
+		assertThat(this.context.getBeansOfType(StandardServletMultipartResolver.class)
-				this.context.getBeansOfType(StandardServletMultipartResolver.class)
+				.size(), equalTo(1));
-						.size());
+		assertThat(this.context.getBeansOfType(MultipartResolver.class).size(),
-		assertEquals(1, this.context.getBeansOfType(MultipartResolver.class).size());
+				equalTo(1));
 		verifyServletWorks();
 	}
 
@@ -134,7 +136,9 @@ public class MultipartAutoConfigurationTests {
 	public void containerWithAutomatedMultipartTomcatConfiguration() throws Exception {
 		this.context = new AnnotationConfigEmbeddedWebApplicationContext(
 				ContainerWithEverythingTomcat.class, BaseConfiguration.class);
-		new RestTemplate().getForObject("http://localhost:8080/", String.class);
+		new RestTemplate().getForObject("http://localhost:"
+				+ this.context.getEmbeddedServletContainer().getPort() + "/",
+				String.class);
 		this.context.getBean(MultipartConfigElement.class);
 		assertSame(this.context.getBean(DispatcherServlet.class).getMultipartResolver(),
 				this.context.getBean(StandardServletMultipartResolver.class));
@@ -149,8 +153,9 @@ public class MultipartAutoConfigurationTests {
 				.addFirst(new PropertySource<Object>("test") {
 					@Override
 					public Object getProperty(String name) {
-						if (name.toLowerCase().contains("multipart.enabled"))
+						if (name.toLowerCase().contains("multipart.enabled")) {
 							return "false";
+						}
 						return null;
 					}
 				});
@@ -162,8 +167,9 @@ public class MultipartAutoConfigurationTests {
 
 	private void verifyServletWorks() {
 		RestTemplate restTemplate = new RestTemplate();
-		assertEquals(restTemplate.getForObject("http://localhost:8080/", String.class),
+		assertEquals(restTemplate.getForObject("http://localhost:"
-				"Hello");
+				+ this.context.getEmbeddedServletContainer().getPort() + "/",
+				String.class), "Hello");
 	}
 
 	@Configuration
@@ -172,6 +178,13 @@ public class MultipartAutoConfigurationTests {
 			ServerPropertiesAutoConfiguration.class })
 	protected static class BaseConfiguration {
 
+		@Bean
+		public ServerProperties serverProperties() {
+			ServerProperties properties = new ServerProperties();
+			properties.setPort(0);
+			return properties;
+		}
+
 	}
 
 	@Configuration
@@ -186,10 +199,12 @@ public class MultipartAutoConfigurationTests {
 		WebController controller() {
 			return new WebController();
 		}
+
 	}
 
 	@Configuration
 	public static class ContainerWithEverythingJetty {
+
 		@Bean
 		MultipartConfigElement multipartConfigElement() {
 			return new MultipartConfigElement("");
@@ -204,11 +219,13 @@ public class MultipartAutoConfigurationTests {
 		WebController webController() {
 			return new WebController();
 		}
+
 	}
 
 	@Configuration
 	@EnableWebMvc
 	public static class ContainerWithEverythingTomcat {
+
 		@Bean
 		MultipartConfigElement multipartConfigElement() {
 			return new MultipartConfigElement("");
@@ -223,14 +240,18 @@ public class MultipartAutoConfigurationTests {
 		WebController webController() {
 			return new WebController();
 		}
+
 	}
 
 	@Controller
 	public static class WebController {
+
 		@RequestMapping("/")
-		public @ResponseBody String index() {
+		@ResponseBody
+		public String index() {
 			return "Hello";
 		}
+
 	}
 
 }

spring-boot-docs/src/main/asciidoc/howto.adoc

@@ -726,22 +726,24 @@ then you can take control completely and do everything manually using
 See the {sc-spring-boot-autoconfigure}/web/WebMvcAutoConfiguration.{sc-ext}[`WebMvcAutoConfiguration`]
 source code for more details.
 
+
+
 [[howto-multipart-file-upload-configuration]]
 === Handling Multipart File Uploads
-Spring Boot embraces the Servlet 3 `javax.servlet.http.Part` API to support uploading files. By default
+Spring Boot embraces the Servlet 3 `javax.servlet.http.Part` API to support uploading
-Spring Boot configures Spring MVC with a maximum file of 1Mb per
+files. By default Spring Boot configures Spring MVC with a maximum file of 1Mb per
-file and a maximum of 10Mb of file data in a single request. You may override these values, as well as the location
+file and a maximum of 10Mb of file data in a single request. You may override these
-to which intermediate data is stored (e.g., to the `/tmp` directory) and the threshold past which data is flushed to
+values, as well as the location to which intermediate data is stored (e.g., to the `/tmp`
-disk by using the properties exposed in the `MultipartAutoConfiguration` class. If you want to specify that files be unlimited,
+directory) and the threshold past which data is flushed to disk by using the properties
-for example, set the `multipart.maxFileSize` property to `-1`.
+exposed in the `MultipartProperties` class. If you want to specify that files be
-
+unlimited, for example, set the `multipart.maxFileSize` property to `-1`.
-The multipart support is helpful when you want to receive multipart encoded file data as a `@RequestParam`-annotated
- parameter of  type `MultipartFile` in a Spring MVC controller handler method.
-
-See the {sc-spring-boot-autoconfigure}/web/MultipartAutoConfiguration.{sc-ext}[`MultipartAutoConfiguration`] source for more details.
-
 
+The multipart support is helpful when you want to receive multipart encoded file data as
+a `@RequestParam`-annotated parameter of  type `MultipartFile` in a Spring MVC controller
+handler method.
 
+See the {sc-spring-boot-autoconfigure}/web/MultipartAutoConfiguration.{sc-ext}[`MultipartAutoConfiguration`] s
+ource for more details.