| Modifier and Type | Method and Description | 
|---|---|
RoutingContext | 
RoutingContext.addCookie(Cookie cookie)
Add a cookie. 
 | 
RoutingContext | 
RoutingContext.addCookie(Cookie cookie)
Deprecated. 
 
instead use  
addCookie(io.vertx.core.http.Cookie) | 
RoutingContext | 
RoutingContext.put(String key,
   Object obj)
Put some arbitrary data in the context. 
 | 
| 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. 
 | 
| 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. 
 | 
| 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 | 
| Modifier and Type | Method and Description | 
|---|---|
RouterFactory | 
RouterFactory.addGlobalHandler(Handler<RoutingContext> globalHandler)
Add global handler to be applied prior to  
Router being generated. | 
RouterFactory | 
RouterFactory.addSecurityHandler(String securitySchemaName,
                  Handler<RoutingContext> handler)
Mount to paths that have to follow a security schema a security handler 
 | 
RouterFactory | 
RouterFactory.setExtraOperationContextPayloadMapper(java.util.function.Function<RoutingContext,JsonObject> extraOperationContextPayloadMapper)
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 | 
| Modifier and Type | Method and Description | 
|---|---|
OpenAPI3RouterFactory | 
OpenAPI3RouterFactory.addFailureHandlerByOperationId(String operationId,
                              Handler<RoutingContext> failureHandler)
Add a failure handler by operation_id field in Operation object 
 | 
OpenAPI3RouterFactory | 
OpenAPI3RouterFactory.addHandlerByOperationId(String operationId,
                       Handler<RoutingContext> handler)
Add an handler by operation_id field in Operation object 
 | 
OpenAPI3RouterFactory | 
OpenAPI3RouterFactory.addSecuritySchemaScopeValidator(String securitySchemaName,
                               String scopeName,
                               Handler<RoutingContext> handler)
Add a particular scope validator. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
CustomValidator.validate(RoutingContext routingContext)
This function have to be synchronous. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
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. 
 | 
void | 
AuthHandler.parseCredentials(RoutingContext context,
                Handler<AsyncResult<JsonObject>> handler)
Parses the credentials from the request into a JsonObject. 
 | 
| 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. 
 | 
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. 
 | 
static VirtualHostHandler | 
VirtualHostHandler.create(String hostname,
      Handler<RoutingContext> handler)
Create a handler 
 | 
| Modifier and Type | Method and Description | 
|---|---|
GraphQLHandler | 
GraphQLHandler.dataLoaderRegistry(java.util.function.Function<RoutingContext,org.dataloader.DataLoaderRegistry> factory)
Customize the  
DataLoaderRegistry. | 
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)
Customize the  
Locale passed to the GraphQL execution engine. | 
GraphQLHandler | 
GraphQLHandler.queryContext(java.util.function.Function<RoutingContext,Object> factory)
Customize the query context object. 
 | 
| 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. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
default void | 
TemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated. 
 
 | 
default void | 
FreeMarkerTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
PebbleTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
JadeTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
ThymeleafTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
HandlebarsTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
RockerTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
MVELTemplateEngine.render(RoutingContext context,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
default void | 
TemplateEngine.render(RoutingContext context,
      String templateDirectory,
      String templateFileName,
      Handler<AsyncResult<Buffer>> handler)
Deprecated.  
 | 
| 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(String registryName)
Creates a Vert.x Web  
Route handler for Prometheus metrics scraping. | 
| Modifier and Type | Method and Description | 
|---|---|
RoutingContext | 
RoutingContext.getDelegate()  | 
| Modifier and Type | Method and Description | 
|---|---|
static RoutingContext | 
RoutingContext.newInstance(RoutingContext arg)  | 
| Constructor and Description | 
|---|
RoutingContext(RoutingContext delegate)  | 
| Modifier and Type | Method and Description | 
|---|---|
RoutingContext | 
RoutingContext.getDelegate()  | 
| Modifier and Type | Method and Description | 
|---|---|
static RoutingContext | 
RoutingContext.newInstance(RoutingContext arg)  | 
| Constructor and Description | 
|---|
RoutingContext(RoutingContext delegate)  | 
Copyright © 2020 Eclipse. All rights reserved.