git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.mqtt.internal;
  14
  15 import java.util.Collections;
  16 import java.util.Map;
  17 import java.util.Set;
  18 import java.util.WeakHashMap;
  19 import java.util.concurrent.ConcurrentHashMap;
  20 import java.util.stream.Collectors;
  21 import java.util.stream.Stream;
  22
  23 import org.eclipse.jdt.annotation.NonNullByDefault;
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.mqtt.MqttBindingConstants;
  26 import org.openhab.binding.mqtt.discovery.MQTTTopicDiscoveryParticipant;
  27 import org.openhab.binding.mqtt.discovery.MQTTTopicDiscoveryService;
  28 import org.openhab.binding.mqtt.handler.AbstractBrokerHandler;
  29 import org.openhab.binding.mqtt.handler.BrokerHandler;
  30 import org.openhab.core.thing.Bridge;
  31 import org.openhab.core.thing.Thing;
  32 import org.openhab.core.thing.ThingTypeUID;
  33 import org.openhab.core.thing.binding.BaseThingHandlerFactory;
  34 import org.openhab.core.thing.binding.ThingHandler;
  35 import org.openhab.core.thing.binding.ThingHandlerFactory;
  36 import org.osgi.service.component.annotations.Component;
  37
  38 /**
  39  * The {@link MqttBrokerHandlerFactory} is responsible for creating things and thing
  40  * handlers. It keeps reference to all handlers and implements the {@link MQTTTopicDiscoveryService} service
  41  * interface, so service consumers can subscribe to a topic on all available broker connections.
  42  *
  43  * @author David Graeff - Initial contribution
  44  */
  45 @NonNullByDefault
  46 @Component(service = { ThingHandlerFactory.class,
  47         MQTTTopicDiscoveryService.class }, configurationPid = "MqttBrokerHandlerFactory")
  48 public class MqttBrokerHandlerFactory extends BaseThingHandlerFactory implements MQTTTopicDiscoveryService {
  49
  50     private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Stream
  51             .of(MqttBindingConstants.BRIDGE_TYPE_BROKER).collect(Collectors.toSet());
  52
  53     /**
  54      * This Map provides a lookup between a Topic string (key) and a Set of MQTTTopicDiscoveryParticipants (value),
  55      * where the Set itself is a list of participants which are subscribed to the respective Topic.
  56      */
  57     protected final Map<String, Set<MQTTTopicDiscoveryParticipant>> discoveryTopics = new ConcurrentHashMap<>();
  58
  59     /**
  60      * This Set contains a list of all the Broker handlers that have been created by this factory
  61      */
  62     protected final Set<AbstractBrokerHandler> handlers = Collections
  63             .synchronizedSet(Collections.newSetFromMap(new WeakHashMap<>()));
  64
  65     @Override
  66     public boolean supportsThingType(ThingTypeUID thingTypeUID) {
  67         return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
  68     }
  69
  70     /**
  71      * Add the given broker handler to the list of known handlers. And then iterate over all topics and their respective
  72      * list of listeners, and register the respective new listener and topic with the given new broker handler.
  73      */
  74     protected void createdHandler(AbstractBrokerHandler handler) {
  75         handlers.add(handler);
  76         discoveryTopics.forEach((topic, listeners) -> {
  77             listeners.forEach(listener -> {
  78                 handler.registerDiscoveryListener(listener, topic);
  79             });
  80         });
  81     }
  82
  83     @Override
  84     protected @Nullable ThingHandler createHandler(Thing thing) {
  85         if (!(thing instanceof Bridge)) {
  86             throw new IllegalStateException("A bridge type is expected");
  87         }
  88         final ThingTypeUID thingTypeUID = thing.getThingTypeUID();
  89
  90         final AbstractBrokerHandler handler;
  91         if (thingTypeUID.equals(MqttBindingConstants.BRIDGE_TYPE_BROKER)) {
  92             handler = new BrokerHandler((Bridge) thing);
  93         } else {
  94             throw new IllegalStateException("Not supported " + thingTypeUID.toString());
  95         }
  96         createdHandler(handler);
  97         return handler;
  98     }
  99
 100     /**
 101      * This factory also implements {@link MQTTTopicDiscoveryService} so consumers can subscribe to
 102      * a MQTT topic that is registered on all available broker connections.
 103      *
 104      * Checks each topic, and if the listener is not already in the listener list for that topic, adds itself from that
 105      * list, and registers itself and the respective topic with all the known brokers.
 106      */
 107     @Override
 108     @SuppressWarnings("null")
 109     public void subscribe(MQTTTopicDiscoveryParticipant listener, String topic) {
 110         Set<MQTTTopicDiscoveryParticipant> listeners = discoveryTopics.computeIfAbsent(topic,
 111                 t -> ConcurrentHashMap.newKeySet());
 112         if (listeners.add(listener)) {
 113             handlers.forEach(broker -> broker.registerDiscoveryListener(listener, topic));
 114         }
 115     }
 116
 117     /**
 118      * This factory also implements {@link MQTTTopicDiscoveryService} so consumers can unsubscribe from
 119      * a MQTT topic that is registered on all available broker connections.
 120      *
 121      * Checks each topic, and if the listener is in the listener list for that topic, removes itself from that list, and
 122      * unregisters itself and the respective topic from all the known brokers.
 123      */
 124     @Override
 125     public void unsubscribe(MQTTTopicDiscoveryParticipant listener) {
 126         discoveryTopics.forEach((topic, listeners) -> {
 127             if (listeners.remove(listener)) {
 128                 handlers.forEach(broker -> broker.unregisterDiscoveryListener(listener, topic));
 129             }
 130         });
 131     }
 132
 133     @Override
 134     public void publish(String topic, byte[] payload, int qos, boolean retain) {
 135         handlers.forEach(handler -> {
 136             handler.getConnectionAsync().thenAccept(connection -> {
 137                 connection.publish(topic, payload, qos, retain);
 138             });
 139         });
 140     }
 141 }