Class WebExchangeBindException
- All Implemented Interfaces:
Serializable
,BindingResult
,Errors
,ErrorResponse
ServerWebInputException
subclass that indicates a data binding or
validation failure.- Since:
- 5.0
- Author:
- Rossen Stoyanchev
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.web.ErrorResponse
ErrorResponse.Builder, ErrorResponse.Interceptor
-
Field Summary
Fields inherited from interface org.springframework.validation.BindingResult
MODEL_KEY_PREFIX
Fields inherited from interface org.springframework.validation.Errors
NESTED_PATH_SEPARATOR
-
Constructor Summary
ConstructorDescriptionWebExchangeBindException
(MethodParameter parameter, BindingResult bindingResult) -
Method Summary
Modifier and TypeMethodDescriptionvoid
addAllErrors
(Errors errors) Add all errors from the givenErrors
instance to thisErrors
instance.void
addError
(ObjectError error) Add a customObjectError
orFieldError
to the errors list.boolean
findEditor
(String field, Class valueType) Find a custom property editor for the given type and property.Get all errors, both global and field ones.final BindingResult
Return the BindingResult that this BindException wraps.Object[]
Return arguments to use along with amessage code
to resolve the problem "detail" for this exception through aMessageSource
.Object[]
getDetailMessageArguments
(MessageSource source, Locale locale) Variant ofErrorResponse.getDetailMessageArguments()
that uses the givenMessageSource
for resolving the message argument values.int
Determine the total number of errors.Get the first error associated with a field, if any.getFieldError
(String field) Get the first error associated with the given field, if any.int
Determine the number of errors associated with a field.int
getFieldErrorCount
(String field) Determine the number of errors associated with the given field.Get all errors associated with a field.getFieldErrors
(String field) Get all errors associated with the given field.Class<?>
getFieldType
(String field) Determine the type of the given field, as far as possible.getFieldValue
(String field) Return the current value of the given field, either the current bean property value or a rejected update from the last binding.Get the first global error, if any.int
Determine the number of global errors.Get all global errors.Returns diagnostic information about the errors held in this object.getModel()
Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX
+ objectName' and the object itself as 'objectName'.Return the current nested path of thisErrors
object.Return the name of the bound root object.Return the underlying PropertyEditorRegistry.getRawFieldValue
(String field) Extract the raw field value for the given field.String[]
Return the list of fields that were suppressed during the bind process.Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.boolean
Determine if there were any errors.boolean
Determine if there were any errors associated with a field.boolean
hasFieldErrors
(String field) Determine if there were any errors associated with the given field.boolean
Determine if there were any global errors.int
hashCode()
void
Pop the former nested path from the nested path stack.void
pushNestedPath
(String subPath) Push the given sub path onto the nested path stack.void
recordFieldValue
(String field, Class<?> type, Object value) Record the given value for the specified field.void
recordSuppressedField
(String field) Mark the specified disallowed field as suppressed.void
Register a global error for the entire target object, using the given error description.void
Register a global error for the entire target object, using the given error description.void
Register a global error for the entire target object, using the given error description.void
rejectValue
(String field, String errorCode) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
rejectValue
(String field, String errorCode, Object[] errorArgs, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.void
rejectValue
(String field, String errorCode, String defaultMessage) Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.String[]
resolveMessageCodes
(String errorCode) Resolve the given error code into message codes.String[]
resolveMessageCodes
(String errorCode, String field) Resolve the given error code into message codes for the given field.void
setNestedPath
(String nestedPath) Allow context to be changed so that standard validators can validate subtrees.Methods inherited from class org.springframework.web.server.ServerWebInputException
getMethodParameter
Methods inherited from class org.springframework.web.server.ResponseStatusException
getHeaders, getReason, getResponseHeaders, 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, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.web.ErrorResponse
getTitleMessageCode, getTypeMessageCode
Methods inherited from interface org.springframework.validation.Errors
failOnError, toString
-
Constructor Details
-
WebExchangeBindException
-
-
Method Details
-
getBindingResult
Return the BindingResult that this BindException wraps.Will typically be a BeanPropertyBindingResult.
- See Also:
-
getDetailMessageArguments
Description copied from interface:ErrorResponse
Return arguments to use along with amessage code
to resolve the problem "detail" for this exception through aMessageSource
. The arguments are expanded into placeholders of the message value, e.g. "Invalid content type {0}".- Specified by:
getDetailMessageArguments
in interfaceErrorResponse
- Overrides:
getDetailMessageArguments
in classErrorResponseException
-
getDetailMessageArguments
Description copied from interface:ErrorResponse
Variant ofErrorResponse.getDetailMessageArguments()
that uses the givenMessageSource
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 suppliedMessageSource
andLocale
.- Specified by:
getDetailMessageArguments
in interfaceErrorResponse
- Parameters:
source
- theMessageSource
to use for the lookuplocale
- theLocale
to use for the lookup
-
getObjectName
Description copied from interface:Errors
Return the name of the bound root object.- Specified by:
getObjectName
in interfaceErrors
-
setNestedPath
Description copied from interface:Errors
Allow context to be changed so that standard validators can validate subtrees. Reject calls prepend the given path to the field names.For example, an address validator could validate the subobject "address" of a customer object.
The default implementation throws
UnsupportedOperationException
since not allErrors
implementations support nested paths.- Specified by:
setNestedPath
in interfaceErrors
- Parameters:
nestedPath
- nested path within this object, e.g. "address" (defaults to "",null
is also acceptable). Can end with a dot: both "address" and "address." are valid.- See Also:
-
getNestedPath
Description copied from interface:Errors
Return the current nested path of thisErrors
object.Returns a nested path with a dot, i.e. "address.", for easy building of concatenated paths. Default is an empty String.
- Specified by:
getNestedPath
in interfaceErrors
- See Also:
-
pushNestedPath
Description copied from interface:Errors
Push the given sub path onto the nested path stack.A
Errors.popNestedPath()
call will reset the original nested path before the correspondingpushNestedPath(String)
call.Using the nested path stack allows to set temporary nested paths for subobjects without having to worry about a temporary path holder.
For example: current path "spouse.", pushNestedPath("child") → result path "spouse.child."; popNestedPath() → "spouse." again.
The default implementation throws
UnsupportedOperationException
since not allErrors
implementations support nested paths.- Specified by:
pushNestedPath
in interfaceErrors
- Parameters:
subPath
- the sub path to push onto the nested path stack- See Also:
-
popNestedPath
Description copied from interface:Errors
Pop the former nested path from the nested path stack.- Specified by:
popNestedPath
in interfaceErrors
- Throws:
IllegalStateException
- if there is no former nested path on the stack- See Also:
-
reject
Description copied from interface:Errors
Register a global error for the entire target object, using the given error description. -
reject
Description copied from interface:Errors
Register a global error for the entire target object, using the given error description. -
reject
Description copied from interface:Errors
Register a global error for the entire target object, using the given error description. -
rejectValue
Description copied from interface:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- Specified by:
rejectValue
in interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message key- See Also:
-
rejectValue
Description copied from interface:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- Specified by:
rejectValue
in interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keydefaultMessage
- fallback default message- See Also:
-
rejectValue
public void rejectValue(@Nullable String field, String errorCode, @Nullable Object[] errorArgs, @Nullable String defaultMessage) Description copied from interface:Errors
Register a field error for the specified field of the current object (respecting the current nested path, if any), using the given error description.The field name may be
null
or empty String to indicate the current object itself rather than a field of it. This may result in a corresponding field error within the nested object graph or a global error if the current object is the top object.- Specified by:
rejectValue
in interfaceErrors
- Parameters:
field
- the field name (may benull
or empty String)errorCode
- error code, interpretable as a message keyerrorArgs
- error arguments, for argument binding via MessageFormat (can benull
)defaultMessage
- fallback default message- See Also:
-
addAllErrors
Description copied from interface:Errors
Add all errors from the givenErrors
instance to thisErrors
instance.This is a convenience method to avoid repeated
reject(..)
calls for merging anErrors
instance into anotherErrors
instance.Note that the passed-in
Errors
instance is supposed to refer to the same target object, or at least contain compatible errors that apply to the target object of thisErrors
instance.The default implementation throws
UnsupportedOperationException
since not allErrors
implementations support#addAllErrors
.- Specified by:
addAllErrors
in interfaceErrors
- Parameters:
errors
- theErrors
instance to merge in- See Also:
-
hasErrors
public boolean hasErrors()Description copied from interface:Errors
Determine if there were any errors. -
getErrorCount
public int getErrorCount()Description copied from interface:Errors
Determine the total number of errors.- Specified by:
getErrorCount
in interfaceErrors
- See Also:
-
getAllErrors
Description copied from interface:Errors
Get all errors, both global and field ones.- Specified by:
getAllErrors
in interfaceErrors
- Returns:
- a list of
ObjectError
/FieldError
instances - See Also:
-
hasGlobalErrors
public boolean hasGlobalErrors()Description copied from interface:Errors
Determine if there were any global errors.- Specified by:
hasGlobalErrors
in interfaceErrors
- See Also:
-
getGlobalErrorCount
public int getGlobalErrorCount()Description copied from interface:Errors
Determine the number of global errors.- Specified by:
getGlobalErrorCount
in interfaceErrors
- See Also:
-
getGlobalErrors
Description copied from interface:Errors
Get all global errors.- Specified by:
getGlobalErrors
in interfaceErrors
- Returns:
- a list of
ObjectError
instances - See Also:
-
getGlobalError
Description copied from interface:Errors
Get the first global error, if any.- Specified by:
getGlobalError
in interfaceErrors
- Returns:
- the global error, or
null
- See Also:
-
hasFieldErrors
public boolean hasFieldErrors()Description copied from interface:Errors
Determine if there were any errors associated with a field.- Specified by:
hasFieldErrors
in interfaceErrors
- See Also:
-
getFieldErrorCount
public int getFieldErrorCount()Description copied from interface:Errors
Determine the number of errors associated with a field.- Specified by:
getFieldErrorCount
in interfaceErrors
- See Also:
-
getFieldErrors
Description copied from interface:Errors
Get all errors associated with a field.- Specified by:
getFieldErrors
in interfaceErrors
- Returns:
- a List of
FieldError
instances - See Also:
-
getFieldError
Description copied from interface:Errors
Get the first error associated with a field, if any.- Specified by:
getFieldError
in interfaceErrors
- Returns:
- the field-specific error, or
null
- See Also:
-
hasFieldErrors
Description copied from interface:Errors
Determine if there were any errors associated with the given field.- Specified by:
hasFieldErrors
in interfaceErrors
- Parameters:
field
- the field name- See Also:
-
getFieldErrorCount
Description copied from interface:Errors
Determine the number of errors associated with the given field.- Specified by:
getFieldErrorCount
in interfaceErrors
- Parameters:
field
- the field name- See Also:
-
getFieldErrors
Description copied from interface:Errors
Get all errors associated with the given field.Implementations may support not only full field names like "address.street" but also pattern matches like "address.*".
- Specified by:
getFieldErrors
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- a List of
FieldError
instances - See Also:
-
getFieldError
Description copied from interface:Errors
Get the first error associated with the given field, if any.- Specified by:
getFieldError
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the field-specific error, or
null
- See Also:
-
getFieldValue
Description copied from interface:Errors
Return the current value of the given field, either the current bean property value or a rejected update from the last binding.Allows for convenient access to user-specified field values, even if there were type mismatches.
- Specified by:
getFieldValue
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the current value of the given field
- See Also:
-
getFieldType
Description copied from interface:Errors
Determine the type of the given field, as far as possible.Implementations should be able to determine the type even when the field value is
null
, for example from some associated descriptor.- Specified by:
getFieldType
in interfaceErrors
- Parameters:
field
- the field name- Returns:
- the type of the field, or
null
if not determinable - See Also:
-
getTarget
Description copied from interface:BindingResult
Return the wrapped target object, which may be a bean, an object with public fields, a Map - depending on the concrete binding strategy.- Specified by:
getTarget
in interfaceBindingResult
-
getModel
Description copied from interface:BindingResult
Return a model Map for the obtained state, exposing a BindingResult instance as 'MODEL_KEY_PREFIX
+ objectName' and the object itself as 'objectName'.Note that the Map is constructed every time you're calling this method. Adding things to the map and then re-calling this method will not work.
The attributes in the model Map returned by this method are usually included in the
ModelAndView
for a form view that uses Spring'sbind
tag in a JSP, which needs access to the BindingResult instance. Spring's pre-built form controllers will do this for you when rendering a form view. When building the ModelAndView instance yourself, you need to include the attributes from the model Map returned by this method.- Specified by:
getModel
in interfaceBindingResult
- See Also:
-
getRawFieldValue
Description copied from interface:BindingResult
Extract the raw field value for the given field. Typically used for comparison purposes.- Specified by:
getRawFieldValue
in interfaceBindingResult
- Parameters:
field
- the field to check- Returns:
- the current value of the field in its raw form, or
null
if not known
-
findEditor
Description copied from interface:BindingResult
Find a custom property editor for the given type and property.- Specified by:
findEditor
in interfaceBindingResult
- Parameters:
field
- the path of the property (name or nested path), ornull
if looking for an editor for all properties of the given typevalueType
- the type of the property (can benull
if a property is given but should be specified in any case for consistency checking)- Returns:
- the registered editor, or
null
if none
-
getPropertyEditorRegistry
Description copied from interface:BindingResult
Return the underlying PropertyEditorRegistry.- Specified by:
getPropertyEditorRegistry
in interfaceBindingResult
- Returns:
- the PropertyEditorRegistry, or
null
if none available for this BindingResult
-
resolveMessageCodes
Description copied from interface:BindingResult
Resolve the given error code into message codes.Calls the configured
MessageCodesResolver
with appropriate parameters.- Specified by:
resolveMessageCodes
in interfaceBindingResult
- Parameters:
errorCode
- the error code to resolve into message codes- Returns:
- the resolved message codes
-
resolveMessageCodes
Description copied from interface:BindingResult
Resolve the given error code into message codes for the given field.Calls the configured
MessageCodesResolver
with appropriate parameters.- Specified by:
resolveMessageCodes
in interfaceBindingResult
- Parameters:
errorCode
- the error code to resolve into message codesfield
- the field to resolve message codes for- Returns:
- the resolved message codes
-
addError
Description copied from interface:BindingResult
Add a customObjectError
orFieldError
to the errors list.Intended to be used by cooperating strategies such as
BindingErrorProcessor
.- Specified by:
addError
in interfaceBindingResult
- See Also:
-
recordFieldValue
Description copied from interface:BindingResult
Record the given value for the specified field.To be used when a target object cannot be constructed, making the original field values available through
Errors.getFieldValue(java.lang.String)
. In case of a registered error, the rejected value will be exposed for each affected field.- Specified by:
recordFieldValue
in interfaceBindingResult
- Parameters:
field
- the field to record the value fortype
- the type of the fieldvalue
- the original value
-
recordSuppressedField
Description copied from interface:BindingResult
Mark the specified disallowed field as suppressed.The data binder invokes this for each field value that was detected to target a disallowed field.
- Specified by:
recordSuppressedField
in interfaceBindingResult
- See Also:
-
getSuppressedFields
Description copied from interface:BindingResult
Return the list of fields that were suppressed during the bind process.Can be used to determine whether any field values were targeting disallowed fields.
- Specified by:
getSuppressedFields
in interfaceBindingResult
- See Also:
-
getMessage
Returns diagnostic information about the errors held in this object.- Overrides:
getMessage
in classResponseStatusException
-
equals
-
hashCode
public int hashCode()
-