A route is a holder for a set of criteria which determine whether an HTTP request or failure should be routed to a handler.
Constructor and description |
---|
Route
(java.lang.Object delegate) |
Type | Name and description |
---|---|
Route |
blockingHandler(io.vertx.core.Handler<RoutingContext> requestHandler) Like Route.blockingHandler called with ordered = true |
Route |
blockingHandler(io.vertx.core.Handler<RoutingContext> requestHandler, boolean ordered) Specify a blocking request handler for the route. |
Route |
consumes(java.lang.String contentType) Add a content type consumed by this route. |
Route |
disable() Disable this route. |
Route |
enable() Enable this route. |
Route |
failureHandler(io.vertx.core.Handler<RoutingContext> failureHandler) Specify a failure handler for the route. |
java.lang.Object |
getDelegate() |
java.lang.String |
getPath() @return
|
Route |
handler(io.vertx.core.Handler<RoutingContext> requestHandler) Specify a request handler for the route. |
Route |
last() Specify this is the last route for the router. |
Route |
method(io.vertx.core.http.HttpMethod method) Add an HTTP method for this route. |
Route |
order(int order) Specify the order for this route. |
Route |
path(java.lang.String path) Set the path prefix for this route. |
Route |
pathRegex(java.lang.String path) Set the path prefix as a regular expression. |
Route |
produces(java.lang.String contentType) Add a content type produced by this route. |
Route |
remove() Remove this route from the router |
Route |
useNormalisedPath(boolean useNormalisedPath) If true then the normalised request path will be used when routing (e.g. removing duplicate /) Default is true |
Methods inherited from class | Name |
---|---|
class java.lang.Object |
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll() |
Like Route.blockingHandler called with ordered = true
Specify a blocking request handler for the route. This method works just like Route.handler 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 parallelAdd a content type consumed by this route. Used for content based routing.
contentType
- the content typeDisable this route. While disabled the router will not route any requests or failures to it.
Enable this route.
Specify a failure handler for the route. The router routes failures to failurehandlers depending on whether the various criteria such as method, path, etc match. There can be only one failure handler for a route. If you set this more than once it will overwrite the previous handler.
failureHandler
- the request handler
Specify a request handler for the route. The router routes requests to handlers depending on whether the various criteria such as method, path, etc match. There can be only one request handler for a route. If you set this more than once it will overwrite the previous handler.
requestHandler
- the request handlerSpecify this is the last route for the router.
Add an HTTP method for this route. By default a route will match all HTTP methods. If any are specified then the route will only match any of the specified methods
method
- the HTTP method to addSpecify the order for this route. The router tests routes in that order.
order
- the orderSet the path prefix for this route. If set then this route will only match request URI paths which start with this path prefix. Only a single path or path regex can be set for a route.
path
- the path prefixSet the path prefix as a regular expression. If set then this route will only match request URI paths, the beginning of which match the regex. Only a single path or path regex can be set for a route.
path
- the path regexAdd a content type produced by this route. Used for content based routing.
contentType
- the content typeRemove this route from the router
If true then the normalised request path will be used when routing (e.g. removing duplicate /) Default is true
useNormalisedPath
- use normalised path for routing?