Set uri encoding to UTF-8 by default for Tomcat

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

@@ -43,6 +43,7 @@
  * {@link EmbeddedServletContainerCustomizerBeanPostProcessor} is active.
  * 
  * @author Dave Syer
+ * @author Stephane Nicoll
  */
 @ConfigurationProperties(name = "server", ignoreUnknownFields = false)
 public class ServerProperties implements EmbeddedServletContainerCustomizer {
@@ -144,6 +145,8 @@ public static class Tomcat {
 
 		private int maxThreads = 0; // Number of threads in protocol handler
 
+		private String uriEncoding;
+
 		public int getMaxThreads() {
 			return this.maxThreads;
 		}
@@ -200,6 +203,14 @@ public void setRemoteIpHeader(String remoteIpHeader) {
 			this.remoteIpHeader = remoteIpHeader;
 		}
 
+		public String getUriEncoding() {
+			return uriEncoding;
+		}
+
+		public void setUriEncoding(String uriEncoding) {
+			this.uriEncoding = uriEncoding;
+		}
+
 		void customizeTomcat(TomcatEmbeddedServletContainerFactory factory) {
 			if (getBasedir() != null) {
 				factory.setBaseDirectory(getBasedir());
@@ -247,6 +258,9 @@ public void customize(Connector connector) {
 				valve.setSuffix(".log");
 				factory.addContextValves(valve);
 			}
+			if (getUriEncoding() != null) {
+				factory.setUriEncoding(getUriEncoding());
+			}
 		}
 
 	}

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

@@ -36,6 +36,7 @@
  * Tests for {@link ServerProperties}.
  * 
  * @author Dave Syer
+ * @author Stephane Nicoll
  */
 public class ServerPropertiesTests {
 
@@ -87,4 +88,13 @@ public void testCustomizeTomcatPort() throws Exception {
 		verify(factory).setPort(8080);
 	}
 
+	@Test
+	public void testCustomizeUriEncoding() throws Exception {
+		Map<String, String> map = new HashMap<String, String>();
+		map.put("server.tomcat.uriEncoding", "US-ASCII");
+		new RelaxedDataBinder(this.properties, "server").bind(new MutablePropertyValues(
+				map));
+		assertEquals("US-ASCII", this.properties.getTomcat().getUriEncoding());
+	}
+
 }

spring-boot-docs/src/main/asciidoc/appendix-application-properties.adoc

@@ -61,6 +61,7 @@ server.tomcat.remote-ip-header=x-forwarded-for
 server.tomcat.basedir=/tmp # base dir (usually not needed, defaults to tmp)
 server.tomcat.background-processor-delay=30; # in seconds
 server.tomcat.max-threads = 0 # number of threads in protocol handler
+server.tomcat.uri-encoding = UTF-8 # character encoding to use for URL decoding
 
 # SPRING MVC ({sc-spring-boot-autoconfigure}/web/HttpMapperProperties.{sc-ext}[HttpMapperProperties])
 http.mappers.json-pretty-print=false # pretty print JSON

spring-boot/src/main/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactory.java

@@ -66,6 +66,7 @@
  * @author Phillip Webb
  * @author Dave Syer
  * @author Brock Mills
+ * @author Stephane Nicoll
  * @see #setPort(int)
  * @see #setContextLifecycleListeners(Collection)
  * @see TomcatEmbeddedServletContainer
@@ -93,6 +94,8 @@ public class TomcatEmbeddedServletContainerFactory extends
 
 	private String tldSkip;
 
+	private String uriEncoding = "UTF-8";
+
 	/**
 	 * Create a new {@link TomcatEmbeddedServletContainerFactory} instance.
 	 */
@@ -206,6 +209,10 @@ protected void customizeConnector(Connector connector) {
 						.setAddress(getAddress());
 			}
 		}
+		if (getUriEncoding() != null) {
+			connector.setURIEncoding(getUriEncoding());
+		}
+
 		// If ApplicationContext is slow to start we want Tomcat not to bind to the socket
 		// prematurely...
 		connector.setProperty("bindOnInit", "false");
@@ -455,6 +462,22 @@ public List<Connector> getAdditionalTomcatConnectors() {
 		return this.additionalTomcatConnectors;
 	}
 
+	/**
+	 * Set the character encoding to use for URL decoding. If not
+	 * specified 'UTF-8' will be used.
+	 * @param uriEncoding the uri encoding to set
+	 */
+	public void setUriEncoding(String uriEncoding) {
+		this.uriEncoding = uriEncoding;
+	}
+
+	/**
+	 * Returns the character encoding to use for URL decoding.
+	 */
+	public String getUriEncoding() {
+		return uriEncoding;
+	}
+
 	private static class TomcatErrorPage {
 
 		private final String location;

spring-boot/src/test/java/org/springframework/boot/context/embedded/tomcat/TomcatEmbeddedServletContainerFactoryTests.java

@@ -44,6 +44,7 @@
  * 
  * @author Phillip Webb
  * @author Dave Syer
+ * @author Stephane Nicoll
  */
 public class TomcatEmbeddedServletContainerFactoryTests extends
 		AbstractEmbeddedServletContainerFactoryTests {
@@ -190,11 +191,30 @@ public void addNullConnectorCustomizersThrows() {
 		factory.addConnectorCustomizers((TomcatConnectorCustomizer[]) null);
 	}
 
+	@Test
+	public void uriEncoding() throws Exception {
+		TomcatEmbeddedServletContainerFactory factory = getFactory();
+		factory.setUriEncoding("US-ASCII");
+		Tomcat tomcat = getTomcat(factory);
+		assertEquals("US-ASCII", tomcat.getConnector().getURIEncoding());
+	}
+
+	@Test
+	public void defaultUriEncoding() throws Exception {
+		TomcatEmbeddedServletContainerFactory factory = getFactory();
+		Tomcat tomcat = getTomcat(factory);
+		assertEquals("UTF-8", tomcat.getConnector().getURIEncoding());
+	}
+
 	private void assertTimeout(TomcatEmbeddedServletContainerFactory factory, int expected) {
-		this.container = factory.getEmbeddedServletContainer();
-		Tomcat tomcat = ((TomcatEmbeddedServletContainer) this.container).getTomcat();
+		Tomcat tomcat = getTomcat(factory);
 		Context context = (Context) tomcat.getHost().findChildren()[0];
 		assertThat(context.getSessionTimeout(), equalTo(expected));
 	}
 
+	private Tomcat getTomcat(TomcatEmbeddedServletContainerFactory factory) {
+		this.container = factory.getEmbeddedServletContainer();
+		return ((TomcatEmbeddedServletContainer) this.container).getTomcat();
+	}
+
 }