Package org.forgerock.openig.websocket

Interface WebSocketProxyFilterProvider

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 Summary

Modifier and Type	Method	Description
Filter	newWebSocketProxyFilter(Options options)	Create a new Filter to manage WebSocket upgrade requests, and manage subsequent communication.

Method Detail

newWebSocketProxyFilter

Filter newWebSocketProxyFilter(Options options)
                        throws IOException

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

Parameters:

options - WebSocket options

Returns:

Filter to manage WebSocket upgrade and communication

Throws:

IOException - should creation of the WebSocket fail