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

A

ArrayParserFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to create ValueParser able to parse serialized array structures.

B

BadRequestException - Exception in io.vertx.ext.web.validation

Represents an exception while processing a request with ValidationHandler.

BadRequestException(String, Throwable) - Constructor for exception io.vertx.ext.web.validation.BadRequestException

Bodies - Interface in io.vertx.ext.web.validation.builder

In this interface you can find all available BodyProcessorFactory to use in ValidationHandlerBuilder.

body(BodyProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

body(BodyProcessor) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

body() - Method in interface io.vertx.ext.web.validation.RequestParameters

Return request body when parsed.

BODY_REQUIRED - Static variable in interface io.vertx.ext.web.validation.RequestPredicate

Request predicate that checks if body exists or not

BodyProcessorException - Exception in io.vertx.ext.web.validation

Represents an exception while processing a body

BodyProcessorException(String, Throwable, String, BodyProcessorException.BodyProcessorErrorType) - Constructor for exception io.vertx.ext.web.validation.BodyProcessorException

BodyProcessorException.BodyProcessorErrorType - Enum in io.vertx.ext.web.validation

BodyProcessorFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to build body processors.

build() - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

Build the ValidationHandler from this builder

builder(SchemaParser) - Static method in interface io.vertx.ext.web.validation.ValidationHandler

Deprecated.

This method duplicates the behavior of ValidationHandlerBuilder.create(SchemaParser).

C

commaSeparatedArrayParser() - Static method in interface io.vertx.ext.web.validation.builder.Parsers

commaSeparatedObjectParser() - Static method in interface io.vertx.ext.web.validation.builder.Parsers

commaSeparatedTupleParser() - Static method in interface io.vertx.ext.web.validation.builder.Parsers

cookieParameter(StyledParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

cookieParameter(ParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

cookieParameter(String) - Method in interface io.vertx.ext.web.validation.RequestParameters

Get cookie parameter by name

cookieParametersNames() - Method in interface io.vertx.ext.web.validation.RequestParameters

Get list of all parameter names inside cookie

create(SchemaParser) - Method in interface io.vertx.ext.web.validation.builder.BodyProcessorFactory

create(ParameterLocation, SchemaParser) - Method in interface io.vertx.ext.web.validation.builder.ParameterProcessorFactory

create(ParameterLocation, SchemaParser) - Method in interface io.vertx.ext.web.validation.builder.StyledParameterProcessorFactory

create(SchemaParser) - Static method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

create(Object) - Static method in interface io.vertx.ext.web.validation.RequestParameter

createMissingMatchingBodyProcessor(String) - Static method in exception io.vertx.ext.web.validation.BodyProcessorException

createMissingParameterWhenRequired(String, ParameterLocation) - Static method in exception io.vertx.ext.web.validation.ParameterProcessorException

createParsingError(String, MalformedValueException) - Static method in exception io.vertx.ext.web.validation.BodyProcessorException

createParsingError(String, DecodeException) - Static method in exception io.vertx.ext.web.validation.BodyProcessorException

createParsingError(String, ParameterLocation, MalformedValueException) - Static method in exception io.vertx.ext.web.validation.ParameterProcessorException

createValidationError(String, Throwable) - Static method in exception io.vertx.ext.web.validation.BodyProcessorException

createValidationError(String, ParameterLocation, Throwable) - Static method in exception io.vertx.ext.web.validation.ParameterProcessorException

D

deepObjectParam(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required deep object parameter.

E

explodedParam(String, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required exploded array parameter.

explodedParam(String, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required exploded tuple parameter.

explodedParam(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required exploded object parameter.

F

failed(String) - Static method in interface io.vertx.ext.web.validation.RequestPredicateResult

formUrlEncoded(ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Bodies

Create a form application/x-www-form-urlencoded processor

G

get() - Method in interface io.vertx.ext.web.validation.RequestParameter

getActualContentType() - Method in exception io.vertx.ext.web.validation.BodyProcessorException

getBoolean() - Method in interface io.vertx.ext.web.validation.RequestParameter

getBuffer() - Method in interface io.vertx.ext.web.validation.RequestParameter

getDouble() - Method in interface io.vertx.ext.web.validation.RequestParameter

getErrorMessage() - Method in interface io.vertx.ext.web.validation.RequestPredicateResult

Get error of failure

getErrorType() - Method in exception io.vertx.ext.web.validation.BodyProcessorException

getErrorType() - Method in exception io.vertx.ext.web.validation.ParameterProcessorException

getFloat() - Method in interface io.vertx.ext.web.validation.RequestParameter

getInteger() - Method in interface io.vertx.ext.web.validation.RequestParameter

getJsonArray() - Method in interface io.vertx.ext.web.validation.RequestParameter

getJsonObject() - Method in interface io.vertx.ext.web.validation.RequestParameter

Returns null if value is not a JsonObject, otherwise it returns value

getLocation() - Method in exception io.vertx.ext.web.validation.ParameterProcessorException

getLong() - Method in interface io.vertx.ext.web.validation.RequestParameter

getParameterName() - Method in exception io.vertx.ext.web.validation.ParameterProcessorException

getString() - Method in interface io.vertx.ext.web.validation.RequestParameter

H

headerParameter(ParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

headerParameter(String) - Method in interface io.vertx.ext.web.validation.RequestParameters

Get header parameter by name.

headerParametersNames() - Method in interface io.vertx.ext.web.validation.RequestParameters

Get list of all parameter names inside header

I

io.vertx.ext.web.validation - package io.vertx.ext.web.validation

io.vertx.ext.web.validation.builder - package io.vertx.ext.web.validation.builder

isBoolean() - Method in interface io.vertx.ext.web.validation.RequestParameter

isBuffer() - Method in interface io.vertx.ext.web.validation.RequestParameter

isEmpty() - Method in interface io.vertx.ext.web.validation.RequestParameter

isJsonArray() - Method in interface io.vertx.ext.web.validation.RequestParameter

isJsonObject() - Method in interface io.vertx.ext.web.validation.RequestParameter

isNull() - Method in interface io.vertx.ext.web.validation.RequestParameter

isNumber() - Method in interface io.vertx.ext.web.validation.RequestParameter

isString() - Method in interface io.vertx.ext.web.validation.RequestParameter

J

json(SchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Bodies

Create a json body processor

jsonParam(String, SchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required parameter serialized as valid json

M

MalformedValueException - Exception in io.vertx.ext.web.validation

Represents a malformed value that parser is unable to manage

MalformedValueException(String) - Constructor for exception io.vertx.ext.web.validation.MalformedValueException

MalformedValueException(Throwable) - Constructor for exception io.vertx.ext.web.validation.MalformedValueException

multipartFileUploadExists(String, String) - Static method in interface io.vertx.ext.web.validation.RequestPredicate

Generate request predicate that checks if a particular multipart file upload with propertyName and matching contentTypePattern exists

multipartFormData(ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Bodies

Create a form multipart/form-data processor

N

newArrayParser(ValueParser<String>) - Method in interface io.vertx.ext.web.validation.builder.ArrayParserFactory

newObjectParser(Map<String, ValueParser<String>>, Map<Pattern, ValueParser<String>>, ValueParser<String>) - Method in interface io.vertx.ext.web.validation.builder.ObjectParserFactory

newTupleParser(List<ValueParser<String>>, ValueParser<String>) - Method in interface io.vertx.ext.web.validation.builder.TupleParserFactory

O

ObjectParserFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to create ValueParser able to parse serialized object structures.

optionalDeepObjectParam(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional deep object parameter.

optionalExplodedParam(String, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional exploded array parameter.

optionalExplodedParam(String, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional exploded tuple parameter.

optionalExplodedParam(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional exploded object parameter.

optionalJsonParam(String, SchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional parameter serialized as valid json

optionalParam(String, NumberSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new optional number parameter.

optionalParam(String, StringSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new optional string parameter

optionalParam(String, BooleanSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new optional boolean parameter

optionalParam(String, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new optional array parameter serialized as comma separated

optionalParam(String, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new optional tuple parameter serialized as comma separated

optionalParam(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional object parameter serialized as comma separated, like key1,value1,key2,value2

optionalParam(String, SchemaBuilder, ValueParser<String>) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional parameter providing a ValueParser

optionalSerializedParam(String, ArrayParserFactory, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional array parameter deserializable using the provided parser factory.

optionalSerializedParam(String, TupleParserFactory, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional tuple parameter deserializable using the provided parser factory.

optionalSerializedParam(String, ObjectParserFactory, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates an optional object parameter deserializable using the provided parser factory.

P

param(String, NumberSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new required number parameter.

param(String, StringSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new required string parameter

param(String, BooleanSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new required boolean parameter

param(String, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new required array parameter serialized as comma separated

param(String, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a new required tuple parameter serialized as comma separated

param(String, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required object parameter serialized as comma separated, like key1,value1,key2,value2

param(String, SchemaBuilder, ValueParser<String>) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required parameter providing a ValueParser

parameter(ParameterLocation, ParameterProcessor) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

Add a parameter given the location and the processor

ParameterProcessorException - Exception in io.vertx.ext.web.validation

Represents an exception while processing a parameter

ParameterProcessorException(String, String, ParameterLocation, ParameterProcessorException.ParameterProcessorErrorType, Throwable) - Constructor for exception io.vertx.ext.web.validation.ParameterProcessorException

ParameterProcessorException.ParameterProcessorErrorType - Enum in io.vertx.ext.web.validation

ParameterProcessorFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to build parameter processors supported on every ParameterLocation.

Parameters - Interface in io.vertx.ext.web.validation.builder

In this interface you can find all available ParameterProcessorFactory to use in ValidationHandlerBuilder.

Parsers - Interface in io.vertx.ext.web.validation.builder

In this interface you can find all available ArrayParserFactory, ObjectParserFactory & TupleParserFactory

pathParameter(ParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

pathParameter(String) - Method in interface io.vertx.ext.web.validation.RequestParameters

Get path parameter by name

pathParametersNames() - Method in interface io.vertx.ext.web.validation.RequestParameters

Get list of all parameter names inside path

predicate(RequestPredicate) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

Q

queryParameter(StyledParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

queryParameter(ParameterProcessorFactory) - Method in interface io.vertx.ext.web.validation.builder.ValidationHandlerBuilder

queryParameter(String) - Method in interface io.vertx.ext.web.validation.RequestParameters

Get query parameter by name

queryParametersNames() - Method in interface io.vertx.ext.web.validation.RequestParameters

Get list of all parameter names inside query

R

REQUEST_CONTEXT_KEY - Static variable in interface io.vertx.ext.web.validation.ValidationHandler

RequestParameter - Interface in io.vertx.ext.web.validation

Request parameter holder

RequestParameters - Interface in io.vertx.ext.web.validation

Container for request parameters

RequestPredicate - Interface in io.vertx.ext.web.validation

Request predicate

RequestPredicateException - Exception in io.vertx.ext.web.validation

Represents an error while trying to validate

RequestPredicateException(String) - Constructor for exception io.vertx.ext.web.validation.RequestPredicateException

RequestPredicateException(String, Throwable) - Constructor for exception io.vertx.ext.web.validation.RequestPredicateException

RequestPredicateResult - Interface in io.vertx.ext.web.validation

Result of a RequestPredicate

S

serializedParam(String, ArrayParserFactory, ArraySchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required array parameter deserializable using the provided parser factory.

serializedParam(String, TupleParserFactory, TupleSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required tuple parameter deserializable using the provided parser factory.

serializedParam(String, ObjectParserFactory, ObjectSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Parameters

Creates a required object parameter deserializable using the provided parser factory.

StyledParameterProcessorFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to build complex parameter processors supported only in cookie & query.

succeeded() - Method in interface io.vertx.ext.web.validation.RequestPredicateResult

Predicate succeeded

success() - Static method in interface io.vertx.ext.web.validation.RequestPredicateResult

T

textPlain(StringSchemaBuilder) - Static method in interface io.vertx.ext.web.validation.builder.Bodies

Create a text/plain body processor

toJson() - Method in exception io.vertx.ext.web.validation.BadRequestException

Returns a Json representation of the exception

toJson() - Method in exception io.vertx.ext.web.validation.BodyProcessorException

toJson() - Method in exception io.vertx.ext.web.validation.ParameterProcessorException

toJson() - Method in interface io.vertx.ext.web.validation.RequestParameters

This method converts RequestParameters in an unique JsonObject with 6 fields: cookie, path, query, header, form, body
cookie, path, query, header, form are JsonObject where keys are param names and values are param values, while body depends on body's shape and may not exist

TupleParserFactory - Interface in io.vertx.ext.web.validation.builder

This interface is used to create ValueParser able to parse serialized object structures.

V

ValidationHandler - Interface in io.vertx.ext.web.validation

This is the entry point of this module.

ValidationHandlerBuilder - Interface in io.vertx.ext.web.validation.builder

Builder for a ValidationHandler.

valueOf(String) - Static method in enum io.vertx.ext.web.validation.BodyProcessorException.BodyProcessorErrorType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.vertx.ext.web.validation.ParameterProcessorException.ParameterProcessorErrorType

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.vertx.ext.web.validation.BodyProcessorException.BodyProcessorErrorType

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.validation.ParameterProcessorException.ParameterProcessorErrorType

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 J M N O P Q R S T V