Package org.openremote.agent.protocol.mqtt

Class MQTTProtocol

java.lang.Object

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

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

org.openremote.agent.protocol.mqtt.AbstractMQTTClientProtocol<MQTTProtocol,MQTTAgent,String,MQTT_IOClient,MQTTAgentLink>

org.openremote.agent.protocol.mqtt.MQTTProtocol

All Implemented Interfaces:

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

public class MQTTProtocol
extends AbstractMQTTClientProtocol<MQTTProtocol,MQTTAgent,String,MQTT_IOClient,MQTTAgentLink>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROTOCOL_DISPLAY_NAME
protected final Map<org.openremote.model.attribute.AttributeRef,Consumer<MQTTMessage<String>>>	protocolMessageConsumers

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

Modifier	Constructor	Description
protected	MQTTProtocol(MQTTAgent agent)

Method Summary

Modifier and Type	Method	Description
protected MQTT_IOClient	createIoClient()
protected MQTTMessage<String>	createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute, MQTTAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	Generate the actual message to send to the IOClient for this AttributeEvent
protected MQTT_IOClient	doCreateIoClient()	Should return an instance of IOClient for the linked Agent.
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, MQTTAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doUnlinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, MQTTAgentLink agentLink)	Unlink an Attribute from its linked Agent.
String	getProtocolName()	Get the name for this protocol
protected void	onMessageReceived(MQTTMessage<String> message)	Called when the IOClient receives a message from the server

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

doLinkedAttributeWrite, doStart, doStop, getGenericStringEncodersAndDecoders, getProtocolInstanceUri, onConnectionStatusChanged

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

getAgent, getLinkedAttributes, linkAttribute, processLinkedAttributeWrite, sendAttributeEvent, sendAttributeEvent, setConnectionStatus, 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

protocolMessageConsumers

protected final Map<org.openremote.model.attribute.AttributeRef,Consumer<MQTTMessage<String>>> protocolMessageConsumers

Constructor Details

MQTTProtocol

protected MQTTProtocol(MQTTAgent agent)

Method Details

doLinkAttribute

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

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<MQTTAgent,MQTTAgentLink>

Throws:

RuntimeException

doUnlinkAttribute

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

Description copied from class: AbstractProtocol

Unlink an Attribute from its linked Agent.

Specified by:

doUnlinkAttribute in class AbstractProtocol<MQTTAgent,MQTTAgentLink>

createIoClient

protected MQTT_IOClient createIoClient()
                                throws Exception

Overrides:

createIoClient in class AbstractIOClientProtocol<MQTTProtocol,MQTTAgent,MQTTMessage<String>,MQTT_IOClient,MQTTAgentLink>

Throws:

Exception

doCreateIoClient

protected MQTT_IOClient doCreateIoClient()
                                  throws Exception

Description copied from class: AbstractIOClientProtocol

Should return an instance of IOClient for the linked Agent.

Specified by:

doCreateIoClient in class AbstractIOClientProtocol<MQTTProtocol,MQTTAgent,MQTTMessage<String>,MQTT_IOClient,MQTTAgentLink>

Throws:

Exception

onMessageReceived

protected void onMessageReceived(MQTTMessage<String> message)

Description copied from class: AbstractIOClientProtocol

Called when the IOClient receives a message from the server

Specified by:

onMessageReceived in class AbstractIOClientProtocol<MQTTProtocol,MQTTAgent,MQTTMessage<String>,MQTT_IOClient,MQTTAgentLink>

createWriteMessage

protected MQTTMessage<String> createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute,
 MQTTAgentLink 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<MQTTProtocol,MQTTAgent,MQTTMessage<String>,MQTT_IOClient,MQTTAgentLink>

getProtocolName

public String getProtocolName()

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

Get the name for this protocol