Consistent trace log messages and general polishing

(cherry picked from commit 5626384)

Author: jhoeller

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -41,25 +41,26 @@ public Resource resolveResource(HttpServletRequest request, String requestPath,
 			List<? extends Resource> locations, ResourceResolverChain chain) {
 
 		if (logger.isTraceEnabled()) {
-			logger.trace("Resolving resource: requestPath=\"" + requestPath + "\"");
+			logger.trace("Resolving resource for request path \"" + requestPath + "\"");
 		}
 		return resolveResourceInternal(request, requestPath, locations, chain);
 	}
 
-	protected abstract Resource resolveResourceInternal(HttpServletRequest request, String requestPath,
-			List<? extends Resource> locations, ResourceResolverChain chain);
-
 	@Override
 	public String resolveUrlPath(String resourceUrlPath, List<? extends Resource> locations,
 			ResourceResolverChain chain) {
 
 		if (logger.isTraceEnabled()) {
-			logger.trace("Resolving public URL for path=\"" + resourceUrlPath + "\"");
+			logger.trace("Resolving public URL for resource path \"" + resourceUrlPath + "\"");
 		}
 
 		return resolveUrlPathInternal(resourceUrlPath, locations, chain);
 	}
 
+
+	protected abstract Resource resolveResourceInternal(HttpServletRequest request, String requestPath,
+			List<? extends Resource> locations, ResourceResolverChain chain);
+
 	protected abstract String resolveUrlPathInternal(String resourceUrlPath,
 			List<? extends Resource> locations, ResourceResolverChain chain);
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -20,7 +20,7 @@
 import java.io.IOException;
 import java.io.StringWriter;
 import java.nio.charset.Charset;
-import java.util.Arrays;
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Scanner;
@@ -97,9 +97,7 @@ public Resource transform(HttpServletRequest request, Resource resource, Resourc
 			throws IOException {
 
 		resource = transformerChain.transform(request, resource);
-
-		String filename = resource.getFilename();
-		if (!this.fileExtension.equals(StringUtils.getFilenameExtension(filename))) {
+		if (!this.fileExtension.equals(StringUtils.getFilenameExtension(resource.getFilename()))) {
 			return resource;
 		}
 
@@ -138,7 +136,7 @@ public Resource transform(HttpServletRequest request, Resource resource, Resourc
 		String hash = hashBuilder.build();
 		contentWriter.write("\n" + "# Hash: " + hash);
 		if (logger.isTraceEnabled()) {
-			logger.trace("AppCache file: [" + resource.getFilename()+ "] Hash: [" + hash + "]");
+			logger.trace("AppCache file: [" + resource.getFilename()+ "] hash: [" + hash + "]");
 		}
 
 		return new TransformedResource(resource, contentWriter.toString().getBytes(DEFAULT_CHARSET));
@@ -170,15 +168,16 @@ public String transform(String line, HashBuilder builder, Resource resource,
 
 	private class CacheSection implements SectionTransformer {
 
-		private final String COMMENT_DIRECTIVE = "#";
+		private static final String COMMENT_DIRECTIVE = "#";
 
 		@Override
 		public String transform(String line, HashBuilder builder, Resource resource,
 				ResourceTransformerChain transformerChain, HttpServletRequest request) throws IOException {
 
 			if (isLink(line) && !hasScheme(line)) {
 				ResourceResolverChain resolverChain = transformerChain.getResolverChain();
-				Resource appCacheResource = resolverChain.resolveResource(null, line, Arrays.asList(resource));
+				Resource appCacheResource =
+						resolverChain.resolveResource(null, line, Collections.singletonList(resource));
 				String path = resolveUrlPath(line, request, resource, transformerChain);
 				builder.appendResource(appCacheResource);
 				if (logger.isTraceEnabled()) {

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

@@ -42,22 +42,25 @@ public class CachingResourceResolver extends AbstractResourceResolver {
 
 	private final Cache cache;
 
+
 	public CachingResourceResolver(CacheManager cacheManager, String cacheName) {
 		this(cacheManager.getCache(cacheName));
 	}
 
 	public CachingResourceResolver(Cache cache) {
-		Assert.notNull(cache, "'cache' is required");
+		Assert.notNull(cache, "Cache is required");
 		this.cache = cache;
 	}
 
+
 	/**
 	 * Return the configured {@code Cache}.
 	 */
 	public Cache getCache() {
 		return this.cache;
 	}
 
+
 	@Override
 	protected Resource resolveResourceInternal(HttpServletRequest request, String requestPath,
 			List<? extends Resource> locations, ResourceResolverChain chain) {
@@ -67,15 +70,15 @@ protected Resource resolveResourceInternal(HttpServletRequest request, String re
 
 		if (resource != null) {
 			if (logger.isTraceEnabled()) {
-				logger.trace("Found match");
+				logger.trace("Found match: " + resource);
 			}
 			return resource;
 		}
 
 		resource = chain.resolveResource(request, requestPath, locations);
 		if (resource != null) {
 			if (logger.isTraceEnabled()) {
-				logger.trace("Putting resolved resource in cache");
+				logger.trace("Putting resolved resource in cache: " + resource);
 			}
 			this.cache.put(key, resource);
 		}
@@ -104,15 +107,15 @@ protected String resolveUrlPathInternal(String resourceUrlPath,
 
 		if (resolvedUrlPath != null) {
 			if (logger.isTraceEnabled()) {
-				logger.trace("Found match");
+				logger.trace("Found match: \"" + resolvedUrlPath + "\"");
 			}
 			return resolvedUrlPath;
 		}
 
 		resolvedUrlPath = chain.resolveUrlPath(resourceUrlPath, locations);
 		if (resolvedUrlPath != null) {
 			if (logger.isTraceEnabled()) {
-				logger.trace("Putting resolved resource URL path in cache");
+				logger.trace("Putting resolved resource URL path in cache: \"" + resolvedUrlPath + "\"");
 			}
 			this.cache.put(key, resolvedUrlPath);
 		}

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

@@ -42,12 +42,13 @@ public class CachingResourceTransformer implements ResourceTransformer {
 
 	private final Cache cache;
 
+
 	public CachingResourceTransformer(CacheManager cacheManager, String cacheName) {
 		this(cacheManager.getCache(cacheName));
 	}
 
 	public CachingResourceTransformer(Cache cache) {
-		Assert.notNull(cache, "'cache' is required");
+		Assert.notNull(cache, "Cache is required");
 		this.cache = cache;
 	}
 
@@ -59,22 +60,23 @@ public Cache getCache() {
 		return this.cache;
 	}
 
+
 	@Override
 	public Resource transform(HttpServletRequest request, Resource resource, ResourceTransformerChain transformerChain)
 			throws IOException {
 
 		Resource transformed = this.cache.get(resource, Resource.class);
 		if (transformed != null) {
 			if (logger.isTraceEnabled()) {
-				logger.trace("Found match");
+				logger.trace("Found match: " + transformed);
 			}
 			return transformed;
 		}
 
 		transformed = transformerChain.transform(request, resource);
 
 		if (logger.isTraceEnabled()) {
-			logger.trace("Putting transformed resource in cache");
+			logger.trace("Putting transformed resource in cache: " + transformed);
 		}
 		this.cache.put(resource, transformed);
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.web.servlet.resource;
 
 import java.io.IOException;
@@ -33,20 +34,18 @@
  */
 public class ContentVersionStrategy extends AbstractVersionStrategy {
 
-
 	public ContentVersionStrategy() {
 		super(new FileNameVersionPathStrategy());
 	}
 
-
 	@Override
 	public String getResourceVersion(Resource resource) {
 		try {
 			byte[] content = FileCopyUtils.copyToByteArray(resource.getInputStream());
 			return DigestUtils.md5DigestAsHex(content);
 		}
 		catch (IOException ex) {
-			throw new IllegalStateException("Failed to calculate hash for resource [" + resource + "]", ex);
+			throw new IllegalStateException("Failed to calculate hash for " + resource, ex);
 		}
 	}
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -23,7 +23,6 @@
 import org.springframework.core.io.Resource;
 import org.springframework.util.Assert;
 
-
 /**
  * A default implementation of {@link ResourceResolverChain} for invoking a list
  * of {@link ResourceResolver}s.
@@ -53,6 +52,7 @@ public Resource resolveResource(HttpServletRequest request, String requestPath,
 		if (resolver == null) {
 			return null;
 		}
+
 		try {
 			return resolver.resolveResource(request, requestPath, locations, this);
 		}
@@ -67,6 +67,7 @@ public String resolveUrlPath(String resourcePath, List<? extends Resource> locat
 		if (resolver == null) {
 			return null;
 		}
+
 		try {
 			return resolver.resolveUrlPath(resourcePath, locations, this);
 		}
@@ -76,7 +77,6 @@ public String resolveUrlPath(String resourcePath, List<? extends Resource> locat
 	}
 
 	private ResourceResolver getNext() {
-
 		Assert.state(this.index <= this.resolvers.size(),
 				"Current index exceeds the number of configured ResourceResolver's");
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -25,8 +25,8 @@
 import org.springframework.util.Assert;
 
 /**
- * A default implementation of {@link ResourceTransformerChain} for invoking a list
- * of {@link ResourceTransformer}s.
+ * A default implementation of {@link ResourceTransformerChain} for invoking
+ * a list of {@link ResourceTransformer}s.
  *
  * @author Rossen Stoyanchev
  * @since 4.1
@@ -39,10 +39,11 @@ class DefaultResourceTransformerChain implements ResourceTransformerChain {
 
 	private int index = -1;
 
+
 	public DefaultResourceTransformerChain(ResourceResolverChain resolverChain,
 			List<ResourceTransformer> transformers) {
 
-		Assert.notNull(resolverChain, "'resolverChain' is required");
+		Assert.notNull(resolverChain, "ResourceResolverChain is required");
 		this.resolverChain = resolverChain;
 		if (transformers != null) {
 			this.transformers.addAll(transformers);
@@ -54,12 +55,14 @@ public ResourceResolverChain getResolverChain() {
 		return this.resolverChain;
 	}
 
+
 	@Override
 	public Resource transform(HttpServletRequest request, Resource resource) throws IOException {
 		ResourceTransformer transformer = getNext();
 		if (transformer == null) {
 			return resource;
 		}
+
 		try {
 			return transformer.transform(request, resource, this);
 		}
@@ -69,7 +72,6 @@ public Resource transform(HttpServletRequest request, Resource resource) throws
 	}
 
 	private ResourceTransformer getNext() {
-
 		Assert.state(this.index <= this.transformers.size(),
 				"Current index exceeds the number of configured ResourceTransformer's");
 

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -117,7 +117,7 @@ public void handleRequest(HttpServletRequest request, HttpServletResponse respon
 		RequestDispatcher rd = this.servletContext.getNamedDispatcher(this.defaultServletName);
 		if (rd == null) {
 			throw new IllegalStateException("A RequestDispatcher could not be located for the default servlet '" +
-					this.defaultServletName +"'");
+					this.defaultServletName + "'");
 		}
 		rd.forward(request, response);
 	}

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -18,7 +18,6 @@
 
 import org.springframework.core.io.Resource;
 
-
 /**
  * Interface for a resource descriptor that describes the encoding
  * applied to the entire resource content.
@@ -39,6 +38,6 @@ public interface EncodedResource extends Resource {
 	 * @see <a href="http://tools.ietf.org/html/rfc7231#section-3.1.2.1">HTTP/1.1: Semantics
 	 * and Content, section 3.1.2.1</a>
 	 */
-	public String getContentEncoding();
+	String getContentEncoding();
 
 }

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2015 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.web.servlet.resource;
 
 import org.springframework.core.io.Resource;
@@ -34,6 +35,7 @@ public class FixedVersionStrategy extends AbstractVersionStrategy {
 
 	private final String version;
 
+
 	/**
 	 * Create a new FixedVersionStrategy with the given version string.
 	 * @param version the fixed version string to use