public class HTTPRequestValidationHandler extends Object implements ValidationHandler, Handler<RoutingContext>
original
non RX-ified interface using Vert.x codegen.Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<HTTPRequestValidationHandler> |
__TYPE_ARG |
Constructor and Description |
---|
HTTPRequestValidationHandler(HTTPRequestValidationHandler delegate) |
HTTPRequestValidationHandler(Object delegate) |
Modifier and Type | Method and Description |
---|---|
HTTPRequestValidationHandler |
addCustomValidatorFunction(CustomValidator customValidator)
Add a custom validator.
|
HTTPRequestValidationHandler |
addExpectedContentType(String contentType)
Add an expected content type of request.
|
HTTPRequestValidationHandler |
addFormParam(String parameterName,
ParameterType type,
boolean required)
Add a single parameter inside a form with included parameter types
|
HTTPRequestValidationHandler |
addFormParamsArray(String parameterName,
ParameterType type,
boolean required)
Add a form parameters array with included parameter types
|
HTTPRequestValidationHandler |
addFormParamsArrayWithPattern(String parameterName,
String pattern,
boolean required)
Add a form parameters array with a custom pattern
|
HTTPRequestValidationHandler |
addFormParamWithCustomTypeValidator(String parameterName,
ParameterTypeValidator validator,
boolean required,
boolean allowEmptyValue)
Add a form parameter with a custom type validator.
|
HTTPRequestValidationHandler |
addFormParamWithPattern(String parameterName,
String pattern,
boolean required)
Add a single parameter inside a form with a custom pattern
|
HTTPRequestValidationHandler |
addHeaderParam(String headerName,
ParameterType type,
boolean required)
Add a header parameter with included parameter types
|
HTTPRequestValidationHandler |
addHeaderParamWithCustomTypeValidator(String headerName,
ParameterTypeValidator validator,
boolean required,
boolean allowEmptyValue)
Add a header parameter with a custom type validator.
|
HTTPRequestValidationHandler |
addHeaderParamWithPattern(String headerName,
String pattern,
boolean required)
Add a header parameter with a custom pattern
|
HTTPRequestValidationHandler |
addJsonBodySchema(String jsonSchema)
Add a json schema for body with Content-Type "application/json"
|
HTTPRequestValidationHandler |
addMultipartRequiredFile(String filename,
String contentType)
Add an expected filename inside multipart request.
|
HTTPRequestValidationHandler |
addPathParam(String parameterName,
ParameterType type)
Add a path parameter with included parameter types.
|
HTTPRequestValidationHandler |
addPathParamWithCustomTypeValidator(String parameterName,
ParameterTypeValidator validator,
boolean allowEmptyValue)
Add a path parameter with a custom type validator.
|
HTTPRequestValidationHandler |
addPathParamWithPattern(String parameterName,
String pattern)
Add a path parameter with a custom pattern.
|
HTTPRequestValidationHandler |
addQueryParam(String parameterName,
ParameterType type,
boolean required)
Add a query parameter with included parameter types
|
HTTPRequestValidationHandler |
addQueryParamsArray(String arrayName,
ParameterType type,
boolean required)
Add a query parameters array with included parameter types
|
HTTPRequestValidationHandler |
addQueryParamsArrayWithPattern(String arrayName,
String pattern,
boolean required)
Add a query parameters array with a custom pattern
|
HTTPRequestValidationHandler |
addQueryParamWithCustomTypeValidator(String parameterName,
ParameterTypeValidator validator,
boolean required,
boolean allowEmptyValue)
Add a query parameter with a custom type validator.
|
HTTPRequestValidationHandler |
addQueryParamWithPattern(String parameterName,
String pattern,
boolean required)
Add a query parameter with a custom pattern
|
HTTPRequestValidationHandler |
addXMLBodySchema(String xmlSchema)
Add a xml schema for body with Content-Type "application/xml"
|
static HTTPRequestValidationHandler |
create()
Factory method to create an HTTPRequestValidationHandler
|
boolean |
equals(Object o) |
HTTPRequestValidationHandler |
getDelegate() |
void |
handle(RoutingContext event)
Something has happened, so handle it.
|
int |
hashCode() |
static HTTPRequestValidationHandler |
newInstance(HTTPRequestValidationHandler arg) |
String |
toString() |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
newInstance
public static final io.vertx.lang.rx.TypeArg<HTTPRequestValidationHandler> __TYPE_ARG
public HTTPRequestValidationHandler(HTTPRequestValidationHandler delegate)
public HTTPRequestValidationHandler(Object delegate)
public HTTPRequestValidationHandler getDelegate()
getDelegate
in interface ValidationHandler
public void handle(RoutingContext event)
handle
in interface Handler<RoutingContext>
handle
in interface ValidationHandler
event
- the event to handlepublic static HTTPRequestValidationHandler create()
public HTTPRequestValidationHandler addPathParam(String parameterName, ParameterType type)
parameterName
- expected name of parameter inside the pathtype
- expected type of parameterpublic HTTPRequestValidationHandler addPathParamWithPattern(String parameterName, String pattern)
parameterName
- expected name of parameter inside the pathpattern
- regular expression for validationpublic HTTPRequestValidationHandler addPathParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean allowEmptyValue)
ParameterTypeValidator
parameterName
- expected name of parameter inside the pathvalidator
- type validatorallowEmptyValue
- true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
public HTTPRequestValidationHandler addQueryParam(String parameterName, ParameterType type, boolean required)
parameterName
- expected name of parameter inside the querytype
- expected type of parameterrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addQueryParamWithPattern(String parameterName, String pattern, boolean required)
parameterName
- expected name of parameter inside the querypattern
- regular expression for validationrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addQueryParamsArray(String arrayName, ParameterType type, boolean required)
arrayName
- expected name of array inside the querytype
- expected type of parameterrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addQueryParamsArrayWithPattern(String arrayName, String pattern, boolean required)
arrayName
- expected name of array inside the querypattern
- regular expression for validationrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addQueryParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue)
ParameterTypeValidator
parameterName
- expected name of parameter inside the queryvalidator
- type validatorrequired
- true if parameter is requiredallowEmptyValue
- true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
public HTTPRequestValidationHandler addHeaderParam(String headerName, ParameterType type, boolean required)
headerName
- expected header nametype
- expected type of parameterrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addHeaderParamWithPattern(String headerName, String pattern, boolean required)
headerName
- expected header namepattern
- regular expression for validationrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addHeaderParamWithCustomTypeValidator(String headerName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue)
ParameterTypeValidator
headerName
- expected header nameryvalidator
- type validatorrequired
- true if parameter is requiredallowEmptyValue
- true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
public HTTPRequestValidationHandler addFormParam(String parameterName, ParameterType type, boolean required)
parameterName
- expected name of parameter inside the formtype
- expected type of parameterrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addFormParamWithPattern(String parameterName, String pattern, boolean required)
parameterName
- expected name of parameter inside the formpattern
- regular expression for validationrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addFormParamsArray(String parameterName, ParameterType type, boolean required)
parameterName
- expected name of array of parameters inside the formtype
- expected type of array of parametersrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addFormParamsArrayWithPattern(String parameterName, String pattern, boolean required)
parameterName
- expected name of array of parameters inside the formpattern
- regular expression for validationrequired
- true if parameter is requiredpublic HTTPRequestValidationHandler addFormParamWithCustomTypeValidator(String parameterName, ParameterTypeValidator validator, boolean required, boolean allowEmptyValue)
ParameterTypeValidator
parameterName
- expected name of parameter inside the formvalidator
- type validatorrequired
- true if parameter is requiredallowEmptyValue
- true if parameter allowEmptyValue. For more informations about allowEmptyValue behaviour: ParameterValidationRule.allowEmptyValue()
public HTTPRequestValidationHandler addCustomValidatorFunction(CustomValidator customValidator)
CustomValidator
customValidator
- public HTTPRequestValidationHandler addJsonBodySchema(String jsonSchema)
jsonSchema
- public HTTPRequestValidationHandler addXMLBodySchema(String xmlSchema)
xmlSchema
- public HTTPRequestValidationHandler addMultipartRequiredFile(String filename, String contentType)
filename
- name of the file inside the formcontentType
- expected content type of filepublic HTTPRequestValidationHandler addExpectedContentType(String contentType)
contentType
- expected content type of filepublic static HTTPRequestValidationHandler newInstance(HTTPRequestValidationHandler arg)
Copyright © 2023 Eclipse. All rights reserved.