me.alidg.errors

Interface WebErrorHandler

All Known Implementing Classes:

AnnotatedWebErrorHandler, ConstraintViolationWebErrorHandler, LastResortWebErrorHandler, MissingRequestParametersWebErrorHandler, SpringMvcWebErrorHandler, SpringSecurityWebErrorHandler, SpringValidationWebErrorHandler

public interface WebErrorHandler

Defines a contract to handle exceptions in the Web layer and convert them to appropriate error codes with meaningful status codes. This is a contract for exception handling and nobody's gonna handle the exceptions thrown by the contract methods, so do not throw exceptions in your method implementations.

Author:

Ali Dehghani

Implementation Note:

Do not throw exceptions in method implementations.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(Throwable exception) Determines whether this particular implementation can handle the given exception or not.
HandledException	handle(Throwable exception) Handles the given exception and returns an instance of HandledException.

Method Detail

canHandle

boolean canHandle(@Nullable
                  Throwable exception)

Determines whether this particular implementation can handle the given exception or not.

Parameters:

exception - The exception to examine.

Returns:

true if this implementation can handle the exception, false otherwise.

handle

@NonNull
HandledException handle(@Nullable
                                 Throwable exception)

Handles the given exception and returns an instance of HandledException. This method should be called iff the call to canHandle(Throwable) for the same exception returns true.

Parameters:

exception - The exception to handle.

Returns:

A set of error codes.