Package org.forgerock.openig.websocket
Class WebSocketProxyFilter
- java.lang.Object
-
- org.forgerock.openig.websocket.WebSocketProxyFilter
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Filter
public class WebSocketProxyFilter extends Object implements Filter, Closeable
AWebSocketProxyFilter
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 byte buffers between the connected client and the remote application (bidirectional).
- See Also:
- RFC 6455 - The WebSocket Protocol
-
-
Field Summary
Fields Modifier and Type Field Description static Option<Integer>
NUMBER_OF_SELECTORS
Option allowing configuration of the number of selector threads.
-
Constructor Summary
Constructors Constructor Description WebSocketProxyFilter(Options options)
Constructs a new web-socket filter with the given set ofOptions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Promise<Response,NeverThrowsException>
filter(Context context, Request request, Handler next)
Filters the request and/or response of an exchange.
-
-
-
Constructor Detail
-
WebSocketProxyFilter
public WebSocketProxyFilter(Options options) throws IOException
Constructs a new web-socket filter with the given set ofOptions
.- Parameters:
options
- WebSocket options- Throws:
IOException
- thrown if low level Grizzly transport cannot be instantiated
-
-
Method Detail
-
close
public void close() throws IOException
- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
IOException
-
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 callsnext.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.
-
-