vertx / io.vertx.reactivex.ext.web.api.validation

Package io.vertx.reactivex.ext.web.api.validation

Types

ContainerDeserializer

open class ContainerDeserializer

Interface that define methods for deserialization of array and objects NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.ContainerDeserializer non RX-ified interface using Vert.x codegen.

CustomValidator

open class CustomValidator

This interface is used to add custom synchronous functions inside validation process. You can add it in io.vertx.reactivex.ext.web.api.validation.HTTPRequestValidationHandler. NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.CustomValidator non RX-ified interface using Vert.x codegen.

HTTPRequestValidationHandler

open class HTTPRequestValidationHandler : ValidationHandler, Handler<RoutingContext>

An interface for add HTTP Request validation. This class can validate parameters inside query, path, headers an body (watch below) You can assign multiple body type at the same time(for example a JSON schema together with a XML schema). This interface support:

  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/xml
  • application/json
Also you can add a form parameter for validation without care about content type of your request. For form parameters this interface support both "multipart/form-data" and "application/x-www-form-urlencoded" This interface allow extra parameters in the request, so it doesn't care if in a request there's a parameter without a specified validation rule If a parameter is flagged as an array, it will be validated also if the size of array is 1 element NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.HTTPRequestValidationHandler non RX-ified interface using Vert.x codegen.

ParameterTypeValidator

open class ParameterTypeValidator

Interface for declaration of method for validate a specific parameter type. If you want to implement your own type validator, you need only to implement io.vertx.reactivex.ext.web.api.validation.ParameterTypeValidator#isValid:

  • If parameter is valid, call to put value (maybe modified) inside RequestParameters. The validation flow will care about set parameter name
  • If parameter is invalid, throw a new ValidationException with message (io.vertx.reactivex.ext.web.api.validation.ValidationException) and/or with io.vertx.reactivex.ext.web.api.validation.ValidationException.ErrorType (). As for value, the validation flow will care about setting all other ValidationException fields
NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.ParameterTypeValidator non RX-ified interface using Vert.x codegen.

ParameterValidationRule

open class ParameterValidationRule

This function is an inner wrapper for ParameterTypeValidator inside ValidationHandler parameter maps. Don't instantiate this class, if you want to add custom ParameterTypeValidator to a parameter use functions in io.vertx.reactivex.ext.web.api.validation.HTTPRequestValidationHandler NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.ParameterValidationRule non RX-ified interface using Vert.x codegen.

ValidationHandler

interface ValidationHandler : Handler<RoutingContext>

Base interface for validation. For basic HTTP Request Validator, use io.vertx.reactivex.ext.web.api.validation.HTTPRequestValidationHandler NOTE: This class has been automatically generated from the io.vertx.ext.web.api.validation.ValidationHandler non RX-ified interface using Vert.x codegen.