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

Class WebSocketAdapterConfiguration

java.lang.Object

org.forgerock.openig.tools.notifications.ws.WebSocketAdapterConfiguration

public class WebSocketAdapterConfiguration
extends Object

A configuration holder to instantiate WebSocketAdapter.

Constructor Summary

Constructors

Constructor	Description
WebSocketAdapterConfiguration(URI uri, List<String> subProtocols)	Create an instance of a WebSocketAdapterConfiguration.

Method Summary

Modifier and Type	Method	Description
String	getHeaderName()	The SSO header name.
ScheduledExecutorService	getHeartbeatExecutorService()	The executor service to use to schedule heartbeat tasks.
Duration	getHeartbeatInterval()	The interval between heartbeats.
List<String>	getSubProtocols()	The subProtocols list to support (guaranteed to be not null).
SsoToken	getToken()	The SSO token value provider.
URI	getUri()	The WebSocket remote endpoint URI (guaranteed to be not null).
WebSocketAdapterConfiguration	heartbeat(Duration interval, ScheduledExecutorService executorService)	Supply The heartbeat setup to keep the websocket session busy.
WebSocketAdapterConfiguration	ssoHeader(String headerName, SsoToken ssoToken)	Provide the SSO token header name.

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketAdapterConfiguration

public WebSocketAdapterConfiguration(URI uri,
                                     List<String> subProtocols)

Create an instance of a WebSocketAdapterConfiguration.

Parameters:

uri - The WebSocket remote endpoint (not null)

subProtocols - The WebSocket sub-protocol list to support (not null)

Method Detail

ssoHeader

public WebSocketAdapterConfiguration ssoHeader(String headerName,
                                               SsoToken ssoToken)

Provide the SSO token header name.

Parameters:

headerName - The SSO header name (not null)

ssoToken - The SSO token value (not null)

Returns:

this instance supporting a fluent API

heartbeat

public WebSocketAdapterConfiguration heartbeat(Duration interval,
                                               ScheduledExecutorService executorService)

Supply The heartbeat setup to keep the websocket session busy.

Parameters:

interval - the interval between heartbeats. null is an invalid value, Duration.UNLIMITED and Duration.ZERO represent no heartbeat.

executorService - the executor service to use to schedule heartbeat tasks.

Returns:

this instance supporting a fluent API

getUri

public URI getUri()

The WebSocket remote endpoint URI (guaranteed to be not null).

Returns:

The WebSocket remote endpoint URI (guaranteed to be not null)

getSubProtocols

public List<String> getSubProtocols()

The subProtocols list to support (guaranteed to be not null).

Returns:

the subProtocols list to support (guaranteed to be not null)

getHeaderName

public String getHeaderName()

The SSO header name.

Returns:

The SSO header name

getToken

public SsoToken getToken()

The SSO token value provider.

Returns:

The SSO token value provider

getHeartbeatExecutorService

public ScheduledExecutorService getHeartbeatExecutorService()

The executor service to use to schedule heartbeat tasks.

Returns:

The executor service to use to schedule heartbeat tasks.

getHeartbeatInterval

public Duration getHeartbeatInterval()

The interval between heartbeats. Duration.UNLIMITED and Duration.ZERO represent no heartbeat.

Returns:

The interval between heartbeats.