| Package | Description | 
|---|---|
| io.vertx.ext.web | |
| io.vertx.ext.web.handler | |
| io.vertx.reactivex.ext.web | |
| io.vertx.rxjava.ext.web | |
| io.vertx.rxjava3.ext.web | 
| Modifier and Type | Method and Description | 
|---|---|
Route | 
Route.blockingHandler(Handler<RoutingContext> requestHandler)
Like  
blockingHandler(Handler, boolean) called with ordered = true | 
Route | 
Route.blockingHandler(Handler<RoutingContext> requestHandler,
               boolean ordered)
Specify a blocking request handler for the route. 
 | 
Route | 
Router.connect()
Add a route that matches any HTTP CONNECT request 
 | 
Route | 
Router.connect(String path)
Add a route that matches a HTTP CONNECT request and the specified path 
 | 
Route | 
Router.connectWithRegex(String regex)
Add a route that matches a HTTP CONNECT request and the specified path regex 
 | 
Route | 
Route.consumes(String contentType)
Add a content type consumed by this route. 
 | 
Route | 
RoutingContext.currentRoute()  | 
Route | 
Router.delete()
Add a route that matches any HTTP DELETE request 
 | 
Route | 
Router.delete(String path)
Add a route that matches a HTTP DELETE request and the specified path 
 | 
Route | 
Router.deleteWithRegex(String regex)
Add a route that matches a HTTP DELETE request and the specified path regex 
 | 
Route | 
Route.disable()
Disable this route. 
 | 
Route | 
Route.enable()
Enable this route. 
 | 
Route | 
Route.failureHandler(Handler<RoutingContext> failureHandler)
Append a failure handler to the route failure handlers list. 
 | 
Route | 
Router.get()
Add a route that matches any HTTP GET request 
 | 
Route | 
Router.get(String path)
Add a route that matches a HTTP GET request and the specified path 
 | 
Route | 
Router.getWithRegex(String regex)
Add a route that matches a HTTP GET request and the specified path regex 
 | 
Route | 
Route.handler(Handler<RoutingContext> requestHandler)
Append a request handler to the route handlers list. 
 | 
Route | 
Router.head()
Add a route that matches any HTTP HEAD request 
 | 
Route | 
Router.head(String path)
Add a route that matches a HTTP HEAD request and the specified path 
 | 
Route | 
Router.headWithRegex(String regex)
Add a route that matches a HTTP HEAD request and the specified path regex 
 | 
Route | 
Route.last()
Specify this is the last route for the router. 
 | 
Route | 
Route.method(HttpMethod method)
Add an HTTP method for this route. 
 | 
Route | 
Router.mountSubRouter(String mountPoint,
              Router subRouter)
Deprecated. 
 
This method duplicates the sub router functionality from  
subRouter(Router).
 Mount a sub router on this router | 
Route | 
Router.options()
Add a route that matches any HTTP OPTIONS request 
 | 
Route | 
Router.options(String path)
Add a route that matches a HTTP OPTIONS request and the specified path 
 | 
Route | 
Router.optionsWithRegex(String regex)
Add a route that matches a HTTP OPTIONS request and the specified path regex 
 | 
Route | 
Route.order(int order)
Specify the order for this route. 
 | 
Route | 
Router.patch()
Add a route that matches any HTTP PATCH request 
 | 
Route | 
Router.patch(String path)
Add a route that matches a HTTP PATCH request and the specified path 
 | 
Route | 
Router.patchWithRegex(String regex)
Add a route that matches a HTTP PATCH request and the specified path regex 
 | 
Route | 
Route.path(String path)
Set the path prefix for this route. 
 | 
Route | 
Route.pathRegex(String path)
Set the path prefix as a regular expression. 
 | 
Route | 
Router.post()
Add a route that matches any HTTP POST request 
 | 
Route | 
Router.post(String path)
Add a route that matches a HTTP POST request and the specified path 
 | 
Route | 
Router.postWithRegex(String regex)
Add a route that matches a HTTP POST request and the specified path regex 
 | 
Route | 
Route.produces(String contentType)
Add a content type produced by this route. 
 | 
Route | 
Router.put()
Add a route that matches any HTTP PUT request 
 | 
Route | 
Router.put(String path)
Add a route that matches a HTTP PUT request and the specified path 
 | 
Route | 
Route.putMetadata(String key,
           Object value)
Put metadata to this route. 
 | 
Route | 
Router.putWithRegex(String regex)
Add a route that matches a HTTP PUT request and the specified path regex 
 | 
Route | 
Route.remove()
Remove this route from the router 
 | 
default <T> Route | 
Route.respond(java.util.function.Function<RoutingContext,Future<T>> function)
Append a function request handler to the route handlers list. 
 | 
Route | 
Router.route()
Add a route with no matching criteria, i.e. 
 | 
Route | 
Router.route(HttpMethod method,
     String path)
Add a route that matches the specified HTTP method and path 
 | 
Route | 
Router.route(String path)
Add a route that matches the specified path 
 | 
Route | 
Router.routeWithRegex(HttpMethod method,
              String regex)
Add a route that matches the specified HTTP method and path regex 
 | 
Route | 
Router.routeWithRegex(String regex)
Add a route that matches the specified path regex 
 | 
Route | 
Route.setName(String name)
Giving a name to a route will provide this name as metadata to requests matching this route. 
 | 
Route | 
Route.setRegexGroupsNames(List<String> groups)
When you add a new route with a regular expression, you can add named capture groups for parameters. 
 | 
Route | 
Route.subRouter(Router subRouter)
Use a (sub)  
Router as a handler. | 
Route | 
Router.trace()
Add a route that matches any HTTP TRACE request 
 | 
Route | 
Router.trace(String path)
Add a route that matches a HTTP TRACE request and the specified path 
 | 
Route | 
Router.traceWithRegex(String regex)
Add a route that matches a HTTP TRACE request and the specified path regex 
 | 
default Route | 
Route.useNormalisedPath(boolean useNormalizedPath)
Deprecated.  
 | 
Route | 
Route.useNormalizedPath(boolean useNormalizedPath)
If true then the normalized request path will be used when routing (e.g. 
 | 
Route | 
Route.virtualHost(String hostnamePattern)
Add a virtual host filter for this route. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
List<Route> | 
Router.getRoutes()  | 
| Modifier and Type | Method and Description | 
|---|---|
OtpAuthHandler | 
OtpAuthHandler.setupCallback(Route route)
Setup the required route where authenticators to submit the challenge response. 
 | 
WebAuthnHandler | 
WebAuthnHandler.setupCallback(Route route)
The callback route to verify attestations and assertions. 
 | 
OAuth2AuthHandler | 
OAuth2AuthHandler.setupCallback(Route route)
add the callback handler to a given route. 
 | 
WebAuthnHandler | 
WebAuthnHandler.setupCredentialsCreateCallback(Route route)
The callback route to create registration attestations. 
 | 
WebAuthnHandler | 
WebAuthnHandler.setupCredentialsGetCallback(Route route)
The callback route to create login attestations. 
 | 
OtpAuthHandler | 
OtpAuthHandler.setupRegisterCallback(Route route)
Setup the optional route where authenticators are allowed to register. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
Route | 
Route.getDelegate()  | 
| Modifier and Type | Method and Description | 
|---|---|
static Route | 
Route.newInstance(Route arg)  | 
| Constructor and Description | 
|---|
Route(Route delegate)  | 
| Modifier and Type | Method and Description | 
|---|---|
Route | 
Route.getDelegate()  | 
| Modifier and Type | Method and Description | 
|---|---|
static Route | 
Route.newInstance(Route arg)  | 
| Constructor and Description | 
|---|
Route(Route delegate)  | 
| Modifier and Type | Method and Description | 
|---|---|
Route | 
Route.getDelegate()  | 
| Modifier and Type | Method and Description | 
|---|---|
static Route | 
Route.newInstance(Route arg)  | 
| Constructor and Description | 
|---|
Route(Route delegate)  | 
Copyright © 2023 Eclipse. All rights reserved.