Class VertxWebSocketProxyFilter

  • All Implemented Interfaces:
    Filter

    public class VertxWebSocketProxyFilter
    extends Object
    implements Filter
    A VertxWebSocketProxyFilter detects WebSocket upgrade requests and, when found, connects to the protected application using a dedicated tunnel.

    It then performs the HTTP handshake and, if successful, upgrades the HTTP connection, and finally starts to relay frames between the connected client and the remote application (bidirectional). Note that it is assumed the upgrade request does not have body content.

    See Also:
    RFC 6455 - The WebSocket Protocol
    • Constructor Detail

      • VertxWebSocketProxyFilter

        public VertxWebSocketProxyFilter​(io.vertx.core.Vertx vertx,
                                         io.vertx.core.http.HttpClientOptions httpClientOptions)
        Constructor taking vertx parameter and client connection configuration.
        Parameters:
        vertx - the Vertx factory
        httpClientOptions - Vertx client options to use to create the client connection to the remote application
    • Method Detail

      • filter

        public Promise<Response,​NeverThrowsException> filter​(Context context,
                                                                   Request request,
                                                                   Handler next)
        Description copied from interface: Filter
        Filters the request and/or response of an exchange. To pass the request to the next filter or handler in the chain, the filter calls next.handle(context, request).

        This method may elect not to pass the request to the next filter or handler, and instead handle the request itself. It can achieve this by merely avoiding a call to next.handle(context, request) and creating its own response object. The filter is also at liberty to replace a response with another of its own by intercepting the response returned by the next handler.

        Specified by:
        filter in interface Filter
        Parameters:
        context - The request context.
        request - The request.
        next - The next filter or handler in the chain to handle the request.
        Returns:
        A Promise representing the response to be returned to the client.