Module io.inverno.mod.web.server
Package io.inverno.mod.web.server

Interface WebSocketRouteManager<A extends ExchangeContext,B extends WebRouter<A>>

Type Parameters:
A - the exchange context type
B - the Web router type
All Superinterfaces:
BaseWebRouteManager<A,WebExchange<A>,WebSocketRoute<A>,B>
public interface WebSocketRouteManager<A extends ExchangeContext,B extends WebRouter<A>> extends BaseWebRouteManager<A,WebExchange<A>,WebSocketRoute<A>,B>

Manages WebSocket routes in the Web server.

A WebSocket route manager is obtained from WebServer.webSocketRoute(), it allows to specify the criteria a Web exchange must match to be handled by the WebSocket exchange handler defined in handler(WebSocketExchangeHandler)

When setting the exchange handler, interceptors defined in an intercepted Web server are applied to the route when criteria are matching.

It is possible to specify multiple values for any given criteria resulting in multiple WebSocket routes being created in the Web router. For instance, the following code will result in the creation of two routes: 


 webServer
     .route()
         .path("/path/to/resource")
         .subProtocol("json")
         .subProtocol("xml")
         .handler(exchange -> {...})
Since:
1.5
Author:
Jeremy Kuhn

  • Method Details

    • path

      default WebSocketRouteManager<A,B> path(String path)

      Specifies the absolute path that must be matched by a Web exchange to be processed by the route.

      The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

      Parameters:
      path - a path
      Returns:
      the route manager
      Throws:
      IllegalArgumentException - if the specified path is not absolute

    • path

      WebSocketRouteManager<A,B> path(String path, boolean matchTrailingSlash)

      Specifies the absolute path that must be matched with or without trailing slash by a Web exchange to be processed by the route.

      The specified path can be specified as a parameterized path and include path pattern like ?, *, ** as defined by URIBuilder. Note that this path is only meant to filter routes and as a result path parameters have no use.

      Parameters:
      path - a path
      matchTrailingSlash - true to match path with or without trailing slash, false otherwise
      Returns:
      the route manager
      Throws:
      IllegalArgumentException - if the specified path is not absolute

    • language

      WebSocketRouteManager<A,B> language(String languageTag)

      Specifies the language tag as defined by RFC 7231 Section 5.3.5 that must be accepted by a Web exchange to be processed by the route.

      Parameters:
      languageTag - a language tag (e.g. fr-FR)
      Returns:
      the route manager

    • subprotocol

      WebSocketRouteManager<A,B> subprotocol(String subprotocol)

      Specifies the WebSocket subProtocol that must be matched by a Web exchange to be processed by the route.

      Parameters:
      subprotocol - a subProtocol
      Returns:
      the route manager

    • handler

      B handler(WebSocketExchangeHandler<? super A,Web2SocketExchange<A>> handler)

      Specifies the WebSocket exchange handler used to process Web exchanges matching the criteria specified in the route manager and returns the originating Web router.

      The WebSocket route manager is usually obtained from WebServer.webSocketRoute() in which case the resulting Web router is then a WebServer instance.

      Any Web route interceptor defined in an intercepted Web server and matching the criteria specified in the route manager is applied to the resulting WebSocket routes.

      Parameters:
      handler - a WebSocket exchange handler
      Returns:
      the originating Web router