Package org.springframework.web.method.annotation

Class HandlerMethodValidationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.springframework.core.NestedRuntimeException

org.springframework.web.ErrorResponseException

org.springframework.web.server.ResponseStatusException

org.springframework.web.method.annotation.HandlerMethodValidationException

All Implemented Interfaces:

Serializable, MethodValidationResult, ErrorResponse

public class HandlerMethodValidationException
extends ResponseStatusException
implements MethodValidationResult

ResponseStatusException that is also MethodValidationResult. Raised by HandlerMethodValidator in case of method validation errors on a web controller method.

The ErrorResponseException.getStatusCode() is 400 for input validation errors, and 500 for validation errors on a return value.

Since:

6.1

Author:

Rossen Stoyanchev

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HandlerMethodValidationException.Visitor	Contract to handle validation results with callbacks by controller method parameter type, with HandlerMethodValidationException.Visitor.other(org.springframework.validation.method.ParameterValidationResult) serving as the fallthrough.

Nested classes/interfaces inherited from interface org.springframework.web.ErrorResponse

ErrorResponse.Builder, ErrorResponse.Interceptor

Constructor Summary

Constructors

Constructor	Description
HandlerMethodValidationException(MethodValidationResult validationResult)
HandlerMethodValidationException(MethodValidationResult validationResult, Predicate<MethodParameter> modelAttributePredicate, Predicate<MethodParameter> requestParamPredicate)

Method Summary

Modifier and Type	Method	Description
List<MessageSourceResolvable>	getCrossParameterValidationResults()	Return errors from cross-parameter validation.
Object[]	getDetailMessageArguments()	Return arguments to use along with a message code to resolve the problem "detail" for this exception through a MessageSource.
Object[]	getDetailMessageArguments(MessageSource messageSource, Locale locale)	Variant of ErrorResponse.getDetailMessageArguments() that uses the given MessageSource for resolving the message argument values.
Method	getMethod()	Return the method to which validation was applied.
List<ParameterValidationResult>	getParameterValidationResults()	Return all validation results per method parameter, including both MethodValidationResult.getValueResults() and MethodValidationResult.getBeanResults().
Object	getTarget()	Return the target of the method invocation to which validation was applied.
boolean	isForReturnValue()	Whether the violations are for a return value.
void	visitResults(HandlerMethodValidationException.Visitor visitor)	Provide a Visitor to handle ParameterValidationResults through callback methods organized by controller method parameter type.

Methods inherited from class org.springframework.web.server.ResponseStatusException

getHeaders, getMessage, getReason, updateAndGetBody

Methods inherited from class org.springframework.web.ErrorResponseException

getBody, getDetailMessageCode, getStatusCode, setDetail, setInstance, setTitle, setType

Methods inherited from class org.springframework.core.NestedRuntimeException

contains, getMostSpecificCause, getRootCause

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.ErrorResponse

getTitleMessageCode, getTypeMessageCode

Methods inherited from interface org.springframework.validation.method.MethodValidationResult

getAllErrors, getBeanResults, getValueResults, hasErrors

Constructor Details

HandlerMethodValidationException

public HandlerMethodValidationException(MethodValidationResult validationResult)

HandlerMethodValidationException

public HandlerMethodValidationException(MethodValidationResult validationResult,
 Predicate<MethodParameter> modelAttributePredicate,
 Predicate<MethodParameter> requestParamPredicate)

Method Details

getDetailMessageArguments

public Object[] getDetailMessageArguments(MessageSource messageSource,
 Locale locale)

Description copied from interface: ErrorResponse

Variant of ErrorResponse.getDetailMessageArguments() that uses the given MessageSource for resolving the message argument values.

This is useful for example to expand message codes from validation errors.

The default implementation delegates to ErrorResponse.getDetailMessageArguments(), ignoring the supplied MessageSource and Locale.

Specified by:

getDetailMessageArguments in interface ErrorResponse

Parameters:

messageSource - the MessageSource to use for the lookup

locale - the Locale to use for the lookup

getDetailMessageArguments

public Object[] getDetailMessageArguments()

Description copied from interface: ErrorResponse

Return arguments to use along with a message code to resolve the problem "detail" for this exception through a MessageSource. The arguments are expanded into placeholders of the message value, for example, "Invalid content type {0}".

Specified by:

getDetailMessageArguments in interface ErrorResponse

Overrides:

getDetailMessageArguments in class ErrorResponseException

getTarget

public Object getTarget()

Description copied from interface: MethodValidationResult

Return the target of the method invocation to which validation was applied.

Specified by:

getTarget in interface MethodValidationResult

getMethod

public Method getMethod()

Description copied from interface: MethodValidationResult

Return the method to which validation was applied.

Specified by:

getMethod in interface MethodValidationResult

isForReturnValue

public boolean isForReturnValue()

Description copied from interface: MethodValidationResult

Whether the violations are for a return value. If true the violations are from validating a return value. If false the violations are from validating method arguments.

Specified by:

isForReturnValue in interface MethodValidationResult

getParameterValidationResults

public List<ParameterValidationResult> getParameterValidationResults()

Description copied from interface: MethodValidationResult

Return all validation results per method parameter, including both MethodValidationResult.getValueResults() and MethodValidationResult.getBeanResults().

Use MethodValidationResult.getCrossParameterValidationResults() for access to errors from cross-parameter validation.

Specified by:

getParameterValidationResults in interface MethodValidationResult

See Also:

• MethodValidationResult.getValueResults()
• MethodValidationResult.getBeanResults()

getCrossParameterValidationResults

public List<MessageSourceResolvable> getCrossParameterValidationResults()

Description copied from interface: MethodValidationResult

Return errors from cross-parameter validation.

Specified by:

getCrossParameterValidationResults in interface MethodValidationResult

visitResults

public void visitResults(HandlerMethodValidationException.Visitor visitor)

Provide a Visitor to handle ParameterValidationResults through callback methods organized by controller method parameter type.