me.alidg.errors.handlers

Class MissingRequestParametersWebErrorHandler

java.lang.Object

me.alidg.errors.handlers.MissingRequestParametersWebErrorHandler

All Implemented Interfaces:

WebErrorHandler

public class MissingRequestParametersWebErrorHandler
extends Object
implements WebErrorHandler

Spring Framework 5.1 added a few specific MVC exceptions for missing header, cookie, matrix variables to allow for differentiated exception handling and status codes. The main motivation of this handler is to handle those new exceptions.

We chose to handle those exceptions here (and not in SpringMvcWebErrorHandler), because this way we can conditionally register this handler iff those exceptions are present in the classpath.

Author:

Ali Dehghani

Field Summary

Fields

Modifier and Type	Field and Description
static String	MISSING_COOKIE A required cookie is missing from the request.
static String	MISSING_HEADER A required header is missing from the request.
static String	MISSING_MATRIX_VARIABLE A required matrix variable is missing from the request.

Constructor Summary

Constructors

Constructor and Description
MissingRequestParametersWebErrorHandler()

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(Throwable exception) Only can handle exceptions about missing required headers, cookies or matrix variables.
HandledException	handle(Throwable exception) Handles the given exception by selecting the appropriate error code, status code and to-be-exposed arguments conditionally.

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_HEADER

public static final String MISSING_HEADER

A required header is missing from the request.

See Also:

Constant Field Values

MISSING_COOKIE

public static final String MISSING_COOKIE

A required cookie is missing from the request.

See Also:

Constant Field Values

MISSING_MATRIX_VARIABLE

public static final String MISSING_MATRIX_VARIABLE

A required matrix variable is missing from the request.

See Also:

Constant Field Values

Constructor Detail

MissingRequestParametersWebErrorHandler

public MissingRequestParametersWebErrorHandler()

Method Detail

canHandle

public boolean canHandle(Throwable exception)

Only can handle exceptions about missing required headers, cookies or matrix variables.

Specified by:

canHandle in interface WebErrorHandler

Parameters:

exception - The exception to examine.

Returns:

true when the exception is related to missing required headers, cookies or matrix variables, false otherwise.

handle

@NonNull
public HandledException handle(Throwable exception)

Handles the given exception by selecting the appropriate error code, status code and to-be-exposed arguments conditionally.

Specified by:

handle in interface WebErrorHandler

Parameters:

exception - The exception to handle.

Returns:

The handled exception.