- 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.
- 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
- addGlobalHandler(Handler<RoutingContext>) - Method in interface io.vertx.ext.web.api.contract.RouterFactory
-
Add global handler to be applied prior to
Router
being generated.
- 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.
- completedWithJson(JsonObject) - Static method in class io.vertx.ext.web.api.OperationResponse
-
- completedWithJson(JsonArray) - Static method in class io.vertx.ext.web.api.OperationResponse
-
- completedWithJson(Buffer) - Static method in class io.vertx.ext.web.api.OperationResponse
-
- completedWithPlainText(Buffer) - Static method in class io.vertx.ext.web.api.OperationResponse
-
- 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(Vertx, String, List<JsonObject>, 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
-
- 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
- createWrongExtension(String) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
-
- createWrongInterface(Class) - Static method in exception io.vertx.ext.web.api.contract.RouterFactoryException
-
- CustomValidator - Interface in io.vertx.ext.web.api.validation
-
This interface is used to add custom synchronous functions inside validation process.
- 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, String, 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
- getExtra() - Method in class io.vertx.ext.web.api.OperationRequest
-
Get extra payload
- getFloat() - Method in interface io.vertx.ext.web.api.RequestParameter
-
Returns null if value is not a Float, otherwise it returns value
- getHeaders() - Method in class io.vertx.ext.web.api.OperationRequest
-
Get request headers
- getHeaders() - Method in class io.vertx.ext.web.api.OperationResponse
-
- 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
- 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
- getOperationModelKey() - Method in class io.vertx.ext.web.api.contract.RouterFactoryOptions
-
- getOptions() - Method in interface io.vertx.ext.web.api.contract.RouterFactory
-
Get options of router factory.
- getParams() - Method in class io.vertx.ext.web.api.OperationRequest
-
Get request parsedParameters as JSON
- getPayload() - Method in class io.vertx.ext.web.api.OperationResponse
-
- getRouter() - Method in interface io.vertx.ext.web.api.contract.RouterFactory
-
Construct a new router based on spec.
- getStatusCode() - Method in class io.vertx.ext.web.api.OperationResponse
-
- getStatusMessage() - Method in class io.vertx.ext.web.api.OperationResponse
-
- getString() - Method in interface io.vertx.ext.web.api.RequestParameter
-
Returns null if value is not a String, otherwise it returns value
- getUser() - Method in class io.vertx.ext.web.api.OperationRequest
-
Get request principal user as routingContext.user().principal(), null if no user is authenticated
- getValidationFailureHandler() - Method in interface io.vertx.ext.web.api.contract.RouterFactory
-
- io.vertx.ext.web.api - package io.vertx.ext.web.api
-
- 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
-
- 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.
- 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, Throwable) - Constructor for exception io.vertx.ext.web.api.validation.ValidationException
-
- 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.