me.alidg.errors

Class WebErrorHandlers

java.lang.Object

me.alidg.errors.WebErrorHandlers

public class WebErrorHandlers
extends Object

A factory over WebErrorHandler implementations. The factory would query all the implementations to find an appropriate exception handler to handle a particular exception.

Code to Message Translation

The WebErrorHandlers is also responsible for Error Code to Error Message translation and i18n (RIP SRP!). In order to fulfill this requirement, we need an instance of MessageSource to translate error codes to error messages.

Default Exception Handler

By default, when we couldn't find any WebErrorHandler implementation to handle the exception, we would use the LastResortWebErrorHandler as the default exception handler. If you don't like its exception handling approach, consider passing a valid non-null defaultWebErrorHandler to the constructor.

Author:

Ali Dehghani

See Also:

WebErrorHandler, HandledException, LastResortWebErrorHandler

Constructor Summary

Constructors

Constructor and Description
WebErrorHandlers(org.springframework.context.MessageSource messageSource, List<WebErrorHandler> webErrorHandlers, WebErrorHandler defaultWebErrorHandler, ExceptionRefiner exceptionRefiner, ExceptionLogger exceptionLogger) Deprecated. Use builder(MessageSource) instead.

Method Summary

Modifier and Type	Method and Description
static WebErrorHandlersBuilder	builder(org.springframework.context.MessageSource messageSource) A nexus to the WebErrorHandlersBuilder API.
HttpError	handle(Throwable originalException, Object httpRequest, Locale locale) Given any exception, first it would select an appropriate exception handler or falls back to a default handler and then tries to handle the exception using the chosen handler.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebErrorHandlers

@Deprecated
public WebErrorHandlers(@NonNull
                                    org.springframework.context.MessageSource messageSource,
                                    @NonNull
                                    List<WebErrorHandler> webErrorHandlers,
                                    @Nullable
                                    WebErrorHandler defaultWebErrorHandler,
                                    @Nullable
                                    ExceptionRefiner exceptionRefiner,
                                    @Nullable
                                    ExceptionLogger exceptionLogger)

Deprecated. Use builder(MessageSource) instead.

Backward-compatible constructor with defaults for webErrorHandlerPostProcessors

Parameters:

messageSource - The code to message translator.

webErrorHandlers - Collection of WebErrorHandler implementations.

defaultWebErrorHandler - Fallback web error handler.

exceptionRefiner - Possibly can refine exceptions before handling them.

exceptionLogger - Logs exceptions.

Method Detail

builder

public static WebErrorHandlersBuilder builder(@NonNull
                                              org.springframework.context.MessageSource messageSource)

A nexus to the WebErrorHandlersBuilder API.

Parameters:

messageSource - The abstraction responsible for converting error codes to messages.

Returns:

A WebErrorHandlersBuilder in its initial state.

Throws:

NullPointerException - When the given message source is missing.

handle

@NonNull
public HttpError handle(@Nullable
                                 Throwable originalException,
                                 @Nullable
                                 Object httpRequest,
                                 @Nullable
                                 Locale locale)

Given any exception, first it would select an appropriate exception handler or falls back to a default handler and then tries to handle the exception using the chosen handler. Then would convert the HandledException to its corresponding HttpError.

Parameters:

originalException - The originalException to handle.

httpRequest - The current HTTP request.

locale - Will be used to target a specific locale while translating the codes to error messages.

Returns:

An HttpError instance containing both error and message combinations and also, the intended HTTP Status Code.