org.springframework.boot.autoconfigure.web

Class BasicErrorController

java.lang.Object

org.springframework.boot.autoconfigure.web.AbstractErrorController

org.springframework.boot.autoconfigure.web.BasicErrorController

All Implemented Interfaces:

ErrorController

@Controller
 @RequestMapping(value="${server.error.path:${error.path:/error}}")
public class BasicErrorController
extends AbstractErrorController

Basic global error Controller, rendering ErrorAttributes. More specific errors can be handled either using Spring MVC abstractions (e.g. @ExceptionHandler) or by adding servlet container error pages.

Author:

Dave Syer, Phillip Webb, Michael Stummvoll, Stephane Nicoll

See Also:

ErrorAttributes, ErrorProperties

Constructor Summary

Constructors

Constructor and Description
BasicErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties) Create a new BasicErrorController instance.
BasicErrorController(ErrorAttributes errorAttributes, ErrorProperties errorProperties, List<ErrorViewResolver> errorViewResolvers) Create a new BasicErrorController instance.

Method Summary

Modifier and Type	Method and Description
org.springframework.http.ResponseEntity<Map<String,Object>>	error(javax.servlet.http.HttpServletRequest request)
org.springframework.web.servlet.ModelAndView	errorHtml(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	getErrorPath() Returns the path of the error page.
protected ErrorProperties	getErrorProperties() Provide access to the error properties.
protected boolean	isIncludeStackTrace(javax.servlet.http.HttpServletRequest request, org.springframework.http.MediaType produces) Determine if the stacktrace attribute should be included.

Methods inherited from class org.springframework.boot.autoconfigure.web.AbstractErrorController

getErrorAttributes, getStatus, getTraceParameter, resolveErrorView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicErrorController

public BasicErrorController(ErrorAttributes errorAttributes,
                            ErrorProperties errorProperties)

Create a new BasicErrorController instance.

Parameters:

errorAttributes - the error attributes

errorProperties - configuration properties

BasicErrorController

public BasicErrorController(ErrorAttributes errorAttributes,
                            ErrorProperties errorProperties,
                            List<ErrorViewResolver> errorViewResolvers)

Create a new BasicErrorController instance.

Parameters:

errorAttributes - the error attributes

errorProperties - configuration properties

errorViewResolvers - error view resolvers

Method Detail

getErrorPath

public String getErrorPath()

Description copied from interface: ErrorController

Returns the path of the error page.

Returns:

the error path

errorHtml

@RequestMapping(produces="text/html")
public org.springframework.web.servlet.ModelAndView errorHtml(javax.servlet.http.HttpServletRequest request,
                                                                                                    javax.servlet.http.HttpServletResponse response)

error

@RequestMapping
 @ResponseBody
public org.springframework.http.ResponseEntity<Map<String,Object>> error(javax.servlet.http.HttpServletRequest request)

isIncludeStackTrace

protected boolean isIncludeStackTrace(javax.servlet.http.HttpServletRequest request,
                                      org.springframework.http.MediaType produces)

Determine if the stacktrace attribute should be included.

Parameters:

request - the source request

produces - the media type produced (or MediaType.ALL)

Returns:

if the stacktrace attribute should be included

getErrorProperties

protected ErrorProperties getErrorProperties()

Provide access to the error properties.

Returns:

the error properties