Uses of Interface
io.vertx.ext.web.RoutingContext

Packages that use RoutingContext

Package	Description
io.vertx.ext.web
io.vertx.ext.web.api.contract
io.vertx.ext.web.api.contract.openapi3
io.vertx.ext.web.api.service
io.vertx.ext.web.api.validation
io.vertx.ext.web.handler
io.vertx.ext.web.handler.graphql
io.vertx.ext.web.handler.sockjs
io.vertx.ext.web.openapi
io.vertx.ext.web.openapi.router
io.vertx.micrometer
io.vertx.reactivex.ext.web
io.vertx.rxjava.ext.web
io.vertx.rxjava3.ext.web

Uses of RoutingContext in io.vertx.ext.web

Methods in io.vertx.ext.web that return RoutingContext

Modifier and Type	Method and Description
RoutingContext	RoutingContext.addCookie(Cookie cookie) Deprecated. Use HttpServerResponse.addCookie(Cookie) Add a cookie. This will be sent back to the client in the response.
default RoutingContext	RoutingContext.attachment(String filename) Set Content-Disposition get to "attachment" with optional filename mime type.
default RoutingContext	RoutingContext.end(Buffer buffer, Handler<AsyncResult<Void>> handler) See end(Buffer)
default RoutingContext	RoutingContext.end(Handler<AsyncResult<Void>> handler) See end()
default RoutingContext	RoutingContext.end(String chunk, Handler<AsyncResult<Void>> handler) See end(String)
default RoutingContext	RoutingContext.etag(String etag) Set the ETag of a response.
default RoutingContext	RoutingContext.json(Object json, Handler<AsyncResult<Void>> handler) See json(Object).
default RoutingContext	RoutingContext.lastModified(java.time.Instant instant) Set the Last-Modified date using a Instant.
default RoutingContext	RoutingContext.lastModified(String instant) Set the Last-Modified date using a String.
RoutingContext	RoutingContext.put(String key, Object obj) Put some arbitrary data in the context.
default RoutingContext	RoutingContext.redirect(String url, Handler<AsyncResult<Void>> handler) See redirect(String).

Methods in io.vertx.ext.web with parameters of type RoutingContext

Modifier and Type	Method and Description
void	Router.handleContext(RoutingContext context) Used to route a context to the router.
void	Router.handleFailure(RoutingContext context) Used to route a failure to the router.

Method parameters in io.vertx.ext.web with type arguments of type RoutingContext

Modifier and Type	Method and Description
Route	Route.blockingHandler(Handler<RoutingContext> requestHandler) Like Route.blockingHandler(Handler, boolean) called with ordered = true
Route	Route.blockingHandler(Handler<RoutingContext> requestHandler, boolean ordered) Specify a blocking request handler for the route.
Router	Router.errorHandler(int statusCode, Handler<RoutingContext> errorHandler) Specify an handler to handle an error for a particular status code.
Route	Route.failureHandler(Handler<RoutingContext> failureHandler) Append a failure handler to the route failure handlers list.
Route	Route.handler(Handler<RoutingContext> requestHandler) Append a request handler to the route handlers list.
default <T> Route	Route.respond(java.util.function.Function<RoutingContext,Future<T>> function) Append a function request handler to the route handlers list.

Uses of RoutingContext in io.vertx.ext.web.api.contract

Methods in io.vertx.ext.web.api.contract that return types with arguments of type RoutingContext

Modifier and Type	Method and Description
Handler<RoutingContext>	RouterFactory.getValidationFailureHandler() Deprecated. Router Factory won't manage the validation errors anymore. You must use Router.errorHandler(int, Handler) with 400 error

Method parameters in io.vertx.ext.web.api.contract with type arguments of type RoutingContext

Modifier and Type	Method and Description
RouterFactory	RouterFactory.addGlobalHandler(Handler<RoutingContext> globalHandler) Deprecated. Add global handler to be applied prior to Router being generated.
RouterFactory	RouterFactory.addSecurityHandler(String securitySchemaName, Handler<RoutingContext> handler) Deprecated. Mount to paths that have to follow a security schema a security handler
RouterFactory	RouterFactory.setExtraOperationContextPayloadMapper(java.util.function.Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper) Deprecated. When set, this function is called while creating the payload of OperationRequest
RouterFactory	RouterFactory.setNotImplementedFailureHandler(Handler<RoutingContext> notImplementedFailureHandler) Deprecated. You must use Router.errorHandler(int, Handler) with 501 error
RouterFactory	RouterFactory.setValidationFailureHandler(Handler<RoutingContext> validationFailureHandler) Deprecated. Router Factory won't manage the validation errors anymore. You must use Router.errorHandler(int, Handler) with 400 error

Uses of RoutingContext in io.vertx.ext.web.api.contract.openapi3

Method parameters in io.vertx.ext.web.api.contract.openapi3 with type arguments of type RoutingContext

Modifier and Type	Method and Description
OpenAPI3RouterFactory	OpenAPI3RouterFactory.addFailureHandlerByOperationId(String operationId, Handler<RoutingContext> failureHandler) Deprecated. Add a failure handler by operation_id field in Operation object
OpenAPI3RouterFactory	OpenAPI3RouterFactory.addHandlerByOperationId(String operationId, Handler<RoutingContext> handler) Deprecated. Add an handler by operation_id field in Operation object
OpenAPI3RouterFactory	OpenAPI3RouterFactory.addSecuritySchemaScopeValidator(String securitySchemaName, String scopeName, Handler<RoutingContext> handler) Deprecated. Add a particular scope validator.

Uses of RoutingContext in io.vertx.ext.web.api.service

Method parameters in io.vertx.ext.web.api.service with type arguments of type RoutingContext

Modifier and Type	Method and Description
RouteToEBServiceHandler	RouteToEBServiceHandler.extraPayloadMapper(java.util.function.Function<RoutingContext,JsonObject> extraPayloadMapper) When extraPayloadMapper is configured, this handler puts the evaluation result into ServiceRequest.getExtra()

Uses of RoutingContext in io.vertx.ext.web.api.validation

Methods in io.vertx.ext.web.api.validation with parameters of type RoutingContext

Modifier and Type	Method and Description
void	CustomValidator.validate(RoutingContext routingContext) Deprecated. This function have to be synchronous.

Uses of RoutingContext in io.vertx.ext.web.handler

Methods in io.vertx.ext.web.handler with parameters of type RoutingContext

Modifier and Type	Method and Description
default Future<Void>	SessionHandler.flush(RoutingContext ctx) Promisified flush.
Future<Void>	SessionHandler.flush(RoutingContext ctx, boolean ignoreStatus) Promisified flush.
default SessionHandler	SessionHandler.flush(RoutingContext ctx, boolean ignoreStatus, Handler<AsyncResult<Void>> handler) Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.
default SessionHandler	SessionHandler.flush(RoutingContext ctx, Handler<AsyncResult<Void>> handler) Flush a context session earlier to the store, this will allow the end user to have full control on the event of a failure at the store level.
String	LoggerFormatter.format(RoutingContext routingContext, long ms) Formats and returns the log statement
Session	SessionHandler.newSession(RoutingContext context) Create a new session
Future<Void>	SessionHandler.setUser(RoutingContext context, User user) Set the user for the session
default SessionHandler	SessionHandler.setUser(RoutingContext context, User user, Handler<AsyncResult<Void>> handler) Set the user for the session

Method parameters in io.vertx.ext.web.handler with type arguments of type RoutingContext

Modifier and Type	Method and Description
MultiTenantHandler	MultiTenantHandler.addDefaultHandler(Handler<RoutingContext> handler) Add a default handler for the case when no tenant was matched.
MultiTenantHandler	MultiTenantHandler.addTenantHandler(String tenant, Handler<RoutingContext> handler) Add a handler for a given tenant to this handler.
SimpleAuthenticationHandler	SimpleAuthenticationHandler.authenticate(java.util.function.Function<RoutingContext,Future<User>> authenticationFunction) This function will allow you to perform authentication the way you intended to.
static MultiTenantHandler	MultiTenantHandler.create(java.util.function.Function<RoutingContext,String> tenantExtractor) Create a MultiTenant handler using a custom tenant extraction function.
static MultiTenantHandler	MultiTenantHandler.create(java.util.function.Function<RoutingContext,String> tenantExtractor, String contextKey) Create a MultiTenant handler using a custom tenant extraction function.
AuthorizationHandler	AuthorizationHandler.variableConsumer(java.util.function.BiConsumer<RoutingContext,AuthorizationContext> handler) Provide a simple handler to extract needed variables.

Uses of RoutingContext in io.vertx.ext.web.handler.graphql

Methods in io.vertx.ext.web.handler.graphql that return RoutingContext

Modifier and Type	Method and Description
static RoutingContext	GraphQLHandler.getRoutingContext(graphql.GraphQLContext graphQlContext) Retrieves the RoutingContext from the GraphQLContext.

Method parameters in io.vertx.ext.web.handler.graphql with type arguments of type RoutingContext

Modifier and Type	Method and Description
GraphQLHandler	GraphQLHandler.beforeExecute(Handler<ExecutionInputBuilderWithContext<RoutingContext>> config) Set a callback to invoke before executing a GraphQL query.
GraphQLHandler	GraphQLHandler.dataLoaderRegistry(java.util.function.Function<RoutingContext,org.dataloader.DataLoaderRegistry> factory) Deprecated. as of 4.2, use GraphQLHandler.beforeExecute(Handler) instead
GraphiQLHandler	GraphiQLHandler.graphiQLRequestHeaders(java.util.function.Function<RoutingContext,MultiMap> factory) Customize the HTTP headers to add to GraphQL requests sent by the GraphiQL user interface.
GraphQLHandler	GraphQLHandler.locale(java.util.function.Function<RoutingContext,Locale> factory) Deprecated. as of 4.2, use GraphQLHandler.beforeExecute(Handler) instead
GraphQLHandler	GraphQLHandler.queryContext(java.util.function.Function<RoutingContext,Object> factory) Deprecated. as of 4.2, use GraphQLHandler.beforeExecute(Handler) instead

Uses of RoutingContext in io.vertx.ext.web.handler.sockjs

Methods in io.vertx.ext.web.handler.sockjs that return RoutingContext

Modifier and Type	Method and Description
RoutingContext	SockJSSocket.routingContext()

Methods in io.vertx.ext.web.handler.sockjs with parameters of type RoutingContext

Modifier and Type	Method and Description
void	SockJSHandler.handle(RoutingContext routingContext) Deprecated. mount the router as a sub-router instead. This method will not properly handle errors.

Uses of RoutingContext in io.vertx.ext.web.openapi

Method parameters in io.vertx.ext.web.openapi with type arguments of type RoutingContext

Modifier and Type	Method and Description
Operation	Operation.failureHandler(Handler<RoutingContext> handler) Mount a failure handler for this operation
Operation	Operation.handler(Handler<RoutingContext> handler) Mount an handler for this operation
RouterBuilder	RouterBuilder.rootHandler(Handler<RoutingContext> rootHandler) Add global handler to be applied prior to Router being generated.
RouterBuilder	RouterBuilder.serviceExtraPayloadMapper(java.util.function.Function<RoutingContext,JsonObject> serviceExtraPayloadMapper) When set, this function is called while creating the payload of ServiceRequest

Uses of RoutingContext in io.vertx.ext.web.openapi.router

Methods in io.vertx.ext.web.openapi.router that return types with arguments of type RoutingContext

Modifier and Type	Method and Description
List<Handler<RoutingContext>>	OpenAPIRoute.getFailureHandlers()
List<Handler<RoutingContext>>	OpenAPIRoute.getHandlers()

Methods in io.vertx.ext.web.openapi.router with parameters of type RoutingContext

Modifier and Type	Method and Description
Future<ValidatableRequest>	RequestExtractor.extractValidatableRequest(RoutingContext routingContext, Operation operation) Extracts and transforms the parameters and the body of an incoming request into a format that can be validated by the RequestValidator.

Method parameters in io.vertx.ext.web.openapi.router with type arguments of type RoutingContext

Modifier and Type	Method and Description
OpenAPIRoute	OpenAPIRoute.addFailureHandler(Handler<RoutingContext> handler) Adds a failure handler for this route
OpenAPIRoute	OpenAPIRoute.addHandler(Handler<RoutingContext> handler) Adds a handler for this route which is executed after the security and validation handlers defined in the contract
RouterBuilder	RouterBuilder.rootHandler(Handler<RoutingContext> rootHandler) Add global handler to be applied prior to Router being generated.

Uses of RoutingContext in io.vertx.micrometer

Methods in io.vertx.micrometer that return types with arguments of type RoutingContext

Modifier and Type	Method and Description
static Handler<RoutingContext>	PrometheusScrapingHandler.create() Creates a Vert.x Web Route handler for Prometheus metrics scraping.
static Handler<RoutingContext>	PrometheusScrapingHandler.create(io.micrometer.prometheus.PrometheusMeterRegistry registry) Creates a Vert.x Web Route handler for Prometheus metrics scraping.
static Handler<RoutingContext>	PrometheusScrapingHandler.create(String registryName) Creates a Vert.x Web Route handler for Prometheus metrics scraping.

Uses of RoutingContext in io.vertx.reactivex.ext.web

Methods in io.vertx.reactivex.ext.web that return RoutingContext

Modifier and Type	Method and Description
RoutingContext	RoutingContext.getDelegate()

Methods in io.vertx.reactivex.ext.web with parameters of type RoutingContext

Modifier and Type	Method and Description
static RoutingContext	RoutingContext.newInstance(RoutingContext arg)

Constructors in io.vertx.reactivex.ext.web with parameters of type RoutingContext

Constructor and Description
RoutingContext(RoutingContext delegate)

Uses of RoutingContext in io.vertx.rxjava.ext.web

Methods in io.vertx.rxjava.ext.web that return RoutingContext

Modifier and Type	Method and Description
RoutingContext	RoutingContext.getDelegate()

Methods in io.vertx.rxjava.ext.web with parameters of type RoutingContext

Modifier and Type	Method and Description
static RoutingContext	RoutingContext.newInstance(RoutingContext arg)

Constructors in io.vertx.rxjava.ext.web with parameters of type RoutingContext

Constructor and Description
RoutingContext(RoutingContext delegate)

Uses of RoutingContext in io.vertx.rxjava3.ext.web

Methods in io.vertx.rxjava3.ext.web that return RoutingContext

Modifier and Type	Method and Description
RoutingContext	RoutingContext.getDelegate()

Methods in io.vertx.rxjava3.ext.web with parameters of type RoutingContext

Modifier and Type	Method and Description
static RoutingContext	RoutingContext.newInstance(RoutingContext arg)

Constructors in io.vertx.rxjava3.ext.web with parameters of type RoutingContext

Constructor and Description
RoutingContext(RoutingContext delegate)