Package org.openremote.manager.mqtt

Class DefaultMQTTHandler

java.lang.Object

org.openremote.manager.mqtt.MQTTHandler

org.openremote.manager.mqtt.DefaultMQTTHandler

public class DefaultMQTTHandler
extends MQTTHandler

This handler uses the ClientEventService to publish and subscribe to asset and attribute events; converting subscription topics into AssetFilters to ensure only the correct events are returned for the subscription.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ASSET_TOPIC
static final String	ATTRIBUTE_TOPIC
static final String	ATTRIBUTE_VALUE_TOPIC
static final String	ATTRIBUTE_VALUE_WRITE_TOPIC
static final String	ATTRIBUTE_WRITE_TOPIC
protected final com.google.common.cache.Cache<String,org.apache.activemq.artemis.utils.collections.ConcurrentHashSet<String>>	authorizationCache
protected final com.google.common.cache.Cache<String,org.openremote.model.event.shared.EventSubscription<?>>	eventSubscriptionCache
static final int	PRIORITY
protected final Map<String,Map<String,Consumer<? extends org.openremote.model.event.Event>>>	sessionSubscriptionConsumers

Fields inherited from class org.openremote.manager.mqtt.MQTTHandler

clientEventService, clientSession, executorService, identityProvider, isKeycloak, messageBrokerService, mqttBrokerService, producer, timerService, TOKEN_MULTI_LEVEL_WILDCARD, TOKEN_SINGLE_LEVEL_WILDCARD

Constructor Summary

Constructors

Constructor	Description
DefaultMQTTHandler()

Method Summary

Modifier and Type	Method	Description
protected static org.openremote.model.asset.AssetFilter<?>	buildAssetFilter(Topic topic)
protected static org.openremote.model.attribute.AttributeEvent	buildAttributeEvent(List<String> topicTokens, Object value, Long timestamp)
boolean	canPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, org.keycloak.KeycloakSecurityContext securityContext, Topic topic)	Called to authorise a publish if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true; should return true if the publish is allowed otherwise return false.
boolean	canSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, org.keycloak.KeycloakSecurityContext securityContext, Topic topic)	Called to authorise a subscription if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true; should return true if the subscription is allowed otherwise return false.
protected Logger	getLogger()
int	getPriority()	Gets the priority of this handler which is used to determine the call order; handlers with a lower priority are initialised and started first.
Set<String>	getPublishListenerTopics()	Get the set of topics this handler wants to subscribe to for incoming publish messages; messages that match these topics will be passed to MQTTHandler.onPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.openremote.manager.mqtt.Topic, io.netty.buffer.ByteBuf).
protected static String	getSessionKey(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)
protected <T extends org.openremote.model.event.Event> Consumer<T>	getSubscriptionEventConsumer(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, Topic topic)
protected static boolean	isAssetTopic(Topic topic)
protected static boolean	isAttributeTopic(Topic topic)
protected static boolean	isAttributeValueWriteTopic(Topic topic)
protected static boolean	isAttributeWriteTopic(Topic topic)
void	onConnect(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)	Will be called when any client connects; if returns false then subsequent handlers will not be called
void	onConnectionLost(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)	Will be called when any client loses connection
void	onDisconnect(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)	Will be called when any client disconnects
void	onPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, Topic topic, io.netty.buffer.ByteBuf body)	Called to handle publish if MQTTHandler.canPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.keycloak.KeycloakSecurityContext, org.openremote.manager.mqtt.Topic) returned true.
void	onSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, Topic topic)	Called to handle subscribe if MQTTHandler.canSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.keycloak.KeycloakSecurityContext, org.openremote.manager.mqtt.Topic) returned true.
void	onUnsubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, Topic topic)	Called to handle unsubscribe if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true.
void	onUserAssetLinksChanged(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection, List<org.openremote.model.PersistenceEvent<org.openremote.model.asset.UserAssetLink>> changes)	Called when UserAssetLinks for a restricted user are changed and that user has an active connection (subject can be accessed from the connection).
boolean	topicMatches(Topic topic)	Indicates if this handler will handle the specified topic; independent of whether it is a publish or subscribe.

Methods inherited from class org.openremote.manager.mqtt.MQTTHandler

addPublishConsumer, addPublishTopicServerConfiguration, checkCanPublish, checkCanSubscribe, getAuthContextFromConnection, getAuthContextFromSecurityContext, getName, getPublishTopicAddressSettings, getSecurityContextFromSubject, getSubjectFromConnection, handlesTopic, init, onConnectionAuthenticated, publishMessage, start, stop, topicClientID, topicClientIdMatches, topicRealm, topicRealmAllowed, topicTokenCountGreaterThan, topicTokenIndexToString

Methods inherited from class java.lang.Object

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

Field Details

PRIORITY

public static final int PRIORITY

See Also:

• Constant Field Values

ASSET_TOPIC

public static final String ASSET_TOPIC

See Also:

• Constant Field Values

ATTRIBUTE_TOPIC

public static final String ATTRIBUTE_TOPIC

See Also:

• Constant Field Values

ATTRIBUTE_VALUE_TOPIC

public static final String ATTRIBUTE_VALUE_TOPIC

See Also:

• Constant Field Values

ATTRIBUTE_VALUE_WRITE_TOPIC

public static final String ATTRIBUTE_VALUE_WRITE_TOPIC

See Also:

• Constant Field Values

ATTRIBUTE_WRITE_TOPIC

public static final String ATTRIBUTE_WRITE_TOPIC

See Also:

• Constant Field Values

sessionSubscriptionConsumers

protected final Map<String,Map<String,Consumer<? extends org.openremote.model.event.Event>>> sessionSubscriptionConsumers

authorizationCache

protected final com.google.common.cache.Cache<String,org.apache.activemq.artemis.utils.collections.ConcurrentHashSet<String>> authorizationCache

eventSubscriptionCache

protected final com.google.common.cache.Cache<String,org.openremote.model.event.shared.EventSubscription<?>> eventSubscriptionCache

Constructor Details

DefaultMQTTHandler

public DefaultMQTTHandler()

Method Details

getPriority

public int getPriority()

Description copied from class: MQTTHandler

Gets the priority of this handler which is used to determine the call order; handlers with a lower priority are initialised and started first.

Overrides:

getPriority in class MQTTHandler

onConnect

public void onConnect(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)

Description copied from class: MQTTHandler

Will be called when any client connects; if returns false then subsequent handlers will not be called

Overrides:

onConnect in class MQTTHandler

onDisconnect

public void onDisconnect(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)

Description copied from class: MQTTHandler

Will be called when any client disconnects

Overrides:

onDisconnect in class MQTTHandler

onConnectionLost

public void onConnectionLost(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)

Description copied from class: MQTTHandler

Will be called when any client loses connection

Overrides:

onConnectionLost in class MQTTHandler

topicMatches

public boolean topicMatches(Topic topic)

Description copied from class: MQTTHandler

Indicates if this handler will handle the specified topic; independent of whether it is a publish or subscribe. Should generally check the third token onwards unless MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) has been overridden.

Specified by:

topicMatches in class MQTTHandler

getLogger

protected Logger getLogger()

Specified by:

getLogger in class MQTTHandler

canSubscribe

public boolean canSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 org.keycloak.KeycloakSecurityContext securityContext,
 Topic topic)

Description copied from class: MQTTHandler

Called to authorise a subscription if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true; should return true if the subscription is allowed otherwise return false.

Specified by:

canSubscribe in class MQTTHandler

canPublish

public boolean canPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 org.keycloak.KeycloakSecurityContext securityContext,
 Topic topic)

Description copied from class: MQTTHandler

Called to authorise a publish if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true; should return true if the publish is allowed otherwise return false.

Specified by:

canPublish in class MQTTHandler

onSubscribe

public void onSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 Topic topic)

Description copied from class: MQTTHandler

Called to handle subscribe if MQTTHandler.canSubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.keycloak.KeycloakSecurityContext, org.openremote.manager.mqtt.Topic) returned true.

Specified by:

onSubscribe in class MQTTHandler

onUnsubscribe

public void onUnsubscribe(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 Topic topic)

Description copied from class: MQTTHandler

Called to handle unsubscribe if MQTTHandler.handlesTopic(org.openremote.manager.mqtt.Topic) returned true.

Specified by:

onUnsubscribe in class MQTTHandler

getPublishListenerTopics

public Set<String> getPublishListenerTopics()

Description copied from class: MQTTHandler

Get the set of topics this handler wants to subscribe to for incoming publish messages; messages that match these topics will be passed to MQTTHandler.onPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.openremote.manager.mqtt.Topic, io.netty.buffer.ByteBuf).

Specified by:

getPublishListenerTopics in class MQTTHandler

onPublish

public void onPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 Topic topic,
 io.netty.buffer.ByteBuf body)

Description copied from class: MQTTHandler

Called to handle publish if MQTTHandler.canPublish(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection, org.keycloak.KeycloakSecurityContext, org.openremote.manager.mqtt.Topic) returned true.

Specified by:

onPublish in class MQTTHandler

onUserAssetLinksChanged

public void onUserAssetLinksChanged(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 List<org.openremote.model.PersistenceEvent<org.openremote.model.asset.UserAssetLink>> changes)

Description copied from class: MQTTHandler

Called when UserAssetLinks for a restricted user are changed and that user has an active connection (subject can be accessed from the connection).

Overrides:

onUserAssetLinksChanged in class MQTTHandler

buildAttributeEvent

protected static org.openremote.model.attribute.AttributeEvent buildAttributeEvent(List<String> topicTokens,
 Object value,
 Long timestamp)

buildAssetFilter

protected static org.openremote.model.asset.AssetFilter<?> buildAssetFilter(Topic topic)

getSubscriptionEventConsumer

protected <T extends org.openremote.model.event.Event>
Consumer<T> getSubscriptionEventConsumer(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection,
 Topic topic)

isAttributeTopic

protected static boolean isAttributeTopic(Topic topic)

isAttributeValueWriteTopic

protected static boolean isAttributeValueWriteTopic(Topic topic)

isAttributeWriteTopic

protected static boolean isAttributeWriteTopic(Topic topic)

isAssetTopic

protected static boolean isAssetTopic(Topic topic)

getSessionKey

protected static String getSessionKey(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)