Package org.forgerock.openig.tools.notifications.ws

Interface WebSocketClientProvider

public interface WebSocketClientProvider

Provider of a WebSocket clients.

Method Summary

Modifier and Type	Method	Description
HttpWebSocketClient	newClient(ClientTlsOptions tlsOptions, ProxyOptions proxyOptions, Duration connectionTimeout, Duration idleTimeout, JsonValue vertxConfig)	Creates a new WebSocket client.

Method Detail

newClient

HttpWebSocketClient newClient(ClientTlsOptions tlsOptions,
                              ProxyOptions proxyOptions,
                              Duration connectionTimeout,
                              Duration idleTimeout,
                              JsonValue vertxConfig)
                       throws IOException

Creates a new WebSocket client.

Parameters:

tlsOptions - Security settings for the connection (may be null)

proxyOptions - Proxy settings for the connection (must not be null)

connectionTimeout - Time to wait for before failing the connection (must not be null).

idleTimeout - Time to wait without activity before closing the connection (must not be null).

vertxConfig - The vertx configuration to pass to the underlying Vert.x Websocket client if any (must not be null).

Returns:

an HttpWebSocketClient implementation

Throws:

IOException - on any error when creating the WebSocket client