Modifier and Type | Field and Description |
---|---|
static io.vertx.lang.rx.TypeArg<Route> |
__TYPE_ARG |
Constructor and Description |
---|
Route(Object delegate) |
Route(Route delegate) |
Modifier and Type | Method and Description |
---|---|
Route |
blockingHandler(Handler<RoutingContext> requestHandler)
Like
blockingHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.web.RoutingContext>) called with ordered = true |
Route |
blockingHandler(Handler<RoutingContext> requestHandler,
boolean ordered)
Specify a blocking request handler for the route.
|
Route |
consumes(String contentType)
Add a content type consumed by this route.
|
Route |
disable()
Disable this route.
|
Route |
enable()
Enable this route.
|
boolean |
equals(Object o) |
Route |
failureHandler(Handler<RoutingContext> failureHandler)
Append a failure handler to the route failure handlers list.
|
Route |
getDelegate() |
String |
getName() |
String |
getPath() |
Route |
handler(Handler<RoutingContext> requestHandler)
Append a request handler to the route handlers list.
|
int |
hashCode() |
boolean |
isExactPath()
Returns true of the path doesn't end with a wildcard
* or is null . |
boolean |
isRegexPath()
Returns true of the path is a regular expression, this includes expression paths.
|
Route |
last()
Specify this is the last route for the router.
|
Route |
method(HttpMethod method)
Add an HTTP method for this route.
|
Set<HttpMethod> |
methods() |
static Route |
newInstance(Route arg) |
Route |
order(int order)
Specify the order for this route.
|
Route |
path(String path)
Set the path prefix for this route.
|
Route |
pathRegex(String path)
Set the path prefix as a regular expression.
|
Route |
produces(String contentType)
Add a content type produced by this route.
|
Route |
remove()
Remove this route from the router
|
<T> Route |
respond(java.util.function.Function<RoutingContext,Maybe<T>> function)
Append a function request handler to the route handlers list.
|
Route |
setName(String name)
Giving a name to a route will provide this name as metadata to requests matching this 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 |
subRouter(Router subRouter)
Use a (sub)
Router as a handler. |
String |
toString() |
Route |
useNormalisedPath(boolean useNormalizedPath)
Deprecated.
|
Route |
useNormalizedPath(boolean useNormalizedPath)
If true then the normalized request path will be used when routing (e.g.
|
Route |
virtualHost(String hostnamePattern)
Add a virtual host filter for this route.
|
public static final io.vertx.lang.rx.TypeArg<Route> __TYPE_ARG
public Route getDelegate()
public Route method(HttpMethod method)
method
- the HTTP method to addpublic Route path(String path)
path
- the path prefixpublic Route pathRegex(String path)
path
- the path regexpublic Route produces(String contentType)
contentType
- the content typepublic Route consumes(String contentType)
contentType
- the content typepublic Route virtualHost(String hostnamePattern)
hostnamePattern
- the hostname pattern that should match Host
header of the requestspublic Route order(int order)
order
- the orderpublic Route last()
public Route handler(Handler<RoutingContext> requestHandler)
requestHandler
- the request handlerpublic Route blockingHandler(Handler<RoutingContext> requestHandler)
blockingHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.web.RoutingContext>)
called with ordered = truerequestHandler
- public Route subRouter(Router subRouter)
Router
as a handler. There are several requirements to be fulfilled for this
to be accepted.
subRouter
- the router to addpublic Route blockingHandler(Handler<RoutingContext> requestHandler, boolean ordered)
handler(io.vertx.core.Handler<io.vertx.rxjava3.ext.web.RoutingContext>)
excepted that it will run the blocking handler on a worker thread
so that it won't block the event loop. Note that it's safe to call context.next() from the
blocking handler as it will be executed on the event loop context (and not on the worker thread.
If the blocking handler is ordered it means that any blocking handlers for the same context are never executed concurrently but always in the order they were called. The default value of ordered is true. If you do not want this behaviour and don't mind if your blocking handlers are executed in parallel you can set ordered to false.
requestHandler
- the blocking request handlerordered
- if true handlers are executed in sequence, otherwise are run in parallelpublic Route failureHandler(Handler<RoutingContext> failureHandler)
failureHandler
- the request handlerpublic Route remove()
public Route disable()
public Route enable()
@Deprecated public Route useNormalisedPath(boolean useNormalizedPath)
useNormalizedPath(boolean)
insteaduseNormalizedPath
- public Route useNormalizedPath(boolean useNormalizedPath)
useNormalizedPath
- use normalized path for routing?public String getPath()
public boolean isRegexPath()
public boolean isExactPath()
*
or is null
.
Regular expression paths are always assumed to be exact.public Set<HttpMethod> methods()
public Route setRegexGroupsNames(List<String> groups)
groups
- group namespublic Route setName(String name)
name
- The name of the route.public String getName()
public <T> Route respond(java.util.function.Function<RoutingContext,Maybe<T>> function)
RoutingContext.end(java.lang.String)
has been called, then nothing shall happen. For the remaining cases, the
following rules apply:
body
is null
then the status code of the response shall be 204 (NO CONTENT)body
is of type and the Content-Type
isn't set then the Content-Type
shall be application/octet-stream
body
is of type String
and the Content-Type
isn't set then the Content-Type
shall be text/html
RoutingContext.json(java.lang.Object)
to perform a JSON serialization of the resultfunction
- the request handler functionCopyright © 2021 Eclipse. All rights reserved.