Package org.forgerock.openig.websocket

Class WebSocketProxyFilterProviderImpl

java.lang.Object

org.forgerock.openig.websocket.WebSocketProxyFilterProviderImpl

All Implemented Interfaces:

WebSocketProxyFilterProvider

public class WebSocketProxyFilterProviderImpl
extends Object
implements 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.

Constructor Summary

Constructors

Constructor	Description
WebSocketProxyFilterProviderImpl(io.vertx.core.Vertx vertx)	Constructor taking vertx parameter.

Method Summary

Modifier and Type	Method	Description
Filter	newWebSocketHandshakeDetectorFilter()	Create a new Filter to detect WebSocket upgrade.
Filter	newWebSocketProxyFilter(Options options, org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)	Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketProxyFilterProviderImpl

public WebSocketProxyFilterProviderImpl(io.vertx.core.Vertx vertx)

Constructor taking vertx parameter.

Parameters:

vertx - The Vertx factory

Method Details

newWebSocketHandshakeDetectorFilter

public Filter newWebSocketHandshakeDetectorFilter()

Description copied from interface: WebSocketProxyFilterProvider

Create a new Filter to detect WebSocket upgrade. This must be placed before the WebSocketProxyFilter.

Specified by:

newWebSocketHandshakeDetectorFilter in interface WebSocketProxyFilterProvider

Returns:

a Websocket handshake detector.

newWebSocketProxyFilter

public Filter newWebSocketProxyFilter(Options options,
 org.forgerock.monitoring.api.instrument.MeterRegistry meterRegistry)

Description copied from interface: WebSocketProxyFilterProvider

Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.

Specified by:

newWebSocketProxyFilter in interface WebSocketProxyFilterProvider

Parameters:

options - WebSocket options

meterRegistry - MeterRegistry to use for capturing WebSocket proxy metrics

Returns:

Filter to manage WebSocket upgrade and communication