## Uses of Interface
io.vertx.ext.web.Router

- Packages that use Router
  Package | Description
  --- | ---
  io.vertx.ext.shell.term |
  io.vertx.ext.web |
  io.vertx.ext.web.api.contract |
  io.vertx.ext.web.handler.graphql |
  io.vertx.ext.web.handler.sockjs |
  io.vertx.ext.web.openapi |
  io.vertx.ext.web.openapi.router |
  io.vertx.reactivex.ext.web |
  io.vertx.rxjava.ext.web |
  io.vertx.rxjava3.ext.web |
  io.vertx.servicediscovery.rest |

- - ### Uses of Router in io.vertx.ext.shell.term

    Methods in io.vertx.ext.shell.term with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `static TermServer` | TermServer.`createHttpTermServer(Vertx vertx, Router router)` Create a term server for the HTTP protocol, using an existing router.
    `static TermServer` | TermServer.`createHttpTermServer(Vertx vertx, Router router, HttpTermOptions options)` Create a term server for the HTTP protocol, using an existing router.

  - ### Uses of Router in io.vertx.ext.web

    Methods in io.vertx.ext.web that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | Router.`allowForward(AllowForwardHeaders allowForwardHeaders)` Set whether the router should parse "forwarded"-type headers
    `Router` | Router.`clear()` Remove all the routes from this router
    `Router` | Router.`errorHandler(int statusCode, Handler<RoutingContext> errorHandler)` Specify an handler to handle an error for a particular status code.
    `Router` | Router.`modifiedHandler(Handler<Router> handler)` When a Router routes are changed this handler is notified.
    `Router` | Router.`putMetadata(String key, Object value)` Put metadata to this router.
    `static Router` | Router.`router(Vertx vertx)` Create a router

    Methods in io.vertx.ext.web with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `Route` | Router.`mountSubRouter(String mountPoint, Router subRouter)` Deprecated. This method duplicates the sub router functionality from `Route.subRouter(Router)`. Mount a sub router on this router
    `Route` | Route.`subRouter(Router subRouter)` Use a (sub) `Router` as a handler.

    Method parameters in io.vertx.ext.web with type arguments of type Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | Router.`modifiedHandler(Handler<Router> handler)` When a Router routes are changed this handler is notified.

  - ### Uses of Router in io.vertx.ext.web.api.contract

    Methods in io.vertx.ext.web.api.contract that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | RouterFactory.`getRouter()` Deprecated. Construct a new router based on spec.

  - ### Uses of Router in io.vertx.ext.web.handler.graphql

    Methods in io.vertx.ext.web.handler.graphql that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | GraphiQLHandler.`router()` Creates a router configured to serve GraphiQL resources.

  - ### Uses of Router in io.vertx.ext.web.handler.sockjs

    Methods in io.vertx.ext.web.handler.sockjs that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | SockJSHandler.`bridge(AuthorizationProvider authorizationProvider, SockJSBridgeOptions bridgeOptions, Handler<BridgeEvent> bridgeEventHandler)` Like `SockJSHandler.bridge(SockJSBridgeOptions)` but specifying a handler that will receive bridge events.
    `default Router` | SockJSHandler.`bridge(SockJSBridgeOptions bridgeOptions)` Bridge the SockJS handler to the Vert.x event bus.
    `default Router` | SockJSHandler.`bridge(SockJSBridgeOptions bridgeOptions, Handler<BridgeEvent> bridgeEventHandler)` Like `SockJSHandler.bridge(SockJSBridgeOptions)` but specifying a handler that will receive bridge events.
    `Router` | SockJSHandler.`socketHandler(Handler<SockJSSocket> handler)` Set a SockJS socket handler.

  - ### Uses of Router in io.vertx.ext.web.openapi

    Methods in io.vertx.ext.web.openapi that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | RouterBuilder.`createRouter()` Construct a new router based on spec.

  - ### Uses of Router in io.vertx.ext.web.openapi.router

    Methods in io.vertx.ext.web.openapi.router that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | RouterBuilder.`createRouter()` Construct a new router based on the related OpenAPI contract.

  - ### Uses of Router in io.vertx.reactivex.ext.web

    Methods in io.vertx.reactivex.ext.web that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | Router.`getDelegate()`

    Methods in io.vertx.reactivex.ext.web with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `static Router` | Router.`newInstance(Router arg)`

    Constructors in io.vertx.reactivex.ext.web with parameters of type Router
    Constructor and Description
    `Router(Router delegate)`

  - ### Uses of Router in io.vertx.rxjava.ext.web

    Methods in io.vertx.rxjava.ext.web that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | Router.`getDelegate()`

    Methods in io.vertx.rxjava.ext.web with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `static Router` | Router.`newInstance(Router arg)`

    Constructors in io.vertx.rxjava.ext.web with parameters of type Router
    Constructor and Description
    `Router(Router delegate)`

  - ### Uses of Router in io.vertx.rxjava3.ext.web

    Methods in io.vertx.rxjava3.ext.web that return Router
    Modifier and Type | Method and Description
    --- | ---
    `Router` | Router.`getDelegate()`

    Methods in io.vertx.rxjava3.ext.web with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `static Router` | Router.`newInstance(Router arg)`

    Constructors in io.vertx.rxjava3.ext.web with parameters of type Router
    Constructor and Description
    `Router(Router delegate)`

  - ### Uses of Router in io.vertx.servicediscovery.rest

    Methods in io.vertx.servicediscovery.rest with parameters of type Router
    Modifier and Type | Method and Description
    --- | ---
    `static ServiceDiscoveryRestEndpoint` | ServiceDiscoveryRestEndpoint.`create(Router router, ServiceDiscovery discovery)` Creates the REST endpoint using the default root (`/discovery`).
    `static ServiceDiscoveryRestEndpoint` | ServiceDiscoveryRestEndpoint.`create(Router router, ServiceDiscovery discovery, String root)` Creates the REST endpoint using the given root.

Copyright © 2025 Eclipse. All rights reserved.