{"id":796,"date":"2013-10-22T04:26:09","date_gmt":"2013-10-22T11:26:09","guid":{"rendered":"http:\/\/10kdev.net\/?p=796"},"modified":"2013-10-22T04:34:58","modified_gmt":"2013-10-22T11:34:58","slug":"spring-mvc-beat-me-down-with-a-404","status":"publish","type":"post","link":"http:\/\/10kdev.net\/?p=796","title":{"rendered":"Spring MVC beat me down with a 404"},"content":{"rendered":"

Before I get started on this, here is the solution I chose for setting up a 404 error trap in a Spring Web MVC (Spring 3.2). It may seem old school, but after hours of research and testing this is what works the best for my application.<\/p>\n

Solution
<\/strong><\/p>\n

In web.xml add something like this, you r location could be an html page but mine is an error controller endpoint:<\/p>\n

<error-page><\/span>
<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<error-code>404<\/error-code><\/span>
<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<location>\/error\/404<\/location><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

<\/error-page><\/span><\/span><\/span><\/span>
<\/span><\/p>\n

My error controller looks like this, in my case I return an error object that has a status and message property that gets deserialized to json:<\/p>\n

@Api(description = “Error Controller to catch errors not covered by ControllerAdvice.”, value = “\/error”)<\/span>
<\/span><\/span><\/span><\/span><\/span><\/p>\n

@Controller<\/span>
<\/span><\/p>\n

@RequestMapping(value = “\/error”, produces = MediaType.APPLICATION_JSON_VALUE<\/em>)<\/span>
<\/span><\/span><\/span><\/span><\/span><\/p>\n

public<\/strong>
class<\/strong> ErrorController {<\/span><\/span><\/span><\/span><\/p>\n

@RequestMapping(value=“\/404”)<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


@ResponseStatus(HttpStatus.NOT_FOUND<\/em>)<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


@ApiOperation(value = “404 Error Handler”)<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


public<\/strong>
@ResponseBody ControllerResponse unmappedRequest(HttpServletResponse response) throws<\/strong> IOException {<\/span>
<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0return<\/strong>
new<\/strong> ControllerResponse.Builder().status(ControllerResponseEnum.error<\/em>).message(HttpStatus.NOT_FOUND<\/em>.getReasonPhrase()).build();<\/span>
<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

}<\/span>
<\/span><\/p>\n

}
<\/span><\/p>\n

ControllerReponse is just a simple json pojo
<\/span><\/p>\n

@JsonInclude(Include.NON_NULL<\/em>)<\/span>
<\/span><\/span><\/span><\/p>\n

public<\/strong>
class<\/strong> ControllerResponse {<\/span><\/span><\/span><\/span><\/p>\n

@JsonProperty<\/span><\/span><\/p>\n

@JsonFormat(shape = JsonFormat.Shape.STRING<\/em>)<\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

private<\/strong> ControllerResponseEnum status;<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


@JsonProperty<\/span><\/span><\/p>\n

private<\/strong> String data;<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


@JsonProperty<\/span><\/span><\/p>\n

private<\/strong> String meta;<\/span>
<\/span><\/span><\/span><\/span><\/p>\n


@JsonProperty<\/span><\/span><\/p>\n

private<\/strong> String message;<\/span><\/span><\/span><\/span><\/span>
<\/span><\/p>\n

\u2026. Plus getters\/setters etc. . . .
<\/em><\/p>\n

ControllerResponseEnum simply lists the values suggested in the JSend<\/a> spec: success, fail, or error.
<\/span><\/p>\n

public<\/strong>
enum<\/strong> ControllerResponseEnum {
<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0success, fail, error
<\/em><\/span><\/span><\/span><\/p>\n

}<\/span>
<\/span><\/p>\n

Things That Didn’t Work For Me \u2013 406’s everywhere<\/strong><\/p>\n

Special controller mapped to \/** didn’t work<\/em><\/strong><\/p>\n

At first I thought I could just create an error controller and catch everything coming in at \/** by adding a request mapping and throw the error from there, centralizing my error responses. This works great like this . . . (but . . . )
<\/span><\/p>\n


@RequestMapping(value=“\/**”)<\/span><\/span><\/span><\/span><\/strong><\/span><\/span><\/p>\n

@ResponseStatus(HttpStatus.NOT_FOUND<\/em>)<\/span><\/span><\/span><\/span><\/span><\/p>\n

@ApiOperation(value = “404 Error Handler”)<\/span><\/span><\/span><\/span><\/span><\/p>\n

public<\/strong>
@ResponseBody ControllerResponse unmappedRequest(HttpServletResponse response) throws<\/strong> IOException {<\/span>
<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

The good thing is \u2013 it intercepts EVERYTHING. The bad thing is \u2013 it intercepts EVERYTHING. So I ran into problems with my static resource files. There’s a schema and some ui on the path needed for the ReST application:
<\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0<mvc:resources\u00a0<\/span>mapping<\/span>=“\/static\/**”\u00a0<\/em><\/span><\/span>location=“\/static\/”\u00a0<\/em><\/span>\/><\/span><\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

But the “\/**” controller wreaks havoc. I tried everything under the sou to get this to work: writing redirects in the error controller for instance, some fancy web.xml default servlet mappings. Nothing. It throws out 406 errors (NOT ACCEPTABLE error).<\/p>\n

Interceptors require too much code to maintain, comparatively to the solution I needed<\/em><\/strong><\/p>\n

Even tried configuring an intercept filter and handle the code there, but I started to write waaaaaay tooo much.<\/p>\n

\u00a0\u00a0\u00a0\u00a0<mvc:interceptors><\/span>
<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<mvc:interceptor><\/span>
<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<mvc:mapping\u00a0<\/span>path<\/span>=“\/**”\u00a0<\/em><\/span><\/span>\/><\/span>
<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<bean\u00a0<\/span>class<\/span>=“com.ist.common.error.StaticContentInterceptor”<\/em><\/span><\/span>\/><\/span>
<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/mvc:interceptor><\/span>
<\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0<\/mvc:interceptors>
<\/span><\/span><\/span><\/span><\/p>\n

Or try it with java config file:<\/span>
<\/span><\/p>\n

@Configuration<\/span>
<\/span><\/p>\n

@EnableWebMvc<\/span>
<\/span><\/p>\n

public<\/strong>
class<\/strong> StaticContentConfig extends<\/strong> WebMvcConfigurerAdapter {<\/span><\/span><\/span><\/span><\/span><\/span><\/p>\n

\/\/@formatter:off<\/span><\/span><\/p>\n

@Override<\/span><\/span><\/p>\n

public<\/strong>
void<\/strong> addInterceptors(InterceptorRegistry registry) {<\/span>
<\/span><\/span><\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0registry.addInterceptor(new<\/strong>
StaticContentInterceptor<\/span>())<\/span>
<\/span><\/span><\/p>\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.addPathPatterns(“\/**”) }<\/span><\/span><\/span><\/p>\n

\/\/@formatter:on<\/span>
<\/span><\/p>\n

}
<\/span><\/p>\n

Nope.<\/p>\n

MIME type mappings \u2013 might as well just do <error> config if you are messing with web.xml:<\/em><\/strong><\/p>\n

How about mounting every freakin static mime type . . . .<\/p>\n

<servlet-mapping><\/span><\/p>\n

<servlet-name>MyApp<\/servlet-name><\/span><\/span><\/span><\/span><\/p>\n

<url-pattern>\/<\/url-pattern><\/span><\/span><\/span><\/span><\/p>\n

<\/servlet-mapping><\/span><\/p>\n

<!– The ‘dynamic’ content –><\/span><\/span><\/span><\/p>\n

<servlet-mapping><\/span><\/p>\n

<servlet-name>default<\/servlet-name><\/span><\/span><\/span><\/span><\/p>\n

<url-pattern>*.css<\/url-pattern>
<\/span><\/span><\/span><\/span><\/span><\/p>\n

<\/servlet-mapping>
<\/span><\/span><\/p>\n

<servlet-mapping><\/span><\/p>\n

<servlet-name>default<\/servlet-name><\/span><\/span><\/span><\/span><\/p>\n

<url-pattern>*.js<\/url-pattern>
<\/span><\/span><\/span><\/span><\/span><\/p>\n

<\/servlet-mapping>
<\/span><\/span><\/p>\n

<servlet-mapping><\/span><\/p>\n

<servlet-name>default<\/servlet-name><\/span><\/span><\/span><\/span><\/p>\n

<url-pattern>*.jpg<\/url-pattern>
<\/span><\/span><\/span><\/span><\/span><\/p>\n

<\/servlet-mapping>
<!– The ‘static’ content –>
<\/span><\/span><\/span><\/span><\/p>\n

The 404 isn’t a Spring MVC issue. The error is scoped outside of the framework. By the time you get there, you’ve passed up a lot of other functionality. Here are some key conversations about the issue that had me settle on what I put in:<\/p>\n

https:\/\/jira.springsource.org\/browse\/SPR-8837<\/a><\/p>\n

http:\/\/stackoverflow.com\/questions\/11792231\/spring-mvc-catch-http-errors-400-404<\/a><\/p>\n

So I guess what burned me is that a 404 is a basic error of doing web applications, and I just don’t like having more than one way to do things if I can help it. I handle 500 errors via the framework, so why not 404’s? The solution makes sense for now, as the simplest. Of course you could write a log of code in the interceptor or controller \/** method, but that (IMHO) defeats the purpose of convention over a coded configuration. Since I was left to configuration, I just chose the simplest path.<\/p>\n","protected":false},"excerpt":{"rendered":"

Before I get started on this, here is the solution I chose for setting up a 404 error trap in a Spring Web MVC (Spring 3.2). It may seem old school, but after hours of research and testing this is what works the best for my application. Solution In web.xml add something like this, you […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"_links":{"self":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/796"}],"collection":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=796"}],"version-history":[{"count":4,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/796\/revisions"}],"predecessor-version":[{"id":800,"href":"http:\/\/10kdev.net\/index.php?rest_route=\/wp\/v2\/posts\/796\/revisions\/800"}],"wp:attachment":[{"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=796"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=796"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/10kdev.net\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=796"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}