me.alidg.errors.conf

Class ErrorsAutoConfiguration

java.lang.Object

me.alidg.errors.conf.ErrorsAutoConfiguration

@ConditionalOnWebApplication
 @EnableConfigurationProperties(value=ErrorsProperties.class)
public class ErrorsAutoConfiguration
extends Object

Auto-configuration responsible for registering a WebErrorHandlers filled with builtin, custom and default fallback WebErrorHandlers.

Builtin Web Error Handlers

Built in WebErrorHandlers are those we provided out of the box. It's highly recommended to use these implementations with most possible priority, as we did in this auto-configuration.

Custom Web Error Handlers

You can also provide your own custom WebErrorHandler implementations. Just implement the WebErrorHandler interface and register it as Spring Bean. If you're willing to prioritize your implementations, use the Spring Order annotation to specify the priority requirements of the bean.

Please Note that your custom handlers would be registered after the built-in ones. If you're not OK with that, you can always discard this auto-configuration by registering your own WebErrorHandlers factory bean.

Default Fallback Web Error Handler

While handling a particular exception, each registered WebErrorHandler in WebErrorHandlers would be consulted one after another (Depending on their priority). If all of the registered handlers refuse to handle the exception, then a default fallback WebErrorHandler should handle the exception. By default, WebErrorHandlers use the LastResortWebErrorHandler as the default handler. You can replace this handler by providing a WebErrorHandler and register it with a bean named defaultWebErrorHandler.

Author:

Ali Dehghani

See Also:

WebErrorHandler, WebErrorHandlers, LastResortWebErrorHandler

Constructor Summary

Constructors

Constructor and Description
ErrorsAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
ExceptionLogger	exceptionLogger() Registers an empty ExceptionLogger in the absence of a custom logger.
ExceptionRefiner	exceptionRefiner() Registers an empty ExceptionRefiner in the absence of a custom refiner.
FingerprintProvider	fingerprintProvider() Registers a very simple UUID based FingerprintProvider in the absence of a custom provider.
HttpErrorAttributesAdapter	httpErrorAttributesAdapter(ErrorsProperties errorsProperties) In the absence of a bean of type HttpErrorAttributesAdapter, registers the default implementation of HttpErrorAttributesAdapter as a bean, to adapt our HttpError to Spring's ErrorAttributes abstraction.
MissingRequestParametersWebErrorHandler	missingRequestParametersWebErrorHandler() Registers a WebErrorHandler to handle new Servlet exceptions defined in Spring Framework 5.1.
ResponseStatusWebErrorHandler	responseStatusWebErrorHandler() Registers a handler expert at handling all possible ResponseStatusExceptions.
SpringSecurityWebErrorHandler	springSecurityWebErrorHandler() Registers a WebErrorHandler bean to handle Spring Security specific exceptions when Spring Security's jar file is present on the classpath.
WebErrorHandlers	webErrorHandlers(org.springframework.context.MessageSource messageSource, List<WebErrorHandler> customHandlers, WebErrorHandler defaultWebErrorHandler, ExceptionRefiner exceptionRefiner, ExceptionLogger exceptionLogger, List<WebErrorHandlerPostProcessor> webErrorHandlerPostProcessors, FingerprintProvider fingerprintProvider, ErrorsProperties errorsProperties, org.springframework.context.ApplicationContext context) Registers a bean of type WebErrorHandlers (If not provided by the user) filled with a set of built-in WebErrorHandlers, a set of custom WebErrorHandlers and a default fallback WebErrorHandler.

Methods inherited from class java.lang.Object

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

Constructor Detail

ErrorsAutoConfiguration

public ErrorsAutoConfiguration()

Method Detail

webErrorHandlers

@Bean
 @ConditionalOnMissingBean
public WebErrorHandlers webErrorHandlers(org.springframework.context.MessageSource messageSource,
                                                                          @Autowired(required=false)
                                                                          List<WebErrorHandler> customHandlers,
                                                                          @Qualifier(value="defaultWebErrorHandler") @Autowired(required=false)
                                                                          WebErrorHandler defaultWebErrorHandler,
                                                                          ExceptionRefiner exceptionRefiner,
                                                                          ExceptionLogger exceptionLogger,
                                                                          @Autowired(required=false)
                                                                          List<WebErrorHandlerPostProcessor> webErrorHandlerPostProcessors,
                                                                          FingerprintProvider fingerprintProvider,
                                                                          ErrorsProperties errorsProperties,
                                                                          org.springframework.context.ApplicationContext context)

Registers a bean of type WebErrorHandlers (If not provided by the user) filled with a set of built-in WebErrorHandlers, a set of custom WebErrorHandlers and a default fallback WebErrorHandler.

Parameters:

messageSource - Will be used for error code to error message translation.

customHandlers - Optional custom WebErrorHandlers.

defaultWebErrorHandler - A default WebErrorHandler to be used as the fallback error handler.

exceptionRefiner - To refine exceptions before handling them.

exceptionLogger - To log exceptions.

webErrorHandlerPostProcessors - Post processors to execute after we handled the exception.

fingerprintProvider - To generate unique fingerprints for handled exceptions.

errorsProperties - Configuration properties bean.

context - To tell Servlet or Reactive stacks apart.

Returns:

The expected WebErrorHandlers.

httpErrorAttributesAdapter

@Bean
 @ConditionalOnBean(value=WebErrorHandlers.class)
 @ConditionalOnMissingBean(value=HttpErrorAttributesAdapter.class)
public HttpErrorAttributesAdapter httpErrorAttributesAdapter(ErrorsProperties errorsProperties)

In the absence of a bean of type HttpErrorAttributesAdapter, registers the default implementation of HttpErrorAttributesAdapter as a bean, to adapt our HttpError to Spring's ErrorAttributes abstraction.

Parameters:

errorsProperties - Configuration properties bean.

Returns:

The to-be-registered HttpErrorAttributesAdapter.

springSecurityWebErrorHandler

@Bean
 @ConditionalOnBean(value=WebErrorHandlers.class)
 @ConditionalOnClass(name="org.springframework.security.access.AccessDeniedException")
public SpringSecurityWebErrorHandler springSecurityWebErrorHandler()

Registers a WebErrorHandler bean to handle Spring Security specific exceptions when Spring Security's jar file is present on the classpath.

Returns:

A web error handler for Spring Security exceptions.

missingRequestParametersWebErrorHandler

@Bean
 @ConditionalOnBean(value=WebErrorHandlers.class)
 @ConditionalOnWebApplication(type=SERVLET)
 @ConditionalOnClass(name="org.springframework.web.bind.MissingRequestHeaderException")
public MissingRequestParametersWebErrorHandler missingRequestParametersWebErrorHandler()

Registers a WebErrorHandler to handle new Servlet exceptions defined in Spring Framework 5.1. This handler would be registered iff we're using Spring Boot 2.1.0+.

Returns:

A web error handler to handle a few new servlet exceptions.

responseStatusWebErrorHandler

@Bean
 @ConditionalOnBean(value=WebErrorHandlers.class)
 @ConditionalOnClass(name="org.springframework.web.server.ResponseStatusException")
public ResponseStatusWebErrorHandler responseStatusWebErrorHandler()

Registers a handler expert at handling all possible ResponseStatusExceptions.

Returns:

A web error handler to handle a set of brand new exceptions defined in Spring 5.x.

exceptionRefiner

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnBean(value=WebErrorHandlers.class)
public ExceptionRefiner exceptionRefiner()

Registers an empty ExceptionRefiner in the absence of a custom refiner.

Returns:

A no-op exception refiner.

exceptionLogger

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnBean(value=WebErrorHandlers.class)
public ExceptionLogger exceptionLogger()

Registers an empty ExceptionLogger in the absence of a custom logger.

Returns:

A no-op exception logger.

fingerprintProvider

@Bean
 @ConditionalOnMissingBean
 @ConditionalOnBean(value=WebErrorHandlers.class)
public FingerprintProvider fingerprintProvider()

Registers a very simple UUID based FingerprintProvider in the absence of a custom provider.

Returns:

The UUID based fingerprint provider.