Check supported locales in AcceptHeaderLocaleResolver

Issue: SPR-13330

Author: rstoyanchev

spring-webmvc/src/main/java/org/springframework/web/servlet/i18n/AcceptHeaderLocaleResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * 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.
@@ -16,6 +16,9 @@
 
 package org.springframework.web.servlet.i18n;
 
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.List;
 import java.util.Locale;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
@@ -31,14 +34,60 @@
  * can only be changed through changing the client's locale settings.
  *
  * @author Juergen Hoeller
+ * @author Rossen Stoyanchev
  * @since 27.02.2003
  * @see javax.servlet.http.HttpServletRequest#getLocale()
  */
 public class AcceptHeaderLocaleResolver implements LocaleResolver {
 
+	private final List<Locale> supportedLocales = new ArrayList<Locale>();
+
+
+	/**
+	 * Configure supported locales to check against the requested locales
+	 * determined via {@link HttpServletRequest#getLocales()}. If this is not
+	 * configured then {@link HttpServletRequest#getLocale()} is used instead.
+	 * @param locales the supported locales
+	 * @since 4.3
+	 */
+	public void setSupportedLocales(List<Locale> locales) {
+		this.supportedLocales.clear();
+		if (locales != null) {
+			this.supportedLocales.addAll(locales);
+		}
+	}
+
+	/**
+	 * Return the configured list of supported locales.
+	 * @since 4.3
+	 */
+	public List<Locale> getSupportedLocales() {
+		return this.supportedLocales;
+	}
+
+
 	@Override
 	public Locale resolveLocale(HttpServletRequest request) {
-		return request.getLocale();
+		Locale locale = request.getLocale();
+		if (!isSupportedLocale(locale)) {
+			locale = findSupportedLocale(request, locale);
+		}
+		return locale;
+	}
+
+	private boolean isSupportedLocale(Locale locale) {
+		return (getSupportedLocales().isEmpty() || getSupportedLocales().contains(locale));
+	}
+
+	private Locale findSupportedLocale(HttpServletRequest request, Locale fallback) {
+		Enumeration<Locale> requestLocales = request.getLocales();
+		while (requestLocales.hasMoreElements()) {
+			Locale locale = requestLocales.nextElement();
+			if (getSupportedLocales().contains(locale)) {
+				return locale;
+			}
+		}
+		return fallback;
 	}
 
 	@Override

spring-webmvc/src/test/java/org/springframework/web/servlet/i18n/AcceptHeaderLocaleResolverTests.java

@@ -0,0 +1,66 @@
+/*
+ * 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.web.servlet.i18n;
+
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.Locale;
+import javax.servlet.http.HttpServletRequest;
+
+import org.junit.Test;
+
+import org.springframework.mock.web.test.MockHttpServletRequest;
+
+import static java.util.Locale.CANADA;
+import static java.util.Locale.UK;
+import static java.util.Locale.US;
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Unit tests for {@link AcceptHeaderLocaleResolver}.
+ * @author Rossen Stoyanchev
+ */
+public class AcceptHeaderLocaleResolverTests {
+
+	private AcceptHeaderLocaleResolver resolver = new AcceptHeaderLocaleResolver();
+
+
+	@Test
+	public void resolve() throws Exception {
+		assertEquals(CANADA, this.resolver.resolveLocale(request(CANADA)));
+		assertEquals(US, this.resolver.resolveLocale(request(US, CANADA)));
+	}
+
+	@Test
+	public void resolvePreferredSupported() throws Exception {
+		this.resolver.setSupportedLocales(Collections.singletonList(CANADA));
+		assertEquals(CANADA, this.resolver.resolveLocale(request(US, CANADA)));
+	}
+
+	@Test
+	public void resolvePreferredNotSupported() throws Exception {
+		this.resolver.setSupportedLocales(Collections.singletonList(CANADA));
+		assertEquals(US, this.resolver.resolveLocale(request(US, UK)));
+	}
+
+
+	private HttpServletRequest request(Locale... locales) {
+		MockHttpServletRequest request = new MockHttpServletRequest();
+		request.setPreferredLocales(Arrays.asList(locales));
+		return request;
+	}
+
+}