Configurable UrlPathHelper in PathExtensionContentNegotiationStrategy

This commit also aligns ResourceUrlProvider's and RequestMappingInfo's UrlPathHelper setter/getter signatures.

Issue: SPR-14454

Author: jhoeller

spring-web/src/main/java/org/springframework/web/accept/PathExtensionContentNegotiationStrategy.java

@@ -52,42 +52,46 @@
  * @author Rossen Stoyanchev
  * @since 3.2
  */
-public class PathExtensionContentNegotiationStrategy
-		extends AbstractMappingContentNegotiationStrategy {
-
-	private static final Log logger = LogFactory.getLog(PathExtensionContentNegotiationStrategy.class);
+public class PathExtensionContentNegotiationStrategy extends AbstractMappingContentNegotiationStrategy {
 
 	private static final boolean JAF_PRESENT = ClassUtils.isPresent("javax.activation.FileTypeMap",
 			PathExtensionContentNegotiationStrategy.class.getClassLoader());
 
-	private static final UrlPathHelper PATH_HELPER = new UrlPathHelper();
-
-	static {
-		PATH_HELPER.setUrlDecode(false);
-	}
+	private static final Log logger = LogFactory.getLog(PathExtensionContentNegotiationStrategy.class);
 
+	private UrlPathHelper urlPathHelper = new UrlPathHelper();
 
 	private boolean useJaf = true;
 
 	private boolean ignoreUnknownExtensions = true;
 
 
+	/**
+	 * Create an instance without any mappings to start with. Mappings may be added
+	 * later on if any extensions are resolved through the Java Activation framework.
+	 */
+	public PathExtensionContentNegotiationStrategy() {
+		this(null);
+	}
+
 	/**
 	 * Create an instance with the given map of file extensions and media types.
 	 */
 	public PathExtensionContentNegotiationStrategy(Map<String, MediaType> mediaTypes) {
 		super(mediaTypes);
+		this.urlPathHelper.setUrlDecode(false);
 	}
 
+
 	/**
-	 * Create an instance without any mappings to start with. Mappings may be added
-	 * later on if any extensions are resolved through the Java Activation framework.
+	 * Configure a {@code UrlPathHelper} to use in {@link #getMediaTypeKey}
+	 * in order to derive the lookup path for a target request URL path.
+	 * @since 4.2.8
 	 */
-	public PathExtensionContentNegotiationStrategy() {
-		super(null);
+	public void setUrlPathHelper(UrlPathHelper urlPathHelper) {
+		this.urlPathHelper = urlPathHelper;
 	}
 
-
 	/**
 	 * Whether to use the Java Activation Framework to look up file extensions.
 	 * <p>By default this is set to "true" but depends on JAF being present.
@@ -113,7 +117,7 @@ protected String getMediaTypeKey(NativeWebRequest webRequest) {
 			logger.warn("An HttpServletRequest is required to determine the media type key");
 			return null;
 		}
-		String path = PATH_HELPER.getLookupPathForRequest(request);
+		String path = this.urlPathHelper.getLookupPathForRequest(request);
 		String filename = WebUtils.extractFullFilenameFromUrlPath(path);
 		String extension = StringUtils.getFilenameExtension(filename);
 		return (StringUtils.hasText(extension)) ? extension.toLowerCase(Locale.ENGLISH) : null;

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/RequestMappingInfo.java

@@ -523,11 +523,15 @@ public static class BuilderConfiguration {
 		/**
 		 * Set a custom UrlPathHelper to use for the PatternsRequestCondition.
 		 * <p>By default this is not set.
+		 * @since 4.2.8
 		 */
-		public void setPathHelper(UrlPathHelper pathHelper) {
+		public void setUrlPathHelper(UrlPathHelper pathHelper) {
 			this.urlPathHelper = pathHelper;
 		}
 
+		/**
+		 * Return a custom UrlPathHelper to use for the PatternsRequestCondition, if any.
+		 */
 		public UrlPathHelper getUrlPathHelper() {
 			return this.urlPathHelper;
 		}
@@ -540,39 +544,48 @@ public void setPathMatcher(PathMatcher pathMatcher) {
 			this.pathMatcher = pathMatcher;
 		}
 
+		/**
+		 * Return a custom PathMatcher to use for the PatternsRequestCondition, if any.
+		 */
 		public PathMatcher getPathMatcher() {
 			return this.pathMatcher;
 		}
 
 		/**
-		 * Whether to apply trailing slash matching in PatternsRequestCondition.
+		 * Set whether to apply trailing slash matching in PatternsRequestCondition.
 		 * <p>By default this is set to 'true'.
 		 */
 		public void setTrailingSlashMatch(boolean trailingSlashMatch) {
 			this.trailingSlashMatch = trailingSlashMatch;
 		}
 
+		/**
+		 * Return whether to apply trailing slash matching in PatternsRequestCondition.
+		 */
 		public boolean useTrailingSlashMatch() {
 			return this.trailingSlashMatch;
 		}
 
 		/**
-		 * Whether to apply suffix pattern matching in PatternsRequestCondition.
+		 * Set whether to apply suffix pattern matching in PatternsRequestCondition.
 		 * <p>By default this is set to 'true'.
 		 * @see #setRegisteredSuffixPatternMatch(boolean)
 		 */
 		public void setSuffixPatternMatch(boolean suffixPatternMatch) {
 			this.suffixPatternMatch = suffixPatternMatch;
 		}
 
+		/**
+		 * Return whether to apply suffix pattern matching in PatternsRequestCondition.
+		 */
 		public boolean useSuffixPatternMatch() {
 			return this.suffixPatternMatch;
 		}
 
 		/**
-		 * Whether suffix pattern matching should be restricted to registered
+		 * Set whether suffix pattern matching should be restricted to registered
 		 * file extensions only. Setting this property also sets
-		 * suffixPatternMatch=true and requires that a
+		 * {@code suffixPatternMatch=true} and requires that a
 		 * {@link #setContentNegotiationManager} is also configured in order to
 		 * obtain the registered file extensions.
 		 */
@@ -581,6 +594,10 @@ public void setRegisteredSuffixPatternMatch(boolean registeredSuffixPatternMatch
 			this.suffixPatternMatch = (registeredSuffixPatternMatch || this.suffixPatternMatch);
 		}
 
+		/**
+		 * Return whether suffix pattern matching should be restricted to registered
+		 * file extensions only.
+		 */
 		public boolean useRegisteredSuffixPatternMatch() {
 			return this.registeredSuffixPatternMatch;
 		}
@@ -601,10 +618,14 @@ public List<String> getFileExtensions() {
 		 * Set the ContentNegotiationManager to use for the ProducesRequestCondition.
 		 * <p>By default this is not set.
 		 */
-		public void setContentNegotiationManager(ContentNegotiationManager manager) {
-			this.contentNegotiationManager = manager;
+		public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager) {
+			this.contentNegotiationManager = contentNegotiationManager;
 		}
 
+		/**
+		 * Return the ContentNegotiationManager to use for the ProducesRequestCondition,
+		 * if any.
+		 */
 		public ContentNegotiationManager getContentNegotiationManager() {
 			return this.contentNegotiationManager;
 		}

spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/method/annotation/RequestMappingHandlerMapping.java

@@ -118,7 +118,7 @@ public void setEmbeddedValueResolver(StringValueResolver resolver) {
 	@Override
 	public void afterPropertiesSet() {
 		this.config = new RequestMappingInfo.BuilderConfiguration();
-		this.config.setPathHelper(getUrlPathHelper());
+		this.config.setUrlPathHelper(getUrlPathHelper());
 		this.config.setPathMatcher(getPathMatcher());
 		this.config.setSuffixPatternMatch(this.useSuffixPatternMatch);
 		this.config.setTrailingSlashMatch(this.useTrailingSlashMatch);

spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceUrlEncodingFilter.java

@@ -27,6 +27,7 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.web.filter.OncePerRequestFilter;
+import org.springframework.web.util.UrlPathHelper;
 
 /**
  * A filter that wraps the {@link HttpServletResponse} and overrides its
@@ -96,13 +97,14 @@ private ResourceUrlProvider getResourceUrlProvider() {
 
 		private void initLookupPath(ResourceUrlProvider urlProvider) {
 			if (this.indexLookupPath == null) {
-				String requestUri = urlProvider.getPathHelper().getRequestUri(this.request);
-				String lookupPath = urlProvider.getPathHelper().getLookupPathForRequest(this.request);
+				UrlPathHelper pathHelper = urlProvider.getUrlPathHelper();
+				String requestUri = pathHelper.getRequestUri(this.request);
+				String lookupPath = pathHelper.getLookupPathForRequest(this.request);
 				this.indexLookupPath = requestUri.lastIndexOf(lookupPath);
 				this.prefixLookupPath = requestUri.substring(0, this.indexLookupPath);
 
 				if ("/".equals(lookupPath) && !"/".equals(requestUri)) {
-					String contextPath = urlProvider.getPathHelper().getContextPath(this.request);
+					String contextPath = pathHelper.getContextPath(this.request);
 					if (requestUri.equals(contextPath)) {
 						this.indexLookupPath = requestUri.length();
 						this.prefixLookupPath = requestUri;

spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceUrlProvider.java

@@ -51,7 +51,7 @@ public class ResourceUrlProvider implements ApplicationListener<ContextRefreshed
 
 	protected final Log logger = LogFactory.getLog(getClass());
 
-	private UrlPathHelper pathHelper = new UrlPathHelper();
+	private UrlPathHelper urlPathHelper = new UrlPathHelper();
 
 	private PathMatcher pathMatcher = new AntPathMatcher();
 
@@ -65,15 +65,16 @@ public class ResourceUrlProvider implements ApplicationListener<ContextRefreshed
 	 * {@link #getForRequestUrl(javax.servlet.http.HttpServletRequest, String)}
 	 * in order to derive the lookup path for a target request URL path.
 	 */
-	public void setUrlPathHelper(UrlPathHelper pathHelper) {
-		this.pathHelper = pathHelper;
+	public void setUrlPathHelper(UrlPathHelper urlPathHelper) {
+		this.urlPathHelper = urlPathHelper;
 	}
 
 	/**
 	 * Return the configured {@code UrlPathHelper}.
+	 * @since 4.2.8
 	 */
-	public UrlPathHelper getPathHelper() {
-		return this.pathHelper;
+	public UrlPathHelper getUrlPathHelper() {
+		return this.urlPathHelper;
 	}
 
 	/**
@@ -135,6 +136,7 @@ public void onApplicationEvent(ContextRefreshedEvent event) {
 		}
 	}
 
+
 	protected void detectResourceHandlers(ApplicationContext appContext) {
 		logger.debug("Looking for resource handler mappings");
 
@@ -158,7 +160,6 @@ protected void detectResourceHandlers(ApplicationContext appContext) {
 		}
 	}
 
-
 	/**
 	 * A variation on {@link #getForLookupPath(String)} that accepts a full request
 	 * URL path (i.e. including context and servlet path) and returns the full request
@@ -181,8 +182,9 @@ public final String getForRequestUrl(HttpServletRequest request, String requestU
 	}
 
 	private int getLookupPathIndex(HttpServletRequest request) {
-		String requestUri = getPathHelper().getRequestUri(request);
-		String lookupPath = getPathHelper().getLookupPathForRequest(request);
+		UrlPathHelper pathHelper = getUrlPathHelper();
+		String requestUri = pathHelper.getRequestUri(request);
+		String lookupPath = pathHelper.getLookupPathForRequest(request);
 		return requestUri.indexOf(lookupPath);
 	}