Index (vertx-web-api-contract 3.5.1 API)

A B C D E F G H I M N O P Q R S T V

A

addCustomValidatorFunction(CustomValidator) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a custom validator.
addExpectedContentType(String) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add an expected content type of request.
addFailureHandler(HttpMethod, String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Deprecated.
addFailureHandlerByOperationId(String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Add a failure handler by operation_id field in Operation object
addFormParam(String, ParameterType, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a single parameter inside a form with included parameter types
addFormParamsArray(String, ParameterType, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a form parameters array with included parameter types
addFormParamsArrayWithPattern(String, String, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a form parameters array with a custom pattern
addFormParamWithCustomTypeValidator(String, ParameterTypeValidator, boolean, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a form parameter with a custom type validator.
addFormParamWithPattern(String, String, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a single parameter inside a form with a custom pattern
addHandler(HttpMethod, String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Deprecated.
addHandlerByOperationId(String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Add an handler by operation_id field in Operation object
addHeaderParam(String, ParameterType, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a header parameter with included parameter types
addHeaderParamWithCustomTypeValidator(String, ParameterTypeValidator, boolean, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a header parameter with a custom type validator.
addHeaderParamWithPattern(String, String, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a header parameter with a custom pattern
addJsonBodySchema(String) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a json schema for body with Content-Type "application/json"
addMultipartRequiredFile(String, String) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add an expected filename inside multipart request.
addPathParam(String, ParameterType) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a path parameter with included parameter types.
addPathParamWithCustomTypeValidator(String, ParameterTypeValidator, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a path parameter with a custom type validator.
addPathParamWithPattern(String, String) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a path parameter with a custom pattern.
addQueryParam(String, ParameterType, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a query parameter with included parameter types
addQueryParamsArray(String, ParameterType, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a query parameters array with included parameter types
addQueryParamsArrayWithPattern(String, String, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a query parameters array with a custom pattern
addQueryParamWithCustomTypeValidator(String, ParameterTypeValidator, boolean, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a query parameter with a custom type validator.
addQueryParamWithPattern(String, String, boolean) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a query parameter with a custom pattern
addSecurityHandler(String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Mount to paths that have to follow a security schema a security handler
addSecuritySchemaScopeValidator(String, String, Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Add a particular scope validator.
addXMLBodySchema(String) - Method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Add a xml schema for body with Content-Type "application/xml"
allowEmptyValue() - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: allowEmptyValue is used in query, header, cookie and form parameters.

B

body() - Method in interface io.vertx.ext.web.api.RequestParameters: Return request body

C

ContainerDeserializer - Interface in io.vertx.ext.web.api.validation: Interface that define methods for deserialization of array and objects
ContainerSerializationStyle - Enum in io.vertx.ext.web.api.validation: This enum contains supported object and arrays serialization styles.
cookieParameter(String) - Method in interface io.vertx.ext.web.api.RequestParameters: Get cookie parameter by name
cookieParametersNames() - Method in interface io.vertx.ext.web.api.RequestParameters: Get list of all parameter names inside cookie
create(Vertx, String, Handler<AsyncResult<OpenAPI3RouterFactory>>) - Static method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Create a new OpenAPI3RouterFactory
create(String, Object) - Static method in interface io.vertx.ext.web.api.RequestParameter
create(Object) - Static method in interface io.vertx.ext.web.api.RequestParameter
create() - Static method in interface io.vertx.ext.web.api.validation.HTTPRequestValidationHandler: Factory method to create an HTTPRequestValidationHandler
createArrayTypeValidator(ParameterTypeValidator) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create an array type validator
createArrayTypeValidator(ParameterTypeValidator, String, Integer, Integer) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create an array type validator
createBooleanTypeValidator(Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a boolean type validator
createDoubleTypeValidator(Double) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for double values
createDoubleTypeValidator(Double, Double, Double, Double) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for double values
createDoubleTypeValidator(Boolean, Double, Boolean, Double, Double, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for double values
createEnumTypeValidatorWithInnerValidator(List<String>, ParameterTypeValidator) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create an enum type validator
createFloatTypeValidator(Float) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for float values
createFloatTypeValidator(Double, Double, Double, Float) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for float values
createFloatTypeValidator(Boolean, Double, Boolean, Double, Double, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for float values
createIntegerTypeValidator(Integer) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for integer values
createIntegerTypeValidator(Double, Double, Double, Integer) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for integer values
createIntegerTypeValidator(Boolean, Double, Boolean, Double, Double, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for integer values
createLongTypeValidator(Long) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for long integer values
createLongTypeValidator(Double, Double, Double, Long) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for long integer values
createLongTypeValidator(Boolean, Double, Boolean, Double, Double, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new type validator for long integer values
createMissingSecurityHandler(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createMissingSecurityHandler(String, String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createOperationIdNotFoundException(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createPathNotFoundException(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createRouterFactoryFromFile(Vertx, String, Handler<AsyncResult<OpenAPI3RouterFactory>>) - Static method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Deprecated.
use OpenAPI3RouterFactory.create(Vertx, String, Handler)
createRouterFactoryFromURL(Vertx, String, Handler<AsyncResult<OpenAPI3RouterFactory>>) - Static method in interface io.vertx.ext.web.api.contract.openapi3.OpenAPI3RouterFactory: Deprecated.
use OpenAPI3RouterFactory.create(Vertx, String, Handler)
createSpecInvalidException(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createSpecNotExistsException(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
createStringEnumTypeValidator(List<String>) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create an enum type validator
createStringTypeValidator(Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new string type validator
createStringTypeValidator(String, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new string type validator
createStringTypeValidator(String, Integer, Integer, Object) - Static method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Create a new string type validator
CustomValidator - Interface in io.vertx.ext.web.api.validation: This interface is used to add custom synchronous functions inside validation process.

D

DEFAULT_MOUNT_NOT_IMPLEMENTED_HANDLER - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: By default, RouterFactory mounts Not Implemented handler
DEFAULT_MOUNT_RESPONSE_CONTENT_TYPE_HANDLER - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: By default, RouterFactory will mount ResponseContentTypeHandler when required
DEFAULT_MOUNT_VALIDATION_FAILURE_HANDLER - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: By default, RouterFactory loads validation failure handler
DEFAULT_NOT_IMPLEMENTED_HANDLER - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Default not implemented handler.
DEFAULT_REQUIRE_SECURITY_HANDLERS - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: By default, RouterFactory requires security handlers to be defined while calling getRouter() or it will throw an Exception
DEFAULT_VALIDATION_HANDLER - Static variable in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Default validation failure handler.
deserializeArray(String) - Method in interface io.vertx.ext.web.api.validation.ContainerDeserializer
deserializeObject(String) - Method in interface io.vertx.ext.web.api.validation.ContainerDeserializer
deserializer() - Method in enum io.vertx.ext.web.api.validation.ContainerSerializationStyle

E

enableValidationFailureHandler(boolean) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Deprecated.

F

formParameter(String) - Method in interface io.vertx.ext.web.api.RequestParameters: Get form parameter by name
formParametersNames() - Method in interface io.vertx.ext.web.api.RequestParameters: Get list of all parameter names inside body form

G

generateDeserializationError(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateEmptyValueValidationException(String, ParameterValidationRule, ParameterLocation) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateFileNotFoundValidationException(String, String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateInvalidJsonBodyException(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateInvalidXMLBodyException(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateNotFoundValidationException(String, ParameterLocation) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateNotMatchValidationException(String, String, ParameterValidationRule) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateNotMatchValidationException(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateNotParsableJsonBodyException(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateObjectFieldNotFound(String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateUnexpectedArraySizeValidationException(Integer, Integer, Integer) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateUnexpectedArrayValidationException(String, ParameterValidationRule) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateUnexpectedSingleStringValidationException(String, ParameterValidationRule) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
generateWrongContentTypeExpected(String, String) - Static method in class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
getArray() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a list, otherwise it returns value
getBoolean() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a Boolean, otherwise it returns value
getContainerStyle(String) - Static method in enum io.vertx.ext.web.api.validation.ContainerSerializationStyle
getDefault() - Method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Returns default value of parameter
getDouble() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a Double, otherwise it returns value
getFloat() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a Float, otherwise it returns value
getInteger() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not an Integer, otherwise it returns value
getJsonArray() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a JsonArray, otherwise it returns value
getJsonObject() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a JsonObject, otherwise it returns value
getLong() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a Long, otherwise it returns value
getName() - Method in interface io.vertx.ext.web.api.RequestParameter: Get parameter name
getName() - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: This function return the name of the parameter expected into parameter lists
getNotImplementedFailureHandler() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
getObjectKeys() - Method in interface io.vertx.ext.web.api.RequestParameter: If value is a map of fields, it returns keys of map, otherwise it returns null
getObjectValue(String) - Method in interface io.vertx.ext.web.api.RequestParameter: If value is a map of fields, it returns value of field with key provided, otherwise it returns null
getOptions() - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Get options of router factory.
getRouter() - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Construct a new router based on spec.
getString() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns null if value is not a String, otherwise it returns value
getValidationFailureHandler() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions

H

hasDefault() - Method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Returns true if this type validator has default value
headerParameter(String) - Method in interface io.vertx.ext.web.api.RequestParameters: Get header parameter by name
headerParametersNames() - Method in interface io.vertx.ext.web.api.RequestParameters: Get list of all parameter names inside header
HTTPOperationRequestValidationHandler - Interface in io.vertx.ext.web.api.contract: Base interface for HTTP request validation with API specification
HTTPRequestValidationHandler - Interface in io.vertx.ext.web.api.validation: An interface for add HTTP Request validation.

I

io.vertx.ext.web.api - package io.vertx.ext.web.api: = Vert.x-Web API Contract :toc: left Vert.x-Web API Contract brings to Vert.x two features to help you to develop you API: * HTTP Requests validation * OpenAPI 3 Support with automatic requests validation == Using Vert.x API Contract To use Vert.x API Contract, add the following dependency to the _dependencies_ section of your build descriptor: * Maven (in your `pom.xml`): [source,xml,subs="+attributes"] ---- ${maven.groupId} ${maven.artifactId} ${maven.version} ---- * Gradle (in your `build.gradle` file): [source,groovy,subs="+attributes"] ---- dependencies { compile '${maven.groupId}:${maven.artifactId}:${maven.version}' } ---- == HTTP Requests validation Vert.x provides a validation framework that will validate requests for you and will put results of validation inside a container.
io.vertx.ext.web.api.contract - package io.vertx.ext.web.api.contract
io.vertx.ext.web.api.contract.openapi3 - package io.vertx.ext.web.api.contract.openapi3
io.vertx.ext.web.api.validation - package io.vertx.ext.web.api.validation
isArray() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is an array
isBoolean() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a Boolean instance
isDouble() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a Double instance
isEmpty() - Method in interface io.vertx.ext.web.api.RequestParameter: Alias of RequestParameter.isNull()
isFloat() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a Float instance
isInteger() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is an Integer instance
isJsonArray() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a JsonArray instance
isJsonObject() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a JsonObject instance
isLong() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a Long instance
isMountNotImplementedHandler() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
isMountResponseContentTypeHandler() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
isMountValidationFailureHandler() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
isNull() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value is null
isObject() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a map of fields
isOptional() - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: Return true if parameter is optional
isRequireSecurityHandlers() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
isString() - Method in interface io.vertx.ext.web.api.RequestParameter: Returns true if value of RequestParameter is a String instance
isValid(String) - Method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Function that checks if parameter is valid.
isValidCollection(List<String>) - Method in interface io.vertx.ext.web.api.validation.ParameterTypeValidator: Function that checks if array of values of a specific parameter.

M

merge(RequestParameter) - Method in interface io.vertx.ext.web.api.RequestParameter: Merge this request parameter with another one.
mountOperationsWithoutHandlers(boolean) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Deprecated.

N

names() - Method in enum io.vertx.ext.web.api.validation.ContainerSerializationStyle

O

OpenAPI3RequestValidationHandler - Interface in io.vertx.ext.web.api.contract.openapi3
OpenAPI3RouterFactory - Interface in io.vertx.ext.web.api.contract.openapi3: Interface for OpenAPI3RouterFactory.

P

ParameterLocation - Enum in io.vertx.ext.web.api.validation: ParameterLocation describe the location of parameter inside HTTP Request
parameterName() - Method in exception io.vertx.ext.web.api.validation.ValidationException
ParameterType - Enum in io.vertx.ext.web.api.validation: ParameterType contains prebuilt type validators.
ParameterTypeValidator - Interface in io.vertx.ext.web.api.validation: 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 ParameterTypeValidator.isValid(String): If parameter is valid, call RequestParameter.create(Object) to put value (maybe modified) inside RequestParameters.
parameterTypeValidator() - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: Return ParameterTypeValidator instance used inside this parameter validation rule
ParameterValidationRule - Interface in io.vertx.ext.web.api.validation: This function is an inner wrapper for ParameterTypeValidator inside ValidationHandler parameter maps.
parseOperationSpec() - Method in interface io.vertx.ext.web.api.contract.HTTPOperationRequestValidationHandler: Function that parse the operation specification and generate validation rules
pathParameter(String) - Method in interface io.vertx.ext.web.api.RequestParameters: Get path parameter by name
pathParametersNames() - Method in interface io.vertx.ext.web.api.RequestParameters: Get list of all parameter names inside path

Q

queryParameter(String) - Method in interface io.vertx.ext.web.api.RequestParameters: Get query parameter by name
queryParametersNames() - Method in interface io.vertx.ext.web.api.RequestParameters: Get list of all parameter names inside query

R

RequestParameter - Interface in io.vertx.ext.web.api: Request parameter holder
RequestParameters - Interface in io.vertx.ext.web.api: Container for request parameters
RouterFactory<Specification> - Interface in io.vertx.ext.web.api.contract: Main interface for Design Driven Router factory Author: Francesco Guardiani @slinkydeveloper
RouterFactoryException - Exception in io.vertx.ext.web.api.contract: Main class for router factory exceptions
RouterFactoryException(String, RouterFactoryException.ErrorType) - Constructor for exception io.vertx.ext.web.api.contract.RouterFactoryException
RouterFactoryException.ErrorType - Enum in io.vertx.ext.web.api.contract
RouterFactoryOptions - Class in io.vertx.ext.web.api.contract
RouterFactoryOptions() - Constructor for class io.vertx.ext.web.api.contract.RouterFactoryOptions
RouterFactoryOptions(JsonObject) - Constructor for class io.vertx.ext.web.api.contract.RouterFactoryOptions
RouterFactoryOptions(RouterFactoryOptions) - Constructor for class io.vertx.ext.web.api.contract.RouterFactoryOptions

S

s - Variable in enum io.vertx.ext.web.api.validation.ParameterLocation
setMountNotImplementedHandler(boolean) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Automatic mount handlers that return HTTP 501 status code for operations where you didn't specify an handler.
setMountResponseContentTypeHandler(boolean) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: If true, when required, the factory will mount a ResponseContentTypeHandler
setMountValidationFailureHandler(boolean) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Enable or disable validation failure handler.
setName(String) - Method in interface io.vertx.ext.web.api.RequestParameter: Set parameter name
setNotImplementedFailureHandler(Handler<RoutingContext>) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Set not implemented failure handler.
setOptions(RouterFactoryOptions) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Override options
setParameterName(String) - Method in exception io.vertx.ext.web.api.validation.ValidationException
setRequireSecurityHandlers(boolean) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: If true, when you call RouterFactory.getRouter() the factory will mount for every path the required security handlers and, if a security handler is not defined, it throws an RouterFactoryException
setValidationFailureHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.RouterFactory: Deprecated.
setValidationFailureHandler(Handler<RoutingContext>) - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions: Set default validation failure handler.
setValidationRule(ParameterValidationRule) - Method in exception io.vertx.ext.web.api.validation.ValidationException
setValue(Object) - Method in interface io.vertx.ext.web.api.RequestParameter: Set value
setValue(String) - Method in exception io.vertx.ext.web.api.validation.ValidationException
SpecFeatureNotSupportedException - Exception in io.vertx.ext.web.api.validation
SpecFeatureNotSupportedException(String) - Constructor for exception io.vertx.ext.web.api.validation.SpecFeatureNotSupportedException

T

toJson() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
toString() - Method in exception io.vertx.ext.web.api.validation.ValidationException
type() - Method in exception io.vertx.ext.web.api.contract.RouterFactoryException
type() - Method in exception io.vertx.ext.web.api.validation.ValidationException

V

validate(RoutingContext) - Method in interface io.vertx.ext.web.api.validation.CustomValidator: This function have to be synchronous.
validateArrayParam(List<String>) - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: This function will be called when there is a List that need to be validated.
validateSingleParam(String) - Method in interface io.vertx.ext.web.api.validation.ParameterValidationRule: This function will be called when there is only a string as parameter.
ValidationException - Exception in io.vertx.ext.web.api.validation: This is the main class for every Validation flow related errors
ValidationException(String, ValidationException.ErrorType) - Constructor for exception io.vertx.ext.web.api.validation.ValidationException
ValidationException(ValidationException.ErrorType) - Constructor for exception io.vertx.ext.web.api.validation.ValidationException
ValidationException(String) - Constructor for exception io.vertx.ext.web.api.validation.ValidationException
ValidationException.ErrorType - Enum in io.vertx.ext.web.api.validation: All errors type.
ValidationException.ValidationExceptionFactory - Class in io.vertx.ext.web.api.validation
ValidationExceptionFactory() - Constructor for class io.vertx.ext.web.api.validation.ValidationException.ValidationExceptionFactory
ValidationHandler - Interface in io.vertx.ext.web.api.validation: Base interface for validation.
validationMethod() - Method in enum io.vertx.ext.web.api.validation.ParameterType
validationRule() - Method in exception io.vertx.ext.web.api.validation.ValidationException
value() - Method in exception io.vertx.ext.web.api.validation.ValidationException
valueOf(String) - Static method in enum io.vertx.ext.web.api.contract.RouterFactoryException.ErrorType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.web.api.validation.ContainerSerializationStyle: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.web.api.validation.ParameterLocation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.web.api.validation.ParameterType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.vertx.ext.web.api.validation.ValidationException.ErrorType: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.vertx.ext.web.api.contract.RouterFactoryException.ErrorType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.web.api.validation.ContainerSerializationStyle: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.web.api.validation.ParameterLocation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.web.api.validation.ParameterType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.vertx.ext.web.api.validation.ValidationException.ErrorType: Returns an array containing the constants of this enum type, in the order they are declared.

A B C D E F G H I M N O P Q R S T V