Package org.openremote.manager.mqtt

Class ConnectionMonitorHandler

java.lang.Object

org.openremote.manager.mqtt.MQTTHandler

org.openremote.manager.mqtt.ConnectionMonitorHandler

public class ConnectionMonitorHandler
extends MQTTHandler

This MQTTHandler just monitors connected users and handles updating of Attributes with MetaItemType.USER_CONNECTED MetaItem. It doesn't handle any publishes or subscriptions.

Field Summary

Fields

Modifier and Type	Field	Description
protected AssetProcessingService	assetProcessingService
protected AssetStorageService	assetStorageService
protected ExecutorService	executorService
protected GatewayService	gatewayService
protected static final Logger	LOG
protected MQTTBrokerService	mqttBrokerService
protected org.openremote.container.persistence.PersistenceService	persistenceService
protected ConcurrentMap<String,Set<org.openremote.model.attribute.AttributeRef>>	userIDAttributeRefs

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

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

Constructor Summary

Constructors

Constructor	Description
ConnectionMonitorHandler()

Method Summary

Modifier and Type	Method	Description
protected void	addSessionAttribute(String userID, org.openremote.model.attribute.AttributeRef attributeRef)
protected void	addSessionAttributes(String realm, List<org.openremote.model.util.Pair<String,org.openremote.model.attribute.Attribute<?>>> assetIdsAttrs)
protected static boolean	attributeMatches(org.openremote.model.attribute.Attribute<?> attr)
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()
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 org.openremote.model.util.Pair<String,Set<org.openremote.model.attribute.AttributeRef>>	getUserIDAndAttributeRefs(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)
void	init(org.openremote.model.Container container, org.apache.activemq.artemis.core.config.Configuration serverConfiguration)	Called when the system starts to allow for initialisation.
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	onConnectionAuthenticated(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)	Called when an existing RemotingConnection is authenticated sometime after initially connecting (see UserAssetProvisioningMQTTHandler); the authenticated Subject can be retrieved using RemotingConnection.getSubject()
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.
protected void	removeSessionAttribute(String userID, org.openremote.model.attribute.AttributeRef attributeRef)
void	start(org.openremote.model.Container container)	Called when the system starts to allow for initialisation.
void	stop()	Called when the system stops to allow for any cleanup.
protected boolean	topicMatches(Topic topic)	Indicates if this handler will handle the specified topic; independent of whether it is a publish or subscribe.
protected void	updateUserConnectedStatus(String userID, Collection<org.openremote.model.attribute.AttributeRef> attributeRefs, boolean connected)

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

addPublishConsumer, addPublishTopicServerConfiguration, checkCanPublish, checkCanSubscribe, getAuthContextFromConnection, getAuthContextFromSecurityContext, getName, getPriority, getPublishTopicAddressSettings, getSecurityContextFromSubject, getSubjectFromConnection, handlesTopic, onUserAssetLinksChanged, publishMessage, 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

LOG

protected static final Logger LOG

mqttBrokerService

protected MQTTBrokerService mqttBrokerService

executorService

protected ExecutorService executorService

assetStorageService

protected AssetStorageService assetStorageService

assetProcessingService

protected AssetProcessingService assetProcessingService

gatewayService

protected GatewayService gatewayService

persistenceService

protected org.openremote.container.persistence.PersistenceService persistenceService

userIDAttributeRefs

protected ConcurrentMap<String,Set<org.openremote.model.attribute.AttributeRef>> userIDAttributeRefs

Constructor Details

ConnectionMonitorHandler

public ConnectionMonitorHandler()

Method Details

init

public void init(org.openremote.model.Container container,
 org.apache.activemq.artemis.core.config.Configuration serverConfiguration)
          throws Exception

Description copied from class: MQTTHandler

Called when the system starts to allow for initialisation.

Overrides:

init in class MQTTHandler

Throws:

Exception

start

public void start(org.openremote.model.Container container)
           throws Exception

Description copied from class: MQTTHandler

Called when the system starts to allow for initialisation.

Overrides:

start in class MQTTHandler

Throws:

Exception

stop

public void stop()
          throws Exception

Description copied from class: MQTTHandler

Called when the system stops to allow for any cleanup.

Overrides:

stop in class MQTTHandler

Throws:

Exception

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

onConnectionAuthenticated

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

Description copied from class: MQTTHandler

Called when an existing RemotingConnection is authenticated sometime after initially connecting (see UserAssetProvisioningMQTTHandler); the authenticated Subject can be retrieved using RemotingConnection.getSubject()

Overrides:

onConnectionAuthenticated in class MQTTHandler

topicMatches

protected 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

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

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

addSessionAttributes

protected void addSessionAttributes(String realm,
 List<org.openremote.model.util.Pair<String,org.openremote.model.attribute.Attribute<?>>> assetIdsAttrs)

addSessionAttribute

protected void addSessionAttribute(String userID,
 org.openremote.model.attribute.AttributeRef attributeRef)

removeSessionAttribute

protected void removeSessionAttribute(String userID,
 org.openremote.model.attribute.AttributeRef attributeRef)

updateUserConnectedStatus

protected void updateUserConnectedStatus(String userID,
 Collection<org.openremote.model.attribute.AttributeRef> attributeRefs,
 boolean connected)

getUserIDAndAttributeRefs

protected org.openremote.model.util.Pair<String,Set<org.openremote.model.attribute.AttributeRef>> getUserIDAndAttributeRefs(org.apache.activemq.artemis.spi.core.protocol.RemotingConnection connection)

attributeMatches

protected static boolean attributeMatches(org.openremote.model.attribute.Attribute<?> attr)