Class BasicErrorController

java.lang.Object

org.springframework.boot.webmvc.autoconfigure.error.AbstractErrorController

org.springframework.boot.webmvc.autoconfigure.error.BasicErrorController

All Implemented Interfaces:

ErrorController

@Controller
@RequestMapping("${spring.web.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 registering error pages.

Since:

4.0.0

Author:

Dave Syer, Phillip Webb, Michael Stummvoll, Stephane Nicoll, Scott Frederick, Moritz Halbritter

See Also:

• ErrorAttributes
• ErrorProperties

Constructor Summary

Constructors

Constructor	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	Description
ResponseEntity<Map<String,Object>>	error(HttpServletRequest request)
ModelAndView	errorHtml(HttpServletRequest request, HttpServletResponse response)
protected ErrorAttributeOptions	getErrorAttributeOptions(HttpServletRequest request, MediaType mediaType)
protected ErrorProperties	getErrorProperties()	Provide access to the error properties.
protected boolean	isIncludeBindingErrors(HttpServletRequest request, MediaType produces)	Determine if the errors attribute should be included.
protected boolean	isIncludeMessage(HttpServletRequest request, MediaType produces)	Determine if the message attribute should be included.
protected boolean	isIncludePath(HttpServletRequest request, MediaType produces)	Determine if the path attribute should be included.
protected boolean	isIncludeStackTrace(HttpServletRequest request, MediaType produces)	Determine if the stacktrace attribute should be included.
ResponseEntity<String>	mediaTypeNotAcceptable(HttpServletRequest request)

Methods inherited from class AbstractErrorController

getBooleanParameter, getErrorAttributes, getErrorsParameter, getMessageParameter, getPathParameter, getStatus, getTraceParameter, resolveErrorView

Methods inherited from class Object

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

Constructor Details

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 Details

errorHtml

@RequestMapping(produces="text/html")
public ModelAndView errorHtml(HttpServletRequest request,
 HttpServletResponse response)

error

@RequestMapping
public ResponseEntity<Map<String,Object>> error(HttpServletRequest request)

mediaTypeNotAcceptable

@ExceptionHandler(HttpMediaTypeNotAcceptableException.class)
public ResponseEntity<String> mediaTypeNotAcceptable(HttpServletRequest request)

getErrorAttributeOptions

protected ErrorAttributeOptions getErrorAttributeOptions(HttpServletRequest request,
 MediaType mediaType)

isIncludeStackTrace

protected boolean isIncludeStackTrace(HttpServletRequest request,
 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

isIncludeMessage

protected boolean isIncludeMessage(HttpServletRequest request,
 MediaType produces)

Determine if the message attribute should be included.

Parameters:

request - the source request

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

Returns:

if the message attribute should be included

isIncludeBindingErrors

protected boolean isIncludeBindingErrors(HttpServletRequest request,
 MediaType produces)

Determine if the errors attribute should be included.

Parameters:

request - the source request

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

Returns:

if the errors attribute should be included

isIncludePath

protected boolean isIncludePath(HttpServletRequest request,
 MediaType produces)

Determine if the path attribute should be included.

Parameters:

request - the source request

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

Returns:

if the path attribute should be included

getErrorProperties

protected ErrorProperties getErrorProperties()

Provide access to the error properties.

Returns:

the error properties