Package org.openremote.agent.protocol.websocket

Class WebsocketIOClient<T>

java.lang.Object

org.openremote.agent.protocol.io.AbstractNettyIOClient<T,InetSocketAddress>

org.openremote.agent.protocol.websocket.WebsocketIOClient<T>

All Implemented Interfaces:

IOClient<T>, NettyIOClient<T>

public class WebsocketIOClient<T>
extends AbstractNettyIOClient<T,InetSocketAddress>

This is an IOClient implementation based on AbstractNettyIOClient. For custom decoders, the initial message type is of type String. For custom encoders, the final message type must be of type String.

Nested Class Summary

Nested classes/interfaces inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

AbstractNettyIOClient.ByteToMessageDecoder<T>, AbstractNettyIOClient.MessageToByteEncoder<T>, AbstractNettyIOClient.MessageToMessageDecoder<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.jboss.resteasy.client.jaxrs.ResteasyClient	client
protected io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandler	handler
protected CompletableFuture<Void>	handshakeFuture
protected Map<String,List<String>>	headers
protected String	host
protected org.openremote.model.auth.OAuthGrant	oAuthGrant
static final long	PING_MILLIS
static final long	PING_TIMEOUT_MILLIS
protected boolean	pingDisabled
protected ScheduledFuture<?>	pingFuture
protected int	port
protected static io.netty.handler.ssl.SslContext	sslCtx
protected URI	uri
protected boolean	useSsl

Fields inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

bootstrap, channel, connectionStatus, connectionStatusConsumers, connectRetry, connectTimeout, encoderDecoderProvider, executorService, messageConsumers, RECONNECT_DELAY_INITIAL_MILLIS, RECONNECT_DELAY_MAX_MILLIS, scheduledExecutorService, workerGroup

Constructor Summary

Constructors

Constructor	Description
WebsocketIOClient(URI uri, Map<String,List<String>> headers, org.openremote.model.auth.OAuthGrant oAuthGrant)
WebsocketIOClient(URI uri, Map<String,List<String>> headers, org.openremote.model.auth.OAuthGrant oAuthGrant, boolean pingDisabled)

Method Summary

Modifier and Type	Method	Description
protected void	addEncodersDecoders(io.netty.channel.Channel channel)
protected void	doDisconnect()
String	getAuthHeader()
protected Class<? extends io.netty.channel.Channel>	getChannelClass()
protected org.jboss.resteasy.client.jaxrs.ResteasyClient	getClient()
String	getClientUri()	Should return a URI that uniquely identifies this client instance
protected io.netty.handler.ssl.SslContext	getSSLContext()
protected io.netty.channel.EventLoopGroup	getWorkerGroup()
protected void	onHandshakeDone()
protected Future<Void>	startChannel()	Start the actual connection and return a future indicating completion state.

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClient

addConnectionStatusConsumer, addMessageConsumer, configureChannel, connect, disconnect, doConnect, doReconnect, getConnectionStatus, getConnectTimeoutMillis, initChannel, onConnectionStatusChanged, onDecodeException, onEncodeException, onMessageReceived, removeAllConnectionStatusConsumers, removeAllMessageConsumers, removeConnectionStatusConsumer, removeMessageConsumer, scheduleDoConnect, sendMessage, setConnectTimeoutMillis, setEncoderDecoderProvider, toCompletableFuture, toString, waitForConnectFuture

Methods inherited from class java.lang.Object

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

Field Details

client

protected static org.jboss.resteasy.client.jaxrs.ResteasyClient client

PING_MILLIS

public static final long PING_MILLIS

See Also:

• Constant Field Values

PING_TIMEOUT_MILLIS

public static final long PING_TIMEOUT_MILLIS

See Also:

• Constant Field Values

pingFuture

protected ScheduledFuture<?> pingFuture

useSsl

protected boolean useSsl

uri

protected URI uri

sslCtx

protected static io.netty.handler.ssl.SslContext sslCtx

handler

protected io.netty.handler.codec.http.websocketx.WebSocketClientProtocolHandler handler

headers

protected Map<String,List<String>> headers

oAuthGrant

protected org.openremote.model.auth.OAuthGrant oAuthGrant

host

protected String host

port

protected int port

pingDisabled

protected boolean pingDisabled

handshakeFuture

protected CompletableFuture<Void> handshakeFuture

Constructor Details

WebsocketIOClient

public WebsocketIOClient(URI uri,
 Map<String,List<String>> headers,
 org.openremote.model.auth.OAuthGrant oAuthGrant)

WebsocketIOClient

public WebsocketIOClient(URI uri,
 Map<String,List<String>> headers,
 org.openremote.model.auth.OAuthGrant oAuthGrant,
 boolean pingDisabled)

Method Details

getClient

protected org.jboss.resteasy.client.jaxrs.ResteasyClient getClient()

getChannelClass

protected Class<? extends io.netty.channel.Channel> getChannelClass()

Specified by:

getChannelClass in class AbstractNettyIOClient<T,InetSocketAddress>

getClientUri

public String getClientUri()

Description copied from interface: IOClient

Should return a URI that uniquely identifies this client instance

getWorkerGroup

protected io.netty.channel.EventLoopGroup getWorkerGroup()

Specified by:

getWorkerGroup in class AbstractNettyIOClient<T,InetSocketAddress>

startChannel

protected Future<Void> startChannel()

Description copied from class: AbstractNettyIOClient

Start the actual connection and return a future indicating completion state. Implementors can also add any custom connection logic they require.

Specified by:

startChannel in class AbstractNettyIOClient<T,InetSocketAddress>

addEncodersDecoders

protected void addEncodersDecoders(io.netty.channel.Channel channel)
                            throws Exception

Overrides:

addEncodersDecoders in class AbstractNettyIOClient<T,InetSocketAddress>

Throws:

Exception

onHandshakeDone

protected void onHandshakeDone()

getSSLContext

protected io.netty.handler.ssl.SslContext getSSLContext()
                                                 throws SSLException

Throws:

SSLException

doDisconnect

protected void doDisconnect()

Overrides:

doDisconnect in class AbstractNettyIOClient<T,InetSocketAddress>

getAuthHeader

public String getAuthHeader()
                     throws Exception

Throws:

Exception