root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

SPR-5953 - Allow SimpleMappingExceptionResolver to Resolve HTTP Status Codes

This commit is contained in:
Arjen Poutsma 2009-07-29 12:57:56 +00:00
parent 2d4ae59ff1
commit 12e43ff92d
2 changed files with 110 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
org.springframework.web.servlet/src/main/java/org/springframework/web/servlet/handler/SimpleMappingExceptionResolver.java
View File

@ -18,11 +18,15 @@ package org.springframework.web.servlet.handler;
import java.util.Enumeration; import java.util.Enumeration;
import java.util.Properties; import java.util.Properties;
import java.util.Map;
import java.util.Iterator;
import java.util.HashMap;
import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView; import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.util.WebUtils; import org.springframework.web.util.WebUtils;
import org.springframework.util.CollectionUtils;
/** /**
* {@link org.springframework.web.servlet.HandlerExceptionResolver} implementation that allows for mapping exception * {@link org.springframework.web.servlet.HandlerExceptionResolver} implementation that allows for mapping exception
@ -47,6 +51,8 @@ public class SimpleMappingExceptionResolver extends AbstractHandlerExceptionReso
private Integer defaultStatusCode; private Integer defaultStatusCode;
private Map<String, Integer> statusCodes = new HashMap<String, Integer>();
private String exceptionAttribute = DEFAULT_EXCEPTION_ATTRIBUTE; private String exceptionAttribute = DEFAULT_EXCEPTION_ATTRIBUTE;
/** /**
@ -77,14 +83,37 @@ public class SimpleMappingExceptionResolver extends AbstractHandlerExceptionReso
} }
/** /**
* Set the default HTTP status code that this exception resolver will apply if it resolves an error view. <p>Note that * Set the HTTP status code that this exception resolver will apply for a given resolved error view. Keys are
* this error code will only get applied in case of a top-level request. It will not be set for an include request, * view names; values are status codes.
* since the HTTP status cannot be modified from within an include. <p>If not specified, no status code will be
* applied, either leaving this to the controller or view, or keeping the servlet engine's default of 200 (OK).
* *
* @param defaultStatusCode HTTP status code value, for example 500 (SC_INTERNAL_SERVER_ERROR) or 404 (SC_NOT_FOUND) * <p>Note that this error code will only get applied in case of a top-level request. It will not be set for an include
* @see javax.servlet.http.HttpServletResponse#SC_INTERNAL_SERVER_ERROR * request, since the HTTP status cannot be modified from within an include.
* @see javax.servlet.http.HttpServletResponse#SC_NOT_FOUND *
* <p>If not specified, the default status code will be applied.
*
* @see #setDefaultStatusCode(int)
*/
public void setStatusCodes(Properties statusCodes) {
for (Enumeration enumeration = statusCodes.propertyNames(); enumeration.hasMoreElements();) {
String viewName = (String) enumeration.nextElement();
Integer statusCode = new Integer(statusCodes.getProperty(viewName));
this.statusCodes.put(viewName, statusCode);
}
}
/**
* Set the default HTTP status code that this exception resolver will apply if it resolves an error view and if there
* is no status code mapping defined.
*
* <p>Note that this error code will only get applied in case of a top-level request. It will not be set for an
* include request, since the HTTP status cannot be modified from within an include.
*
* <p>If not specified, no status code will be applied, either leaving this to the controller or view, or keeping
* the servlet engine's default of 200 (OK).
*
* @param defaultStatusCode HTTP status code value, for example 500
* ({@link HttpServletResponse#SC_INTERNAL_SERVER_ERROR}) or 404 ({@link HttpServletResponse#SC_NOT_FOUND})
* @see #setStatusCodes(Properties)
*/ */
public void setDefaultStatusCode(int defaultStatusCode) { public void setDefaultStatusCode(int defaultStatusCode) {
this.defaultStatusCode = defaultStatusCode; this.defaultStatusCode = defaultStatusCode;
@ -210,9 +239,13 @@ public class SimpleMappingExceptionResolver extends AbstractHandlerExceptionReso
} }
/** /**
* Determine the HTTP status code to apply for the given error view. <p>The default implementation always returns the * Determine the HTTP status code to apply for the given error view.
* specified {@link #setDefaultStatusCode "defaultStatusCode"}, as a common status code for all error views. Override *
* this in a custom subclass to determine a specific status code for the given view. * <p>The default implementation returns the status code for the given view name (specified through the
* {@link #setStatusCodes(Properties) statusCodes} property), or falls back to the
* {@link #setDefaultStatusCode defaultStatusCode} if there is no match.
*
* <p>Override this in a custom subclass to customize this behavior.
* *
* @param request current HTTP request * @param request current HTTP request
* @param viewName the name of the error view * @param viewName the name of the error view
@ -222,6 +255,9 @@ public class SimpleMappingExceptionResolver extends AbstractHandlerExceptionReso
* @see #applyStatusCodeIfPossible * @see #applyStatusCodeIfPossible
*/ */
protected Integer determineStatusCode(HttpServletRequest request, String viewName) { protected Integer determineStatusCode(HttpServletRequest request, String viewName) {
if (this.statusCodes.containsKey(viewName)) {
return this.statusCodes.get(viewName);
}
return this.defaultStatusCode; return this.defaultStatusCode;
} }
@ -234,7 +270,7 @@ public class SimpleMappingExceptionResolver extends AbstractHandlerExceptionReso
* @param statusCode the status code to apply * @param statusCode the status code to apply
* @see #determineStatusCode * @see #determineStatusCode
* @see #setDefaultStatusCode * @see #setDefaultStatusCode
* @see javax.servlet.http.HttpServletResponse#setStatus * @see HttpServletResponse#setStatus
*/ */
protected void applyStatusCodeIfPossible(HttpServletRequest request, HttpServletResponse response, int statusCode) { protected void applyStatusCodeIfPossible(HttpServletRequest request, HttpServletResponse response, int statusCode) {
if (!WebUtils.isIncludeRequest(request)) { if (!WebUtils.isIncludeRequest(request)) {

91
org.springframework.web.servlet/src/test/java/org/springframework/web/servlet/handler/SimpleMappingExceptionResolverTests.java
View File

@ -18,10 +18,11 @@ package org.springframework.web.servlet.handler;
import java.util.Collections; import java.util.Collections;
import java.util.Properties; import java.util.Properties;
import javax.servlet.http.HttpServletResponse; import javax.servlet.http.HttpServletResponse;
import junit.framework.TestCase; import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.Test;
import org.springframework.mock.web.MockHttpServletRequest; import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse; import org.springframework.mock.web.MockHttpServletResponse;
@ -31,8 +32,9 @@ import org.springframework.web.util.WebUtils;
/** /**
* @author Seth Ladd * @author Seth Ladd
* @author Juergen Hoeller * @author Juergen Hoeller
* @author Arjen Poutsma
*/ */
public class SimpleMappingExceptionResolverTests extends TestCase { public class SimpleMappingExceptionResolverTests {
private SimpleMappingExceptionResolver exceptionResolver; private SimpleMappingExceptionResolver exceptionResolver;
private MockHttpServletRequest request; private MockHttpServletRequest request;
@ -41,7 +43,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
private Object handler2; private Object handler2;
private Exception genericException; private Exception genericException;
protected void setUp() throws Exception { @Before
public void setUp() throws Exception {
exceptionResolver = new SimpleMappingExceptionResolver(); exceptionResolver = new SimpleMappingExceptionResolver();
handler1 = new String(); handler1 = new String();
handler2 = new Object(); handler2 = new Object();
@ -51,33 +54,38 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
genericException = new Exception(); genericException = new Exception();
} }
public void testSetOrder() { @Test
public void setOrder() {
exceptionResolver.setOrder(2); exceptionResolver.setOrder(2);
assertEquals(2, exceptionResolver.getOrder()); assertEquals(2, exceptionResolver.getOrder());
} }
public void testDefaultErrorView() { @Test
public void defaultErrorView() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals("default-view", mav.getViewName()); assertEquals("default-view", mav.getViewName());
assertEquals(genericException, mav.getModel().get(SimpleMappingExceptionResolver.DEFAULT_EXCEPTION_ATTRIBUTE)); assertEquals(genericException, mav.getModel().get(SimpleMappingExceptionResolver.DEFAULT_EXCEPTION_ATTRIBUTE));
} }
public void testDefaultErrorViewDifferentHandler() { @Test
public void defaultErrorViewDifferentHandler() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setMappedHandlers(Collections.singleton(handler1)); exceptionResolver.setMappedHandlers(Collections.singleton(handler1));
ModelAndView mav = exceptionResolver.resolveException(request, response, handler2, genericException); ModelAndView mav = exceptionResolver.resolveException(request, response, handler2, genericException);
assertNull(mav); assertNull(mav);
} }
public void testDefaultErrorViewDifferentHandlerClass() { @Test
public void defaultErrorViewDifferentHandlerClass() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setMappedHandlerClasses(new Class[] {String.class}); exceptionResolver.setMappedHandlerClasses(new Class[] {String.class});
ModelAndView mav = exceptionResolver.resolveException(request, response, handler2, genericException); ModelAndView mav = exceptionResolver.resolveException(request, response, handler2, genericException);
assertNull(mav); assertNull(mav);
} }
public void testNullExceptionAttribute() { @Test
public void nullExceptionAttribute() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setExceptionAttribute(null); exceptionResolver.setExceptionAttribute(null);
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException);
@ -85,35 +93,51 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertNull(mav.getModel().get(SimpleMappingExceptionResolver.DEFAULT_EXCEPTION_ATTRIBUTE)); assertNull(mav.getModel().get(SimpleMappingExceptionResolver.DEFAULT_EXCEPTION_ATTRIBUTE));
} }
public void testNullExceptionMappings() { @Test
public void nullExceptionMappings() {
exceptionResolver.setExceptionMappings(null); exceptionResolver.setExceptionMappings(null);
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals("default-view", mav.getViewName()); assertEquals("default-view", mav.getViewName());
} }
public void testNoDefaultStatusCode() { @Test
public void noDefaultStatusCode() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals(HttpServletResponse.SC_OK, response.getStatus()); assertEquals(HttpServletResponse.SC_OK, response.getStatus());
} }
public void testSetDefaultStatusCode() { @Test
public void setDefaultStatusCode() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setDefaultStatusCode(HttpServletResponse.SC_BAD_REQUEST); exceptionResolver.setDefaultStatusCode(HttpServletResponse.SC_BAD_REQUEST);
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals(HttpServletResponse.SC_BAD_REQUEST, response.getStatus()); assertEquals(HttpServletResponse.SC_BAD_REQUEST, response.getStatus());
} }
public void testNoDefaultStatusCodeInInclude() { @Test
public void noDefaultStatusCodeInInclude() {
exceptionResolver.setDefaultErrorView("default-view"); exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setDefaultStatusCode(HttpServletResponse.SC_BAD_REQUEST); exceptionResolver.setDefaultStatusCode(HttpServletResponse.SC_BAD_REQUEST);
request.setAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE, "some path"); request.setAttribute(WebUtils.INCLUDE_REQUEST_URI_ATTRIBUTE, "some path");
ModelAndView mav = exceptionResolver.resolveException(request, response, handler1, genericException); exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals(HttpServletResponse.SC_OK, response.getStatus()); assertEquals(HttpServletResponse.SC_OK, response.getStatus());
} }
public void testSimpleExceptionMapping() { @Test
public void specificStatusCode() {
exceptionResolver.setDefaultErrorView("default-view");
exceptionResolver.setDefaultStatusCode(HttpServletResponse.SC_BAD_REQUEST);
Properties statusCodes = new Properties();
statusCodes.setProperty("default-view", "406");
exceptionResolver.setStatusCodes(statusCodes);
exceptionResolver.resolveException(request, response, handler1, genericException);
assertEquals(HttpServletResponse.SC_NOT_ACCEPTABLE, response.getStatus());
}
@Test
public void simpleExceptionMapping() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("Exception", "error"); props.setProperty("Exception", "error");
exceptionResolver.setWarnLogCategory("HANDLER_EXCEPTION"); exceptionResolver.setWarnLogCategory("HANDLER_EXCEPTION");
@ -122,7 +146,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testExactExceptionMappingWithHandlerSpecified() { @Test
public void exactExceptionMappingWithHandlerSpecified() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");
exceptionResolver.setMappedHandlers(Collections.singleton(handler1)); exceptionResolver.setMappedHandlers(Collections.singleton(handler1));
@ -131,7 +156,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testExactExceptionMappingWithHandlerClassSpecified() { @Test
public void exactExceptionMappingWithHandlerClassSpecified() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");
exceptionResolver.setMappedHandlerClasses(new Class[] {String.class}); exceptionResolver.setMappedHandlerClasses(new Class[] {String.class});
@ -140,7 +166,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testExactExceptionMappingWithHandlerInterfaceSpecified() { @Test
public void exactExceptionMappingWithHandlerInterfaceSpecified() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");
exceptionResolver.setMappedHandlerClasses(new Class[] {Comparable.class}); exceptionResolver.setMappedHandlerClasses(new Class[] {Comparable.class});
@ -149,7 +176,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testSimpleExceptionMappingWithHandlerSpecifiedButWrongHandler() { @Test
public void simpleExceptionMappingWithHandlerSpecifiedButWrongHandler() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("Exception", "error"); props.setProperty("Exception", "error");
exceptionResolver.setMappedHandlers(Collections.singleton(handler1)); exceptionResolver.setMappedHandlers(Collections.singleton(handler1));
@ -158,7 +186,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertNull(mav); assertNull(mav);
} }
public void testSimpleExceptionMappingWithHandlerClassSpecifiedButWrongHandler() { @Test
public void simpleExceptionMappingWithHandlerClassSpecifiedButWrongHandler() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("Exception", "error"); props.setProperty("Exception", "error");
exceptionResolver.setMappedHandlerClasses(new Class[] {String.class}); exceptionResolver.setMappedHandlerClasses(new Class[] {String.class});
@ -167,7 +196,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertNull(mav); assertNull(mav);
} }
public void testMissingExceptionInMapping() { @Test
public void missingExceptionInMapping() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("SomeFooThrowable", "error"); props.setProperty("SomeFooThrowable", "error");
exceptionResolver.setWarnLogCategory("HANDLER_EXCEPTION"); exceptionResolver.setWarnLogCategory("HANDLER_EXCEPTION");
@ -176,7 +206,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertNull(mav); assertNull(mav);
} }
public void testTwoMappings() { @Test
public void twoMappings() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");
props.setProperty("AnotherException", "another-error"); props.setProperty("AnotherException", "another-error");
@ -186,7 +217,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testTwoMappingsOneShortOneLong() { @Test
public void twoMappingsOneShortOneLong() {
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("Exception", "error"); props.setProperty("Exception", "error");
props.setProperty("AnotherException", "another-error"); props.setProperty("AnotherException", "another-error");
@ -196,7 +228,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testTwoMappingsOneShortOneLongThrowOddException() { @Test
public void twoMappingsOneShortOneLongThrowOddException() {
Exception oddException = new SomeOddException(); Exception oddException = new SomeOddException();
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("Exception", "error"); props.setProperty("Exception", "error");
@ -207,7 +240,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("error", mav.getViewName()); assertEquals("error", mav.getViewName());
} }
public void testTwoMappingsThrowOddExceptionUseLongExceptionMapping() { @Test
public void twoMappingsThrowOddExceptionUseLongExceptionMapping() {
Exception oddException = new SomeOddException(); Exception oddException = new SomeOddException();
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");
@ -218,7 +252,8 @@ public class SimpleMappingExceptionResolverTests extends TestCase {
assertEquals("another-error", mav.getViewName()); assertEquals("another-error", mav.getViewName());
} }
public void testThreeMappings() { @Test
public void threeMappings() {
Exception oddException = new AnotherOddException(); Exception oddException = new AnotherOddException();
Properties props = new Properties(); Properties props = new Properties();
props.setProperty("java.lang.Exception", "error"); props.setProperty("java.lang.Exception", "error");