Consistent warn logging without stacktrace in Portlet HandlerExceptionResolver

Issue: SPR-13611

Author: jhoeller

spring-webmvc-portlet/src/main/java/org/springframework/web/portlet/handler/AbstractHandlerExceptionResolver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 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.
@@ -39,6 +39,7 @@
  * and the {@link Ordered} implementation.
  *
  * @author Arjen Poutsma
+ * @author Juergen Hoeller
  * @since 3.0
  */
 public abstract class AbstractHandlerExceptionResolver implements HandlerExceptionResolver, Ordered {
@@ -67,40 +68,36 @@ public int getOrder() {
 	}
 
 	/**
-	 * Specify the set of handlers that this exception resolver should map.
-	 * The exception mappings and the default error view will only apply
-	 * to the specified handlers.
-	 * <p>If no handlers set, both the exception mappings and the default error
-	 * view will apply to all handlers. This means that a specified default
-	 * error view will be used as fallback for all exceptions; any further
-	 * HandlerExceptionResolvers in the chain will be ignored in this case.
+	 * Specify the set of handlers that this exception resolver should apply to.
+	 * <p>The exception mappings and the default error view will only apply to the specified handlers.
+	 * <p>If no handlers or handler classes are set, the exception mappings and the default error
+	 * view will apply to all handlers. This means that a specified default error view will be used
+	 * as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be
+	 * ignored in this case.
 	 */
 	public void setMappedHandlers(Set<?> mappedHandlers) {
 		this.mappedHandlers = mappedHandlers;
 	}
 
 	/**
 	 * Specify the set of classes that this exception resolver should apply to.
-	 * The exception mappings and the default error view will only apply
-	 * to handlers of the specified type; the specified types may be interfaces
-	 * and superclasses of handlers as well.
-	 * <p>If no handlers and handler classes are set, the exception mappings
-	 * and the default error view will apply to all handlers. This means that
-	 * a specified default error view will be used as fallback for all exceptions;
-	 * any further HandlerExceptionResolvers in the chain will be ignored in
-	 * this case.
+	 * <p>The exception mappings and the default error view will only apply to handlers of the
+	 * specified types; the specified types may be interfaces or superclasses of handlers as well.
+	 * <p>If no handlers or handler classes are set, the exception mappings and the default error
+	 * view will apply to all handlers. This means that a specified default error view will be used
+	 * as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be
+	 * ignored in this case.
 	 */
-	public void setMappedHandlerClasses(Class<?>[] mappedHandlerClasses) {
+	public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses) {
 		this.mappedHandlerClasses = mappedHandlerClasses;
 	}
 
 	/**
-	 * Set the log category for warn logging. The name will be passed to the
-	 * underlying logger implementation through Commons Logging, getting
-	 * interpreted as log category according to the logger's configuration.
-	 * <p>Default is no warn logging. Specify this setting to activate
-	 * warn logging into a specific category. Alternatively, override
-	 * the {@link #logException} method for custom logging.
+	 * Set the log category for warn logging. The name will be passed to the underlying logger
+	 * implementation through Commons Logging, getting interpreted as a log category according
+	 * to the logger's configuration.
+	 * <p>Default is no warn logging. Specify this setting to activate warn logging into a specific
+	 * category. Alternatively, override the {@link #logException} method for custom logging.
 	 * @see org.apache.commons.logging.LogFactory#getLog(String)
 	 * @see org.apache.log4j.Logger#getLogger(String)
 	 * @see java.util.logging.Logger#getLogger(String)
@@ -183,8 +180,7 @@ protected boolean shouldApplyTo(PortletRequest request, Object handler) {
 	/**
 	 * Log the given exception at warn level, provided that warn logging has been
 	 * activated through the {@link #setWarnLogCategory "warnLogCategory"} property.
-	 * <p>Calls {@link #buildLogMessage} in order to determine the concrete message
-	 * to log. Always passes the full exception to the logger.
+	 * <p>Calls {@link #buildLogMessage} in order to determine the concrete message to log.
 	 * @param ex the exception that got thrown during handler execution
 	 * @param request current portlet request (useful for obtaining metadata)
 	 * @see #setWarnLogCategory
@@ -193,19 +189,18 @@ protected boolean shouldApplyTo(PortletRequest request, Object handler) {
 	 */
 	protected void logException(Exception ex, PortletRequest request) {
 		if (this.warnLogger != null && this.warnLogger.isWarnEnabled()) {
-			this.warnLogger.warn(buildLogMessage(ex, request), ex);
+			this.warnLogger.warn(buildLogMessage(ex, request));
 		}
 	}
 
 	/**
-	 * Build a log message for the given exception, occured during processing
-	 * the given request.
+	 * Build a log message for the given exception, occurred during processing the given request.
 	 * @param ex the exception that got thrown during handler execution
 	 * @param request current portlet request (useful for obtaining metadata)
 	 * @return the log message to use
 	 */
 	protected String buildLogMessage(Exception ex, PortletRequest request) {
-		return "Handler execution resulted in exception";
+		return "Handler execution resulted in exception: " + ex;
 	}
 
 

spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerExceptionResolver.java

@@ -88,7 +88,7 @@ public void setMappedHandlers(Set<?> mappedHandlers) {
 	 * as a fallback for all exceptions; any further HandlerExceptionResolvers in the chain will be
 	 * ignored in this case.
 	 */
-	public void setMappedHandlerClasses(Class<?>[] mappedHandlerClasses) {
+	public void setMappedHandlerClasses(Class<?>... mappedHandlerClasses) {
 		this.mappedHandlerClasses = mappedHandlerClasses;
 	}
 
@@ -116,6 +116,7 @@ public void setPreventResponseCaching(boolean preventResponseCaching) {
 		this.preventResponseCaching = preventResponseCaching;
 	}
 
+
 	/**
 	 * Check whether this resolver is supposed to apply (i.e. if the supplied handler
 	 * matches any of the configured {@linkplain #setMappedHandlers handlers} or
@@ -220,6 +221,7 @@ protected void preventCaching(HttpServletResponse response) {
 		response.addHeader(HEADER_CACHE_CONTROL, "no-store");
 	}
 
+
 	/**
 	 * Actually resolve the given exception that got thrown during handler execution,
 	 * returning a {@link ModelAndView} that represents a specific error page if appropriate.