Package org.openremote.agent.protocol.websocket

Class WebsocketAgentProtocol

java.lang.Object

org.openremote.agent.protocol.AbstractProtocol<U,X>

org.openremote.agent.protocol.io.AbstractIOClientProtocol<T,U,V,W,X>

org.openremote.agent.protocol.io.AbstractNettyIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

org.openremote.agent.protocol.websocket.WebsocketAgentProtocol

All Implemented Interfaces:

org.openremote.model.asset.agent.Protocol<WebsocketAgent>

public class WebsocketAgentProtocol
extends AbstractNettyIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

This is a generic Protocol for communicating with a Websocket server using String based messages.

Protocol Specifics

When the websocket connection is established it is possible to subscribe to events by specifying the WebsocketAgent.CONNECT_SUBSCRIPTIONS on the WebsocketAgent or WebsocketAgentLink.getWebsocketSubscriptions() on linked Attributes; a subscription can be a message sent over the websocket or a HTTP REST API call.

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<org.openremote.model.attribute.AttributeRef,Runnable>	attributeConnectedTasks
protected Map<String,List<String>>	clientHeaders
static final int	CONNECTED_SEND_DELAY_MILLIS
static final String	PROTOCOL_DISPLAY_NAME
protected List<Runnable>	protocolConnectedTasks
protected final List<org.openremote.model.util.Pair<org.openremote.model.attribute.AttributeRef,Consumer<String>>>	protocolMessageConsumers
protected static final org.jboss.resteasy.client.jaxrs.ResteasyClient	resteasyClient

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

client

Fields inherited from class org.openremote.agent.protocol.AbstractProtocol

agent, assetService, datapointService, dynamicAttributes, executorService, linkedAttributes, messageBrokerContext, predictedDatapointService, producerTemplate, timerService

Fields inherited from interface org.openremote.model.asset.agent.Protocol

ACTUATOR_TOPIC, ACTUATOR_TOPIC_TARGET_PROTOCOL, DYNAMIC_TIME_PLACEHOLDER_REGEXP, DYNAMIC_VALUE_PLACEHOLDER, DYNAMIC_VALUE_PLACEHOLDER_REGEXP, SENSOR_QUEUE, SENSOR_QUEUE_SOURCE_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
WebsocketAgentProtocol(WebsocketAgent agent)

Method Summary

Modifier and Type	Method	Description
protected void	addAttributeConnectedTask(org.openremote.model.attribute.AttributeRef attributeRef, Runnable task)
protected void	addProtocolConnectedTask(Runnable task)
protected String	createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute, WebsocketAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	Generate the actual message to send to the IOClient for this AttributeEvent
protected WebsocketIOClient<String>	doCreateIoClient()	Should return an instance of IOClient for the linked Agent.
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, WebsocketAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doStop(org.openremote.model.Container container)	Stop this protocol instance
protected void	doSubscription(Map<String,List<String>> headers, WebsocketSubscription subscription)
protected void	doSubscriptions(Map<String,List<String>> headers, WebsocketSubscription[] subscriptions)
protected void	doUnlinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, WebsocketAgentLink agentLink)	Unlink an Attribute from its linked Agent.
protected Supplier<io.netty.channel.ChannelHandler[]>	getEncoderDecoderProvider()	Gets the Netty ChannelHandlers for the IO client
String	getProtocolName()	Get the name for this protocol
protected void	onConnected()
protected void	onMessageReceived(String message)	Called when the IOClient receives a message from the server
protected void	setConnectionStatus(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)

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

createIoClient

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

doLinkedAttributeWrite, doStart, getGenericStringEncodersAndDecoders, getProtocolInstanceUri, onConnectionStatusChanged

Methods inherited from class org.openremote.agent.protocol.AbstractProtocol

getAgent, getLinkedAttributes, linkAttribute, processLinkedAttributeWrite, sendAttributeEvent, sendAttributeEvent, start, stop, toString, unlinkAttribute, updateAgentAttribute, updateLinkedAttribute, updateLinkedAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openremote.model.asset.agent.Protocol

prefixLogMessage

Field Details

PROTOCOL_DISPLAY_NAME

public static final String PROTOCOL_DISPLAY_NAME

See Also:

• Constant Field Values

CONNECTED_SEND_DELAY_MILLIS

public static final int CONNECTED_SEND_DELAY_MILLIS

See Also:

• Constant Field Values

resteasyClient

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

protocolConnectedTasks

protected List<Runnable> protocolConnectedTasks

attributeConnectedTasks

protected Map<org.openremote.model.attribute.AttributeRef,Runnable> attributeConnectedTasks

clientHeaders

protected Map<String,List<String>> clientHeaders

protocolMessageConsumers

protected final List<org.openremote.model.util.Pair<org.openremote.model.attribute.AttributeRef,Consumer<String>>> protocolMessageConsumers

Constructor Details

WebsocketAgentProtocol

public WebsocketAgentProtocol(WebsocketAgent agent)

Method Details

getProtocolName

public String getProtocolName()

Description copied from interface: org.openremote.model.asset.agent.Protocol

Get the name for this protocol

doStop

protected void doStop(org.openremote.model.Container container)
               throws Exception

Description copied from class: AbstractProtocol

Stop this protocol instance

Overrides:

doStop in class AbstractIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

Throws:

Exception

getEncoderDecoderProvider

protected Supplier<io.netty.channel.ChannelHandler[]> getEncoderDecoderProvider()

Description copied from class: AbstractNettyIOClientProtocol

Gets the Netty ChannelHandlers for the IO client

Specified by:

getEncoderDecoderProvider in class AbstractNettyIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

onMessageReceived

protected void onMessageReceived(String message)

Description copied from class: AbstractIOClientProtocol

Called when the IOClient receives a message from the server

Specified by:

onMessageReceived in class AbstractIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

createWriteMessage

protected String createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute,
 WebsocketAgentLink agentLink,
 org.openremote.model.attribute.AttributeEvent event,
 Object processedValue)

Description copied from class: AbstractIOClientProtocol

Generate the actual message to send to the IOClient for this AttributeEvent

Specified by:

createWriteMessage in class AbstractIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

doCreateIoClient

protected WebsocketIOClient<String> doCreateIoClient()
                                              throws Exception

Description copied from class: AbstractIOClientProtocol

Should return an instance of IOClient for the linked Agent.

Specified by:

doCreateIoClient in class AbstractIOClientProtocol<WebsocketAgentProtocol,WebsocketAgent,String,WebsocketIOClient<String>,WebsocketAgentLink>

Throws:

Exception

setConnectionStatus

protected void setConnectionStatus(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)

Overrides:

setConnectionStatus in class AbstractProtocol<WebsocketAgent,WebsocketAgentLink>

doLinkAttribute

protected void doLinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 WebsocketAgentLink agentLink)

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<WebsocketAgent,WebsocketAgentLink>

doUnlinkAttribute

protected void doUnlinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 WebsocketAgentLink agentLink)

Description copied from class: AbstractProtocol

Unlink an Attribute from its linked Agent.

Specified by:

doUnlinkAttribute in class AbstractProtocol<WebsocketAgent,WebsocketAgentLink>

onConnected

protected void onConnected()

addProtocolConnectedTask

protected void addProtocolConnectedTask(Runnable task)

addAttributeConnectedTask

protected void addAttributeConnectedTask(org.openremote.model.attribute.AttributeRef attributeRef,
 Runnable task)

doSubscriptions

protected void doSubscriptions(Map<String,List<String>> headers,
 WebsocketSubscription[] subscriptions)

doSubscription

protected void doSubscription(Map<String,List<String>> headers,
 WebsocketSubscription subscription)