Class ProblemDetailsConfigurer

java.lang.Object

org.springframework.web.servlet.config.annotation.ProblemDetailsConfigurer

public class ProblemDetailsConfigurer
extends Object

Configure how RFC 9457 problem details are produced and rendered.

For now, ErrorResponse.Interceptors are configured separately, see WebMvcConfigurer.addErrorResponseInterceptors(java.util.List).

Since:

7.1

Author:

Brian Clozel

See Also:

• WebMvcConfigurer.configureProblemDetails(ProblemDetailsConfigurer)

Constructor Summary

Constructors

Constructor	Description
ProblemDetailsConfigurer()

Method Summary

Modifier and Type	Method	Description
protected @Nullable ErrorResponseViewResolver	getViewResolver()
protected boolean	isRenderUnhandledExceptions()
ProblemDetailsConfigurer	renderUnhandledExceptions(boolean renderUnhandledExceptions)	Whether to render exceptions that are not handled by any @ExceptionHandler method as problem details, instead of only setting the response status and leaving the response body to the Servlet container.
ProblemDetailsConfigurer	viewResolver(ErrorResponseViewResolver viewResolver)	Configure an ErrorResponseViewResolver to render problem details returned by @ExceptionHandler methods as views, typically HTML error pages, when the client prefers HTML.

Methods inherited from class Object

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

Constructor Details

ProblemDetailsConfigurer

public ProblemDetailsConfigurer()

Method Details

renderUnhandledExceptions

public ProblemDetailsConfigurer renderUnhandledExceptions(boolean renderUnhandledExceptions)

Whether to render exceptions that are not handled by any @ExceptionHandler method as problem details, instead of only setting the response status and leaving the response body to the Servlet container.

By default, this is set to false.

Parameters:

renderUnhandledExceptions - whether to render unhandled exceptions as problem details

See Also:

• ExceptionHandlerExceptionResolver.setRenderUnhandledExceptionsAsProblemDetails(boolean)

viewResolver

public ProblemDetailsConfigurer viewResolver(ErrorResponseViewResolver viewResolver)

Configure an ErrorResponseViewResolver to render problem details returned by @ExceptionHandler methods as views, typically HTML error pages, when the client prefers HTML.

By default, problem details are always written with message converters.

Parameters:

viewResolver - the resolver to use

See Also:

• ExceptionHandlerExceptionResolver.setErrorResponseViewResolver(ErrorResponseViewResolver)

isRenderUnhandledExceptions

protected boolean isRenderUnhandledExceptions()

getViewResolver

protected @Nullable ErrorResponseViewResolver getViewResolver()