Class WebsocketRoutingFilter

java.lang.Object
org.springframework.cloud.gateway.filter.WebsocketRoutingFilter
All Implemented Interfaces:
GlobalFilter, org.springframework.core.Ordered
public class WebsocketRoutingFilter extends Object implements GlobalFilter, org.springframework.core.Ordered
Author:
Spencer Gibb, Nikita Konev

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SEC_WEBSOCKET_PROTOCOL
    Sec-Websocket protocol.

    Fields inherited from interface org.springframework.core.Ordered

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    WebsocketRoutingFilter(org.springframework.web.reactive.socket.client.WebSocketClient webSocketClient, org.springframework.web.reactive.socket.server.WebSocketService webSocketService, org.springframework.beans.factory.ObjectProvider<List<HttpHeadersFilter>> headersFiltersProvider)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    reactor.core.publisher.Mono<Void>
    filter(org.springframework.web.server.ServerWebExchange exchange, GatewayFilterChain chain)
    Process the Web request and (optionally) delegate to the next GatewayFilter through the given GatewayFilterChain.
    int
    getOrder()
     

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • WebsocketRoutingFilter

      public WebsocketRoutingFilter(org.springframework.web.reactive.socket.client.WebSocketClient webSocketClient, org.springframework.web.reactive.socket.server.WebSocketService webSocketService, org.springframework.beans.factory.ObjectProvider<List<HttpHeadersFilter>> headersFiltersProvider)

  • Method Details

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface org.springframework.core.Ordered

    • filter

      public reactor.core.publisher.Mono<Void> filter(org.springframework.web.server.ServerWebExchange exchange, GatewayFilterChain chain)
      Description copied from interface: GlobalFilter
      Process the Web request and (optionally) delegate to the next GatewayFilter through the given GatewayFilterChain.
      Specified by:
      filter in interface GlobalFilter
      Parameters:
      exchange - the current server exchange
      chain - provides a way to delegate to the next filter
      Returns:
      Mono<Void> to indicate when request processing is complete