Spring Boot Remove Whitelabel Error Page

Question

I'm trying to remove white label error page, so what I've done was created a controller mapping for "/error",

@RestController public class IndexController { @RequestMapping(value = "/error") public String error() { return "Error handling"; } }

But now I"m getting this error.

Exception in thread "AWT-EventQueue-0" org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'requestMappingHandlerMapping' defined in class path resource [org/springframework/web/servlet/config/annotation/DelegatingWebMvcConfiguration.class]: Invocation of init method failed; nested exception is java.lang.IllegalStateException: Ambiguous mapping found. Cannot map 'basicErrorController' bean method public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.BasicErrorController.error(javax.servlet.http.HttpServletR equest) to {[/error],methods=[],params=[],headers=[],consumes=[],produces=[],custom=[]}: There is already 'indexController' bean method

Don't know whether I'm doing anything wrong. Please advice.

EDIT:

Already added error.whitelabel.enabled=false to application.properties file, still getting the same error

Look at this project github.com/paulc4/mvc-exceptions/blob/master/src/main/java/…, seems they have error page remapping in it. — Innot Kauker
– Innot Kauker, Commented Aug 18, 2014 at 6:01
Have you tried setting spring.resources.add-mappings=false? — geoand
– geoand, Commented Aug 18, 2014 at 7:31
Are you just trying to return some custom content when the /error path is called? — geoand
– geoand, Commented Aug 18, 2014 at 11:31

geoand · Accepted Answer · 2015-11-05 07:52:08Z

275

You need to change your code to the following:

@RestController public class IndexController implements ErrorController{ private static final String PATH = "/error"; @RequestMapping(value = PATH) public String error() { return "Error handling"; } @Override public String getErrorPath() { return PATH; } }

Your code did not work, because Spring Boot automatically registers the BasicErrorController as a Spring Bean when you have not specified an implementation of ErrorController.

To see that fact just navigate to ErrorMvcAutoConfiguration.basicErrorController here.

edited Nov 5, 2015 at 7:52

answered Aug 18, 2014 at 11:59

geoand

64.8k24 gold badges185 silver badges201 bronze badges

Sign up to request clarification or add additional context in comments.

12 Comments

Mike R Over a year ago

Ran into the same into the same issue, I searched the Spring docs but it didn't mention BasicErrorController. This works :)

geoand Over a year ago

I had to go through the source to find this one :-)

Jonik Over a year ago

Thanks, worked nicely! A small follow-up if you can give any pointers: say we get in this error handler because some exception was thrown in our app (and Spring implicitly sets response code to 500 which is correct); is there an easy way to get hold of that exception here (to include some details in error message returned)?

geoand Over a year ago

Glad you found it useful! Although I haven't tried it, I am pretty sure that you can use the principles found in Spring Boot's BasicErrorController (see github.com/spring-projects/spring-boot/blob/…) to accomplish what you want

Jonik Over a year ago

Hmm, yes, thanks again! At first I wasn't sure how to get that ErrorAttributes object (containing the error details), but then I tried simply @Autowiring it, and it works. What I went with for now: gist.github.com/jonikarppinen/662c38fb57a23de61c8b

|

rogerdpack · Accepted Answer · 2018-06-11 21:52:27Z

62

Spring boot doc 'was' wrong (they have since fixed it) :

To switch it off you can set error.whitelabel.enabled=false

should be

To switch it off you can set server.error.whitelabel.enabled=false

edited Jun 11, 2018 at 21:52

rogerdpack

67.7k40 gold badges290 silver badges409 bronze badges

answered Nov 10, 2015 at 9:12

willome

3,17221 silver badges32 bronze badges

1 Comment

notes-jj Over a year ago

This will disable the White Label Error Page but spring boot will map the endpoint /error anyway. To free the endpoint /error set server.error.path=/error-spring or some alternative path.

okrunner · Accepted Answer · 2016-06-02 00:28:15Z

If you want a more "JSONish" response page you can try something like that:

import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.web.ErrorAttributes; import org.springframework.boot.autoconfigure.web.ErrorController; import org.springframework.util.Assert; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.context.request.RequestAttributes; import org.springframework.web.context.request.ServletRequestAttributes; import javax.servlet.http.HttpServletRequest; import java.util.Map; @RestController @RequestMapping("/error") public class SimpleErrorController implements ErrorController { private final ErrorAttributes errorAttributes; @Autowired public SimpleErrorController(ErrorAttributes errorAttributes) { Assert.notNull(errorAttributes, "ErrorAttributes must not be null"); this.errorAttributes = errorAttributes; } @Override public String getErrorPath() { return "/error"; } @RequestMapping public Map<String, Object> error(HttpServletRequest aRequest){ Map<String, Object> body = getErrorAttributes(aRequest,getTraceParameter(aRequest)); String trace = (String) body.get("trace"); if(trace != null){ String[] lines = trace.split("\n\t"); body.put("trace", lines); } return body; } private boolean getTraceParameter(HttpServletRequest request) { String parameter = request.getParameter("trace"); if (parameter == null) { return false; } return !"false".equals(parameter.toLowerCase()); } private Map<String, Object> getErrorAttributes(HttpServletRequest aRequest, boolean includeStackTrace) { RequestAttributes requestAttributes = new ServletRequestAttributes(aRequest); return errorAttributes.getErrorAttributes(requestAttributes, includeStackTrace); } }

In Spring-Boot v2 the ErrorController and ErrorAttributes classes are in package org.springframework.boot.web.servlet.error and further the ErrorAttributes#getErrorAttributes method signature has changed, please note dependency on Spring-Boot v1 and possibly give hints for v2, thx.
Change : private Map<String, Object> getErrorAttributes(HttpServletRequest aRequest, boolean includeStackTrace) { RequestAttributes requestAttributes = new ServletRequestAttributes(aRequest); return errorAttributes.getErrorAttributes(requestAttributes, includeStackTrace); } By : private Map<String, Object> getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) { WebRequest webRequest = new ServletWebRequest(request); return this.errorAttributes.getErrorAttributes(webRequest, includeStackTrace); }
An updated version of SimpleErrorController.java considering the comments from above can be found in here > gist.github.com/oscarnevarezleal/…

hoodieman · Accepted Answer · 2018-04-05 06:30:32Z

You can remove it completely by specifying:

import org.springframework.context.annotation.Configuration; import org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration; ... @Configuration @EnableAutoConfiguration(exclude = {ErrorMvcAutoConfiguration.class}) public static MainApp { ... }

However, do note that doing so will probably cause servlet container's whitelabel pages to show up instead :)

EDIT: Another way to do this is via application.yaml. Just put in the value:

spring: autoconfigure: exclude: org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration

Documentation

For Spring Boot < 2.0, the class is located in package org.springframework.boot.autoconfigure.web.

Maciej Lach · Accepted Answer · 2016-03-23 10:10:12Z

19

Manual here says that you have to set server.error.whitelabel.enabled to false to disable the standard error page. Maybe it is what you want?

I am experiencing the same error after adding /error mapping, by the way.

edited Mar 23, 2016 at 10:10

Maciej Lach

1,6913 gold badges21 silver badges28 bronze badges

answered Aug 18, 2014 at 5:38

Innot Kauker

1,3831 gold badge19 silver badges31 bronze badges

2 Comments

Yasitha Waduge Over a year ago

Yes I've already set error.whitelabel.enabled=false but still getting the same error after adding /error mapping

notes-jj Over a year ago

This will disable the White Label Error Page but spring boot will map the endpoint /error anyway. To free the endpoint /error set server.error.path=/error-spring or some alternative path.

Thomas Marti · Accepted Answer · 2018-02-12 15:12:32Z

This depends on your spring boot version:

When SpringBootVersion <= 1.2 then use error.whitelabel.enabled = false

When SpringBootVersion >= 1.3 then use server.error.whitelabel.enabled = false

db80 · Accepted Answer · 2017-04-24 11:51:12Z

With Spring Boot > 1.4.x you could do this:

@SpringBootApplication(exclude = {ErrorMvcAutoConfiguration.class}) public class MyApi { public static void main(String[] args) { SpringApplication.run(App.class, args); } }

but then in case of exception the servlet container will display its own error page.

Ecmel Ercan · Accepted Answer · 2016-10-10 17:23:36Z

In Spring Boot 1.4.1 using Mustache templates, placing error.html under templates folder will be enough:

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Error</title> </head> <body> <h1>Error {{ status }}</h1> <p>{{ error }}</p> <p>{{ message }}</p> <p>{{ path }}</p> </body> </html>

Additional variables can be passed by creating an interceptor for /error

Using this example: github.com/paulc4/mvc-exceptions/blob/master/src/main/resources/…

Eric Aya · Accepted Answer · 2019-02-09 18:13:08Z

I am using Spring Boot version 2.1.2 and the errorAttributes.getErrorAttributes() signature didn't work for me (in acohen's response). I wanted a JSON type response so I did a little digging and found this method did exactly what I needed.

I got most of my information from this thread as well as this blog post.

First, I created a CustomErrorController that Spring will look for to map any errors to.

package com.example.error; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.web.servlet.error.ErrorAttributes; import org.springframework.boot.web.servlet.error.ErrorController; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.context.request.WebRequest; import javax.servlet.http.HttpServletResponse; import java.util.HashMap; import java.util.Map; @RestController public class CustomErrorController implements ErrorController { private static final String PATH = "error"; @Value("${debug}") private boolean debug; @Autowired private ErrorAttributes errorAttributes; @RequestMapping(PATH) @ResponseBody public CustomHttpErrorResponse error(WebRequest request, HttpServletResponse response) { return new CustomHttpErrorResponse(response.getStatus(), getErrorAttributes(request)); } public void setErrorAttributes(ErrorAttributes errorAttributes) { this.errorAttributes = errorAttributes; } @Override public String getErrorPath() { return PATH; } private Map<String, Object> getErrorAttributes(WebRequest request) { Map<String, Object> map = new HashMap<>(); map.putAll(this.errorAttributes.getErrorAttributes(request, this.debug)); return map; } }

Second, I created a CustomHttpErrorResponse class to return the error as JSON.

package com.example.error; import java.util.Map; public class CustomHttpErrorResponse { private Integer status; private String path; private String errorMessage; private String timeStamp; private String trace; public CustomHttpErrorResponse(int status, Map<String, Object> errorAttributes) { this.setStatus(status); this.setPath((String) errorAttributes.get("path")); this.setErrorMessage((String) errorAttributes.get("message")); this.setTimeStamp(errorAttributes.get("timestamp").toString()); this.setTrace((String) errorAttributes.get("trace")); } // getters and setters }

Finally, I had to turn off the Whitelabel in the application.properties file.

server.error.whitelabel.enabled=false

This should even work for xml requests/responses. But I haven't tested that. It did exactly what I was looking for since I was creating a RESTful API and only wanted to return JSON.

rustyx · Accepted Answer · 2018-09-06 20:16:34Z

Here's an alternative method which is very similar to the "old way" of specifying error mappings in web.xml.

Just add this to your Spring Boot configuration:

@SpringBootApplication public class Application implements WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> { @Override public void customize(ConfigurableServletWebServerFactory factory) { factory.addErrorPages(new ErrorPage(HttpStatus.FORBIDDEN, "/errors/403.html")); factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/errors/404.html")); factory.addErrorPages(new ErrorPage("/errors/500.html")); } }

Then you can define the error pages in the static content normally.

The customizer can also be a separate @Component, if desired.

shatakshi · Accepted Answer · 2020-04-16 11:50:49Z

Spring Boot by default has a “whitelabel” error page which you can see in a browser if you encounter a server error. Whitelabel Error Page is a generic Spring Boot error page which is displayed when no custom error page is found.

Set “server.error.whitelabel.enabled=false” to switch of the default error page

Shubhashish Mishra · Accepted Answer · 2020-06-29 21:34:35Z

I had a similar issue WhiteLabel Error message on my Angular SPA whenever I did a refresh.

The fix was to create a controller that implements ErrorController but instead of returning a String, I had to return a ModelAndView object that forwards to /

@CrossOrigin @RestController public class IndexController implements ErrorController { private static final String PATH = "/error"; @RequestMapping(value = PATH) public ModelAndView saveLeadQuery() { return new ModelAndView("forward:/"); } @Override public String getErrorPath() { return PATH; } }

Community · Accepted Answer · 2020-06-20 09:12:55Z

2

server.error.whitelabel.enabled=false

Include the above line to the Resources folders application.properties

More Error Issue resolve please refer http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto-customize-the-whitelabel-error-page

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Jul 14, 2016 at 10:39

suganya sudarsan

293 bronze badges

1 Comment

Richard Bradley Smith Over a year ago

I tried application.properties in my installation folder which did nothing. The application.properties folder under /src/main/resources is what suganya sudarsan was attempting to convey. It appears to be a "hot read" in Eclipse as well.

Yusuf · Accepted Answer · 2018-07-25 11:49:25Z

I was trying to call a REST endpoint from a microservice and I was using the resttemplate's put method.

In my design if any error occurred inside the REST endpoint it should return a JSON error response, it was working for some calls but not for this put one, it returned the white label error page instead.

So I did some investigation and I found out that;

Spring try to understand the caller if it is a machine then it returns JSON response or if it is a browser than it returns the white label error page HTML.

As a result: my client app needed to say to REST endpoint that the caller is a machine, not a browser so for this the client app needed to add 'application/json' into the ACCEPT header explicitly for the resttemplate's 'put' method. I added this to the header and solved the problem.

my call to the endpoint:

restTemplate.put(url, request, param1, param2);

for above call I had to add below header param.

headers.set("Accept", MediaType.APPLICATION_JSON_UTF8_VALUE);

or I tried to change put to exchange as well, in this case, exchange call added the same header for me and solved the problem too but I don't know why :)

restTemplate.exchange(....)

singhpradeep · Accepted Answer · 2021-11-13 01:07:15Z

Solution posted by geoand works for me. In addition to this, if you want to redirect to any specific page then you may use this.

@RequestMapping(value = PATH) public void error(HttpServletResponse response) { response.sendRedirect("/"); //provide your error page url or home url }

Full Code snippet below:

@RestController public class IndexController implements ErrorController{ private static final String PATH = "/error"; @RequestMapping(value = PATH) public void error(HttpServletResponse response) { response.sendRedirect("/"); //provide your error page url or home url } @Override public String getErrorPath() { return PATH; } }

PS: Since, unable to edit above answer, hence posting this as new answer.

Ashish Lahoti · Accepted Answer · 2022-11-27 14:11:10Z

Custom error page in JSON format for Spring Boot > 2.3.0

package com.example.api.controller; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.web.error.ErrorAttributeOptions; import org.springframework.boot.web.servlet.error.ErrorAttributes; import org.springframework.boot.web.servlet.error.ErrorController; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.context.request.WebRequest; import javax.servlet.http.HttpServletResponse; import java.util.Map; @RestController public class CustomErrorController implements ErrorController { private static final String PATH = "/error"; @Autowired private ErrorAttributes errorAttributes; @RequestMapping(PATH) public Map<String, Object> error(WebRequest request, HttpServletResponse response) { return getErrorAttributes(request, true); } private Map<String, Object> getErrorAttributes(WebRequest request, boolean includeStackTrace) { ErrorAttributeOptions options = ErrorAttributeOptions.defaults() .including(ErrorAttributeOptions.Include.MESSAGE) .including(ErrorAttributeOptions.Include.EXCEPTION) .including(ErrorAttributeOptions.Include.BINDING_ERRORS); if(includeStackTrace){ options = options.including(ErrorAttributeOptions.Include.STACK_TRACE); } return this.errorAttributes.getErrorAttributes(request, options); } }

Arbis Malasi · Accepted Answer · 2021-08-24 13:36:05Z

Best option would be to create a HTML page (JSP,THYMELEAF) with the name "error.html", it would redirect every whitelable error to this page . You can customize it after .

Mostafejur Rahman · Accepted Answer · 2022-06-23 05:40:17Z

We can easily handle white label error in Java Spring boot. Just add this class in configuration file..

import org.springframework.boot.web.server.ErrorPage; import org.springframework.boot.web.server.WebServerFactoryCustomizer; import org.springframework.boot.web.servlet.server.ConfigurableServletWebServerFactory; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.HttpStatus; import org.springframework.web.servlet.config.annotation.ViewControllerRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class WebRoutingConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/urlNotFound") // the viewName should be specified, in our case we forward to the index.html .setViewName("forward:/index.html"); } @Bean public WebServerFactoryCustomizer<ConfigurableServletWebServerFactory> containerCustomizer() { return container -> { container.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/urlNotFound")); }; } }

MaduKan · Accepted Answer · 2022-10-01 04:21:24Z

I literally missed to add the @RestController annotation in my code somehow. Silly as it may sound, but worth keeping written down somewhere if you ask me, just in-case if you miss that one in a rush..

@RestController public class MyApiController implements MyApi { . .

Collectives™ on Stack Overflow

Spring Boot Remove Whitelabel Error Page

19 Answers 19

12 Comments

1 Comment

3 Comments

Comments

2 Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

server.error.whitelabel.enabled=false

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

19 Answers 19

12 Comments

1 Comment

3 Comments

Comments

2 Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

server.error.whitelabel.enabled=false

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Related