RouteImpl (Vertx Javadocs 4.0.3.GA API)

java.lang.Object
- io.vertx.ext.web.impl.RouteImpl

All Implemented Interfaces:

Route
```
public class RouteImpl
extends Object
implements Route
```
This class is thread-safe
Some parts (e.g. content negotiation) from Yoke by Paulo Lopes

Author:

Tim Fox, Paulo Lopes

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Route`	`blockingHandler(Handler<RoutingContext> contextHandler)` Like `Route.blockingHandler(Handler, boolean)` called with ordered = true
`Route`	`blockingHandler(Handler<RoutingContext> contextHandler, 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.
`Route`	`failureHandler(Handler<RoutingContext> exceptionHandler)` Append a failure handler to the route failure handlers list.
`String`	`getName()`
`String`	`getPath()`
`Route`	`handler(Handler<RoutingContext> contextHandler)` Append a request handler to the route handlers list.
`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()`
`Route`	`order(int order)` Specify the order for this route.
`Route`	`path(String path)` Set the path prefix for this route.
`Route`	`pathRegex(String regex)` 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
`RouteImpl`	`setEmptyBodyPermittedWithConsumes(boolean emptyBodyPermittedWithConsumes)`
`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`	`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.vertx.ext.web.Route
respond, useNormalisedPath

- Method Detail
  - method
```
public Route method(HttpMethod method)
```
    Description copied from interface: Route
    
    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
    
    Specified by:
    
    method in interface Route
    
    Parameters:
    
    method - the HTTP method to add
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - path
```
public Route path(String path)
```
    Description copied from interface: Route
    
    Set 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.
    
    Specified by:
    
    path in interface Route
    
    Parameters:
    
    path - the path prefix
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - pathRegex
```
public Route pathRegex(String regex)
```
    Description copied from interface: Route
    
    Set 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.
    
    Specified by:
    
    pathRegex in interface Route
    
    Parameters:
    
    regex - the path regex
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - produces
```
public Route produces(String contentType)
```
    Description copied from interface: Route
    
    Add a content type produced by this route. Used for content based routing.
    
    Specified by:
    
    produces in interface Route
    
    Parameters:
    
    contentType - the content type
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - consumes
```
public Route consumes(String contentType)
```
    Description copied from interface: Route
    
    Add a content type consumed by this route. Used for content based routing.
    
    Specified by:
    
    consumes in interface Route
    
    Parameters:
    
    contentType - the content type
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - virtualHost
```
public Route virtualHost(String hostnamePattern)
```
    Description copied from interface: Route
    
    Add a virtual host filter for this route.
    
    Specified by:
    
    virtualHost in interface Route
    
    Parameters:
    
    hostnamePattern - the hostname pattern that should match Host header of the requests
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - order
```
public Route order(int order)
```
    Description copied from interface: Route
    
    Specify the order for this route. The router tests routes in that order.
    
    Specified by:
    
    order in interface Route
    
    Parameters:
    
    order - the order
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - last
```
public Route last()
```
    Description copied from interface: Route
    
    Specify this is the last route for the router.
    
    Specified by:
    
    last in interface Route
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - handler
```
public Route handler(Handler<RoutingContext> contextHandler)
```
    Description copied from interface: Route
    
    Append a request handler to the route handlers list. The router routes requests to handlers depending on whether the various criteria such as method, path, etc match. When method, path, etc are the same for different routes, You should add multiple handlers to the same route object rather than creating two different routes objects with one handler for route
    
    Specified by:
    
    handler in interface Route
    
    Parameters:
    
    contextHandler - the request handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - blockingHandler
```
public Route blockingHandler(Handler<RoutingContext> contextHandler)
```
    Description copied from interface: Route
    
    Like Route.blockingHandler(Handler, boolean) called with ordered = true
    
    Specified by:
    
    blockingHandler in interface Route
  - subRouter
```
public Route subRouter(Router subRouter)
```
    Description copied from interface: Route
    Use a (sub) Router as a handler. There are several requirements to be fulfilled for this to be accepted.
    - The route path must end with a wild card
    - Parameters are allowed but full regex patterns not
    - No other handler can be registered before or after this call (but they can on a new route object for the same path)
    - Only 1 router per path object
    Specified by:
    
    subRouter in interface Route
    
    Parameters:
    
    subRouter - the router to add
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - blockingHandler
```
public Route blockingHandler(Handler<RoutingContext> contextHandler,
                             boolean ordered)
```
    Description copied from interface: Route
    
    Specify a blocking request handler for the route. This method works just like Route.handler(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.
    
    Specified by:
    
    blockingHandler in interface Route
    
    Parameters:
    
    contextHandler - the blocking request handler
    
    ordered - if true handlers are executed in sequence, otherwise are run in parallel
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - failureHandler
```
public Route failureHandler(Handler<RoutingContext> exceptionHandler)
```
    Description copied from interface: Route
    
    Append a failure handler to the route failure handlers list. The router routes failures to failurehandlers depending on whether the various criteria such as method, path, etc match. When method, path, etc are the same for different routes, You should add multiple failure handlers to the same route object rather than creating two different routes objects with one failure handler for route
    
    Specified by:
    
    failureHandler in interface Route
    
    Parameters:
    
    exceptionHandler - the request handler
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - remove
```
public Route remove()
```
    Description copied from interface: Route
    
    Remove this route from the router
    
    Specified by:
    
    remove in interface Route
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - disable
```
public Route disable()
```
    Description copied from interface: Route
    
    Disable this route. While disabled the router will not route any requests or failures to it.
    
    Specified by:
    
    disable in interface Route
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - enable
```
public Route enable()
```
    Description copied from interface: Route
    
    Enable this route.
    
    Specified by:
    
    enable in interface Route
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - useNormalizedPath
```
public Route useNormalizedPath(boolean useNormalizedPath)
```
    Description copied from interface: Route
    
    If true then the normalized request path will be used when routing (e.g. removing duplicate /) Default is true
    
    Specified by:
    
    useNormalizedPath in interface Route
    
    Parameters:
    
    useNormalizedPath - use normalized path for routing?
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getPath
```
public String getPath()
```
    Specified by:
    
    getPath in interface Route
    
    Returns:
    
    the path prefix (if any) for this route
  - isRegexPath
```
public boolean isRegexPath()
```
    Description copied from interface: Route
    
    Returns true of the path is a regular expression, this includes expression paths.
    
    Specified by:
    
    isRegexPath in interface Route
    
    Returns:
    
    true if backed by a pattern.
  - isExactPath
```
public boolean isExactPath()
```
    Description copied from interface: Route
    
    Returns true of the path doesn't end with a wildcard * or is null. Regular expression paths are always assumed to be exact.
    
    Specified by:
    
    isExactPath in interface Route
    
    Returns:
    
    true if the path is exact.
  - methods
```
public Set<HttpMethod> methods()
```
    Specified by:
    
    methods in interface Route
    
    Returns:
    
    the http methods accepted by this route
  - setRegexGroupsNames
```
public Route setRegexGroupsNames(List<String> groups)
```
    Description copied from interface: Route
    
    When you add a new route with a regular expression, you can add named capture groups for parameters.
    However, if you need more complex parameters names (like "param_name"), you can add parameters names with this function. You have to name capture groups in regex with names: "p0", "p1", "p2", ...
    
    For example: If you declare route with regex \/(?[a-z]*)\/(?[a-z]*) and group names ["param_a", "param-b"] for uri /hello/world you receive inside pathParams() the parameter param_a = "hello"
    
    Specified by:
    
    setRegexGroupsNames in interface Route
    
    Parameters:
    
    groups - group names
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - setName
```
public Route setName(String name)
```
    Description copied from interface: Route
    
    Giving a name to a route will provide this name as metadata to requests matching this route. This metadata is used by metrics and is meant to group requests with different URI paths (due to parameters) by a common identifier, for example "/resource/:resourceID" common name
    
    Specified by:
    
    setName in interface Route
    
    Parameters:
    
    name - The name of the route.
    
    Returns:
    
    a reference to this, so the API can be used fluently
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface Route
    
    Returns:
    
    the name of the route. If not given explicitly, the path or the pattern or null is returned (in that order)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - setEmptyBodyPermittedWithConsumes
```
public RouteImpl setEmptyBodyPermittedWithConsumes(boolean emptyBodyPermittedWithConsumes)
```

Class RouteImpl

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.vertx.ext.web.Route

Method Detail

method

path

pathRegex

produces

consumes

virtualHost

order

last

handler

blockingHandler

subRouter

blockingHandler

failureHandler

remove

disable

enable

useNormalizedPath

getPath

isRegexPath

isExactPath

methods

setRegexGroupsNames

setName

getName

toString

setEmptyBodyPermittedWithConsumes