org.springframework.boot.autoconfigure.web.servlet.error

Class AbstractErrorController

java.lang.Object

org.springframework.boot.autoconfigure.web.servlet.error.AbstractErrorController

All Implemented Interfaces:

ErrorController

Direct Known Subclasses:

BasicErrorController

public abstract class AbstractErrorController
extends Object
implements ErrorController

Abstract base class for error @Controller implementations.

Since:

1.3.0

Author:

Dave Syer, Phillip Webb, Scott Frederick

See Also:

ErrorAttributes

Constructor Summary

Constructors

Constructor and Description
AbstractErrorController(ErrorAttributes errorAttributes)
AbstractErrorController(ErrorAttributes errorAttributes, List<ErrorViewResolver> errorViewResolvers)

Method Summary

Modifier and Type	Method and Description
protected boolean	getBooleanParameter(HttpServletRequest request, String parameterName)
protected Map<String,Object>	getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getErrorAttributes(HttpServletRequest, ErrorAttributeOptions)
protected Map<String,Object>	getErrorAttributes(HttpServletRequest request, ErrorAttributeOptions options)
protected boolean	getErrorsParameter(HttpServletRequest request)
protected boolean	getMessageParameter(HttpServletRequest request)
protected HttpStatus	getStatus(HttpServletRequest request)
protected boolean	getTraceParameter(HttpServletRequest request)
protected ModelAndView	resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status, Map<String,Object> model) Resolve any specific error views.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.boot.web.servlet.error.ErrorController

getErrorPath

Constructor Detail

AbstractErrorController

public AbstractErrorController(ErrorAttributes errorAttributes)

AbstractErrorController

public AbstractErrorController(ErrorAttributes errorAttributes,
                               List<ErrorViewResolver> errorViewResolvers)

Method Detail

getErrorAttributes

@Deprecated
protected Map<String,Object> getErrorAttributes(HttpServletRequest request,
                                                            boolean includeStackTrace)

Deprecated. since 2.3.0 for removal in 2.5.0 in favor of getErrorAttributes(HttpServletRequest, ErrorAttributeOptions)

Returns a Map of the error attributes.

Parameters:

request - the source request

includeStackTrace - if stack trace elements should be included

Returns:

the error attributes

getErrorAttributes

protected Map<String,Object> getErrorAttributes(HttpServletRequest request,
                                                ErrorAttributeOptions options)

getTraceParameter

protected boolean getTraceParameter(HttpServletRequest request)

getMessageParameter

protected boolean getMessageParameter(HttpServletRequest request)

getErrorsParameter

protected boolean getErrorsParameter(HttpServletRequest request)

getBooleanParameter

protected boolean getBooleanParameter(HttpServletRequest request,
                                      String parameterName)

getStatus

protected HttpStatus getStatus(HttpServletRequest request)

resolveErrorView

protected ModelAndView resolveErrorView(HttpServletRequest request,
                                        HttpServletResponse response,
                                        HttpStatus status,
                                        Map<String,Object> model)

Resolve any specific error views. By default this method delegates to ErrorViewResolvers.

Parameters:

request - the request

response - the response

status - the HTTP status

model - the suggested model

Returns:

a specific ModelAndView or null if the default should be used

Since:

1.4.0