package io.vertx.ext.web.api.validation;

import io.vertx.codegen.annotations.Fluent;
import io.vertx.codegen.annotations.VertxGen;
import io.vertx.ext.web.api.validation.impl.HTTPRequestValidationHandlerImpl;

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
Author:Francesco Guardiani @slinkydeveloper
/** * An interface for add HTTP Request validation. This class can validate parameters inside query, path, headers an * body (watch below) * <br/> * You can assign multiple body type at the same time(for example a JSON schema together with a XML schema). This * interface support: * <ul> * <li>application/x-www-form-urlencoded</li> * <li>multipart/form-data</li> * <li>application/xml</li> * <li>application/json</li> * </ul> * 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" * <br/> * 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 * <br/> * If a parameter is flagged as an array, it will be validated also if the size of array is 1 element * * @author Francesco Guardiani @slinkydeveloper */
@VertxGen public interface HTTPRequestValidationHandler extends ValidationHandler {
Factory method to create an HTTPRequestValidationHandler
Returns:new HTTPRequestValidationHandler
/** * Factory method to create an HTTPRequestValidationHandler * * @return new HTTPRequestValidationHandler */
static HTTPRequestValidationHandler create() { return new HTTPRequestValidationHandlerImpl(); }
Add a path parameter with included parameter types. All path params are required
Params:
  • parameterName – expected name of parameter inside the path
  • type – expected type of parameter
Returns:this handler
/** * Add a path parameter with included parameter types. All path params are <b>required</b> * * @param parameterName expected name of parameter inside the path * @param type expected type of parameter * @return this handler */
@Fluent HTTPRequestValidationHandler addPathParam(String parameterName, ParameterType type);
Add a path parameter with a custom pattern. All path params are required
Params:
  • parameterName – expected name of parameter inside the path
  • pattern – regular expression for validation
Returns:this handler
/** * Add a path parameter with a custom pattern. All path params are <b>required</b> * * @param parameterName expected name of parameter inside the path * @param pattern regular expression for validation * @return this handler */
@Fluent HTTPRequestValidationHandler addPathParamWithPattern(String parameterName, String pattern);
Add a path parameter with a custom type validator. All path params are required. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator
Params:
  • parameterName – expected name of parameter inside the path
  • validator – type validator
  • allowEmptyValue – true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
Returns:this handler
/** * Add a path parameter with a custom type validator. All path params are <b>required</b>. For more informations * about how to construct built-in or custom type validator, check out {@link ParameterTypeValidator} * * @param parameterName expected name of parameter inside the path * @param validator type validator * @param allowEmptyValue true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: * {@link ParameterValidationRule#allowEmptyValue()} * @return this handler */
@Fluent HTTPRequestValidationHandler addPathParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean allowEmptyValue);
Add a query parameter with included parameter types
Params:
  • parameterName – expected name of parameter inside the query
  • type – expected type of parameter
  • required – true if parameter is required
Returns:this handler
/** * Add a query parameter with included parameter types * * @param parameterName expected name of parameter inside the query * @param type expected type of parameter * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addQueryParam(String parameterName, ParameterType type, boolean required);
Add a query parameter with a custom pattern
Params:
  • parameterName – expected name of parameter inside the query
  • pattern – regular expression for validation
  • required – true if parameter is required
Returns:this handler
/** * Add a query parameter with a custom pattern * * @param parameterName expected name of parameter inside the query * @param pattern regular expression for validation * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addQueryParamWithPattern(String parameterName, String pattern, boolean required);
Add a query parameters array with included parameter types
Params:
  • arrayName – expected name of array inside the query
  • type – expected type of parameter
  • required – true if parameter is required
Returns:this handler
/** * Add a query parameters array with included parameter types * * @param arrayName expected name of array inside the query * @param type expected type of parameter * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addQueryParamsArray(String arrayName, ParameterType type, boolean required);
Add a query parameters array with a custom pattern
Params:
  • arrayName – expected name of array inside the query
  • pattern – regular expression for validation
  • required – true if parameter is required
Returns:this handler
/** * Add a query parameters array with a custom pattern * * @param arrayName expected name of array inside the query * @param pattern regular expression for validation * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addQueryParamsArrayWithPattern(String arrayName, String pattern, boolean required);
Add a query parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator
Params:
  • parameterName – expected name of parameter inside the query
  • validator – type validator
  • required – true if parameter is required
  • allowEmptyValue – true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
Returns:this handler
/** * Add a query parameter with a custom type validator. For more informations about how to construct built-in or * custom type validator, check out {@link ParameterTypeValidator} * * @param parameterName expected name of parameter inside the query * @param validator type validator * @param required true if parameter is required * @param allowEmptyValue true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: * {@link ParameterValidationRule#allowEmptyValue()} * @return this handler */
@Fluent HTTPRequestValidationHandler addQueryParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue);
Add a header parameter with included parameter types
Params:
  • headerName – expected header name
  • type – expected type of parameter
  • required – true if parameter is required
Returns:this handler
/** * Add a header parameter with included parameter types * * @param headerName expected header name * @param type expected type of parameter * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addHeaderParam(String headerName, ParameterType type, boolean required);
Add a header parameter with a custom pattern
Params:
  • headerName – expected header name
  • pattern – regular expression for validation
  • required – true if parameter is required
Returns:this handler
/** * Add a header parameter with a custom pattern * * @param headerName expected header name * @param pattern regular expression for validation * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addHeaderParamWithPattern(String headerName, String pattern, boolean required);
Add a header parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator
Params:
  • headerName – expected header namery
  • validator – type validator
  • required – true if parameter is required
  • allowEmptyValue – true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
Returns:this handler
/** * Add a header parameter with a custom type validator. For more informations about how to construct built-in or * custom type validator, check out {@link ParameterTypeValidator} * * @param headerName expected header namery * @param validator type validator * @param required true if parameter is required * @param allowEmptyValue true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: * {@link ParameterValidationRule#allowEmptyValue()} * @return this handler */
@Fluent HTTPRequestValidationHandler addHeaderParamWithCustomTypeValidator(String headerName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue);
Add a single parameter inside a form with included parameter types
Params:
  • parameterName – expected name of parameter inside the form
  • type – expected type of parameter
  • required – true if parameter is required
Returns:this handler
/** * Add a single parameter inside a form with included parameter types * * @param parameterName expected name of parameter inside the form * @param type expected type of parameter * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addFormParam(String parameterName, ParameterType type, boolean required);
Add a single parameter inside a form with a custom pattern
Params:
  • parameterName – expected name of parameter inside the form
  • pattern – regular expression for validation
  • required – true if parameter is required
Returns:this handler
/** * Add a single parameter inside a form with a custom pattern * * @param parameterName expected name of parameter inside the form * @param pattern regular expression for validation * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addFormParamWithPattern(String parameterName, String pattern, boolean required);
Add a form parameters array with included parameter types
Params:
  • parameterName – expected name of array of parameters inside the form
  • type – expected type of array of parameters
  • required – true if parameter is required
Returns:this handler
/** * Add a form parameters array with included parameter types * * @param parameterName expected name of array of parameters inside the form * @param type expected type of array of parameters * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addFormParamsArray(String parameterName, ParameterType type, boolean required);
Add a form parameters array with a custom pattern
Params:
  • parameterName – expected name of array of parameters inside the form
  • pattern – regular expression for validation
  • required – true if parameter is required
Returns:this handler
/** * Add a form parameters array with a custom pattern * * @param parameterName expected name of array of parameters inside the form * @param pattern regular expression for validation * @param required true if parameter is required * @return this handler */
@Fluent HTTPRequestValidationHandler addFormParamsArrayWithPattern(String parameterName, String pattern, boolean required);
Add a form parameter with a custom type validator. For more informations about how to construct built-in or custom type validator, check out ParameterTypeValidator
Params:
  • parameterName – expected name of parameter inside the form
  • validator – type validator
  • required – true if parameter is required
  • allowEmptyValue – true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
Returns:this handler
/** * Add a form parameter with a custom type validator. For more informations about how to construct built-in or * custom type validator, check out {@link ParameterTypeValidator} * * @param parameterName expected name of parameter inside the form * @param validator type validator * @param required true if parameter is required * @param allowEmptyValue true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: * {@link ParameterValidationRule#allowEmptyValue()} * @return this handler */
@Fluent HTTPRequestValidationHandler addFormParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue);
Add a custom validator. For more informations about custom validator, see CustomValidator
Params:
  • customValidator –
Returns:this handler
/** * Add a custom validator. For more informations about custom validator, see {@link CustomValidator} * * @param customValidator * @return this handler */
@Fluent HTTPRequestValidationHandler addCustomValidatorFunction(CustomValidator customValidator);
Add a json schema for body with Content-Type "application/json"
Params:
  • jsonSchema –
Returns:this handler
/** * Add a json schema for body with Content-Type "application/json" * * @param jsonSchema * @return this handler */
@Fluent HTTPRequestValidationHandler addJsonBodySchema(String jsonSchema);
Add a xml schema for body with Content-Type "application/xml"
Params:
  • xmlSchema –
Returns:this handler
/** * Add a xml schema for body with Content-Type "application/xml" * * @param xmlSchema * @return this handler */
@Fluent HTTPRequestValidationHandler addXMLBodySchema(String xmlSchema);
Add an expected filename inside multipart request.
Params:
  • filename – name of the file inside the form
  • contentType – expected content type of file
Returns:this handler
/** * Add an expected filename inside <b>multipart request</b>. * * @param filename name of the file inside the form * @param contentType expected content type of file * @return this handler */
@Fluent HTTPRequestValidationHandler addMultipartRequiredFile(String filename, String contentType);
Add an expected content type of request. It's not needed to add application/json, application/xml, multipart/form-data and application/x-www-form-urlencoded
Params:
  • contentType – expected content type of file
Returns:this handler
/** * Add an expected content type of request. It's not needed to add application/json, application/xml, * multipart/form-data and application/x-www-form-urlencoded * * @param contentType expected content type of file * @return this handler */
@Fluent HTTPRequestValidationHandler addExpectedContentType(String contentType); }