Package org.forgerock.openig.providers

Interface WebSocketProxyFilterProvider

All Known Implementing Classes:
WebSocketProxyFilterProviderImpl
public interface WebSocketProxyFilterProvider
A provider capable of providing a Filter to manage WebSocket upgrade requests and subsequently manage the bi-directional communication from the client to the remote application.

  • Method Details

    • newWebSocketHandshakeDetectorFilter

      Filter newWebSocketHandshakeDetectorFilter()
      Create a new Filter to detect WebSocket upgrade. This must be placed before the WebSocketProxyFilter.
      Returns:
      a Websocket handshake detector.

    • newWebSocketProxyFilter

      Filter newWebSocketProxyFilter(Options options, org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)
      Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.
      Parameters:
      options - WebSocket options
      meterRegistry - MeterRegistry to use for capturing WebSocket proxy metrics
      Returns:
      Filter to manage WebSocket upgrade and communication