Package com.broadleafcommerce.common.error.validation.web

Class ApiValidationWebExceptionAdvisor

java.lang.Object

com.broadleafcommerce.common.error.validation.web.ApiValidationWebExceptionAdvisor

@RestControllerAdvice(annotations=org.springframework.web.bind.annotation.ResponseBody.class)
public class ApiValidationWebExceptionAdvisor
extends Object

Exception resolver for ValidationException along with Spring bind exceptions that are annotated with @Valid

Author:

Phillip Verheyden (phillipuniverse)

Constructor Summary

Constructors

Constructor	Description
ApiValidationWebExceptionAdvisor(org.springframework.context.MessageSource messages)

Method Summary

Modifier and Type	Method	Description
protected FieldValidationError	convert(org.springframework.validation.FieldError from)	Turns a Spring FieldError from an Errors into a response object to return from the API
protected GlobalError	convert(org.springframework.validation.ObjectError from)
protected org.springframework.http.ResponseEntity<Object>	createValidationResponse(Set<jakarta.validation.ConstraintViolation<?>> violations)
protected org.springframework.http.ResponseEntity<Object>	createValidationResponse(org.springframework.validation.Errors errors)
protected void	logDebug(Exception ex, org.springframework.web.context.request.WebRequest request)
org.springframework.http.ResponseEntity<Object>	validationError(Exception ex, org.springframework.web.context.request.WebRequest request)

Methods inherited from class java.lang.Object

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

Constructor Details

ApiValidationWebExceptionAdvisor

public ApiValidationWebExceptionAdvisor(org.springframework.context.MessageSource messages)

Method Details

validationError

@ExceptionHandler({ValidationException.class,org.springframework.validation.BindException.class,org.springframework.web.bind.MethodArgumentNotValidException.class,jakarta.validation.ConstraintViolationException.class})
public org.springframework.http.ResponseEntity<Object> validationError(Exception ex,
 org.springframework.web.context.request.WebRequest request)
                                                                throws Exception

Throws:

Exception

logDebug

protected void logDebug(Exception ex,
 org.springframework.web.context.request.WebRequest request)

createValidationResponse

protected org.springframework.http.ResponseEntity<Object> createValidationResponse(Set<jakarta.validation.ConstraintViolation<?>> violations)

createValidationResponse

protected org.springframework.http.ResponseEntity<Object> createValidationResponse(@NonNull
 org.springframework.validation.Errors errors)

convert

protected FieldValidationError convert(org.springframework.validation.FieldError from)

Turns a Spring FieldError from an Errors into a response object to return from the API

Parameters:

from - the FieldError to convert

Returns:

an API response version of a field validation error

convert

protected GlobalError convert(org.springframework.validation.ObjectError from)