org.zalando.problem.spring.web.advice.validation

Interface ValidationAdviceTrait

All Superinterfaces:

BaseBindingResultAdviceTrait, BindAdviceTrait, ConstraintViolationAdviceTrait, MethodArgumentNotValidAdviceTrait

All Known Subinterfaces:

ProblemHandling

@API(status=STABLE)
public interface ValidationAdviceTrait
extends ConstraintViolationAdviceTrait, BindAdviceTrait, MethodArgumentNotValidAdviceTrait

Advice trait to handle any validation exceptions.

Be careful if you use MethodValidationPostProcessor in order to validate method parameter field directly but violations[].field value looks like arg0 instead of parameter name, you have to configure a LocalValidatorFactoryBean with your MethodValidationPostProcessor like following:

  @Bean
  public Validator validator() {
      return new LocalValidatorFactoryBean();
  }

  @Bean
  public MethodValidationPostProcessor methodValidationPostProcessor() {
      MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
      methodValidationPostProcessor.setValidator(validator());
      return methodValidationPostProcessor;
  }
 

See Also:

AdviceTrait

Method Summary

Modifier and Type	Method and Description
default org.zalando.problem.StatusType	defaultConstraintViolationStatus()
default URI	defaultConstraintViolationType()
default String	formatFieldName(String fieldName) Format the name of a violating field (e.g.
default org.springframework.http.ResponseEntity<org.zalando.problem.Problem>	newConstraintViolationProblem(Throwable throwable, Collection<Violation> stream, org.springframework.web.context.request.NativeWebRequest request)

Methods inherited from interface org.zalando.problem.spring.web.advice.validation.ConstraintViolationAdviceTrait

createViolation, handleConstraintViolation

Methods inherited from interface org.zalando.problem.spring.web.advice.validation.BindAdviceTrait

handleBindingResult

Methods inherited from interface org.zalando.problem.spring.web.advice.validation.MethodArgumentNotValidAdviceTrait

handleMethodArgumentNotValid

Methods inherited from interface org.zalando.problem.spring.web.advice.validation.BaseBindingResultAdviceTrait

createViolation, createViolation, createViolations

Methods inherited from interface org.zalando.problem.spring.web.advice.AdviceTrait

create, create, create, create, create, create, create, create, create, fallback, log, negotiate, process

Methods inherited from interface org.zalando.problem.spring.common.AdviceTrait

createStackTrace, isCausalChainsEnabled, prepare, process, resolveResponseStatus, toProblem, toProblem, toProblem

Method Detail

defaultConstraintViolationType

default URI defaultConstraintViolationType()

defaultConstraintViolationStatus

default org.zalando.problem.StatusType defaultConstraintViolationStatus()

formatFieldName

default String formatFieldName(String fieldName)

Format the name of a violating field (e.g. lower camel to snake case)

Parameters:

fieldName - the field name to format

Returns:

the formatted field name, defaults to the parameter, i.e. doesn't apply any transformation

newConstraintViolationProblem

default org.springframework.http.ResponseEntity<org.zalando.problem.Problem> newConstraintViolationProblem(Throwable throwable,
                                                                                                           Collection<Violation> stream,
                                                                                                           org.springframework.web.context.request.NativeWebRequest request)