[addon suggestion finder] add means to disable finders

Signed-off-by: Andrew Fiddian-Green <[email protected]>
openhab · Nov 7, 2023 · 1c0ec43 · 1c0ec43
1 parent 6f3bc01
commit 1c0ec43
Show file tree

Hide file tree

Showing 5 changed files with 107 additions and 34 deletions.
diff --git a/...n/src/main/java/org/openhab/core/config/discovery/addon/AddonSuggestionFinderService.java b/...n/src/main/java/org/openhab/core/config/discovery/addon/AddonSuggestionFinderService.java
@@ -87,6 +87,17 @@ public void close() throws Exception {
         addonInfoProviders.clear();
     }
 
+    /**
+     * The OH framework calls this method to enable/disable the finder with the given service id (if any).
+     * 
+     * @param finderServiceId the service id of the finder to be enabled/disabled.
+     * @param enable true to enable, false to disable
+     */
+    public void enable(String finderServiceId, boolean enable) {
+        addonSuggestionFinders.stream().filter(f -> finderServiceId.equals(f.getServiceType())).findFirst()
+                .ifPresent(f -> f.enable(enable));
+    }
+
     public Set<AddonInfo> getSuggestedAddons(@Nullable Locale locale) {
         return addonSuggestionFinders.stream().map(f -> f.getSuggestedAddons()).flatMap(Collection::stream)
                 .collect(Collectors.toSet());

diff --git a/.../src/main/java/org/openhab/core/config/discovery/addon/finders/AddonSuggestionFinder.java b/.../src/main/java/org/openhab/core/config/discovery/addon/finders/AddonSuggestionFinder.java
@@ -27,13 +27,34 @@
 public interface AddonSuggestionFinder {
 
     /**
-     * The framework calls this method to scan through the candidate list of {@link AddonInfo} and return a subset of
+     * This method should be overridden and referenced so that the OSGI framework will call it when the component is
+     * deactivated. It should clear the finder's internal state.
+     */
+    public void deactivate();
+
+    /**
+     * The OH framework calls this method to enable or disable the finder. Typically e.g. for upnp and mdns, it connects
+     * to resp. disconnects from, the underlying discovery transport.
+     * 
+     * @param enable true to enable, false to disable
+     */
+    public void enable(boolean enable);
+
+    /**
+     * The OH framework calls this method to read the finder service type.
+     * 
+     * @return the finder service type
+     */
+    public String getServiceType();
+
+    /**
+     * The OH framework calls this method to scan through the candidate list of {@link AddonInfo} and return a subset of
      * those that it suggests to be installed.
      */
     public Set<AddonInfo> getSuggestedAddons();
 
     /**
-     * The framework calls this method to provide a list of {@link AddonInfo} elements which contain potential
+     * The OH framework calls this method to provide a list of {@link AddonInfo} elements which contain potential
      * candidates that this finder can iterate over in order to detect which ones to return via the
      * {@code getSuggestedAddons()} method.
      * 

diff --git a/.../main/java/org/openhab/core/config/discovery/addon/finders/BaseAddonSuggestionFinder.java b/.../main/java/org/openhab/core/config/discovery/addon/finders/BaseAddonSuggestionFinder.java
@@ -16,7 +16,6 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 import java.util.regex.Pattern;
 
 import org.eclipse.jdt.annotation.NonNullByDefault;
@@ -51,18 +50,13 @@ protected static boolean propertyMatches(Map<String, Pattern> propertyPatternMap
 
     protected final List<AddonInfo> addonCandidates = Collections.synchronizedList(new ArrayList<>());
 
-    protected void deactivate() {
-        resetAddonCandidates();
-    }
-
-    public abstract Set<AddonInfo> getSuggestedAddons();
-
-    protected void resetAddonCandidates() {
+    @Override
+    public void deactivate() {
         addonCandidates.clear();
     }
 
-    public void setAddonCandidates(List<AddonInfo> candidates) {
-        resetAddonCandidates();
+    public synchronized void setAddonCandidates(List<AddonInfo> candidates) {
+        addonCandidates.clear();
         addonCandidates.addAll(candidates);
     }
 }
diff --git a/.../main/java/org/openhab/core/config/discovery/addon/finders/MDNSAddonSuggestionFinder.java b/.../main/java/org/openhab/core/config/discovery/addon/finders/MDNSAddonSuggestionFinder.java
@@ -71,13 +71,43 @@ public void addService(ServiceInfo service, boolean isResolved) {
         }
     }
 
+    private void connect() {
+        addonCandidates
+                .forEach(c -> c.getDiscoveryMethods().stream().filter(m -> SERVICE_TYPE.equals(m.getServiceType()))
+                        .filter(m -> !m.getMdnsServiceType().isEmpty()).forEach(m -> {
+                            String serviceType = m.getMdnsServiceType();
+                            mdnsClient.addServiceListener(serviceType, this);
+                            scheduler.submit(() -> mdnsClient.list(serviceType));
+                        }));
+    }
+
     @Deactivate
     @Override
-    protected void deactivate() {
+    public void deactivate() {
         services.clear();
+        disconnect();
         super.deactivate();
     }
 
+    private void disconnect() {
+        addonCandidates.forEach(c -> c.getDiscoveryMethods().stream()
+                .filter(m -> SERVICE_TYPE.equals(m.getServiceType())).filter(m -> !m.getMdnsServiceType().isEmpty())
+                .forEach(m -> mdnsClient.removeServiceListener(m.getMdnsServiceType(), this)));
+    }
+
+    @Override
+    public void enable(boolean enable) {
+        disconnect();
+        if (enable) {
+            connect();
+        }
+    }
+
+    @Override
+    public String getServiceType() {
+        return SERVICE_TYPE;
+    }
+
     @Override
     public Set<AddonInfo> getSuggestedAddons() {
         Set<AddonInfo> result = new HashSet<>();
@@ -110,6 +140,10 @@ && propertyMatches(matchProperties, APPLICATION, service.getApplication())
         return result;
     }
 
+    /*
+     * ************ MDNSClient call-back methods ************
+     */
+
     @Override
     public void serviceAdded(@Nullable ServiceEvent event) {
         if (event != null) {
@@ -134,22 +168,10 @@ public void serviceResolved(@Nullable ServiceEvent event) {
         }
     }
 
-    @Override
-    protected void resetAddonCandidates() {
-        addonCandidates.forEach(c -> c.getDiscoveryMethods().stream()
-                .filter(m -> SERVICE_TYPE.equals(m.getServiceType())).filter(m -> !m.getMdnsServiceType().isEmpty())
-                .forEach(m -> mdnsClient.removeServiceListener(m.getMdnsServiceType(), this)));
-        super.resetAddonCandidates();
-    }
-
     @Override
     public void setAddonCandidates(List<AddonInfo> candidates) {
+        disconnect();
         super.setAddonCandidates(candidates);
-        candidates.forEach(c -> c.getDiscoveryMethods().stream().filter(m -> SERVICE_TYPE.equals(m.getServiceType()))
-                .filter(m -> !m.getMdnsServiceType().isEmpty()).forEach(m -> {
-                    String serviceType = m.getMdnsServiceType();
-                    mdnsClient.addServiceListener(serviceType, this);
-                    scheduler.submit(() -> mdnsClient.list(serviceType));
-                }));
+        connect();
     }
 }
diff --git a/.../main/java/org/openhab/core/config/discovery/addon/finders/UpnpAddonSuggestionFinder.java b/.../main/java/org/openhab/core/config/discovery/addon/finders/UpnpAddonSuggestionFinder.java
@@ -74,11 +74,7 @@ public class UpnpAddonSuggestionFinder extends BaseAddonSuggestionFinder impleme
     @Activate
     public UpnpAddonSuggestionFinder(@Reference UpnpService upnpService) {
         this.upnpService = upnpService;
-        Registry registry = upnpService.getRegistry();
-        for (RemoteDevice device : registry.getRemoteDevices()) {
-            remoteDeviceAdded(registry, device);
-        }
-        registry.addListener(this);
+        connect();
     }
 
     public void addDevice(RemoteDevice device) {
@@ -93,14 +89,39 @@ public void addDevice(RemoteDevice device) {
         }
     }
 
+    private void connect() {
+        Registry registry = upnpService.getRegistry();
+        for (RemoteDevice device : registry.getRemoteDevices()) {
+            remoteDeviceAdded(registry, device);
+        }
+        registry.addListener(this);
+    }
+
     @Deactivate
     @Override
-    protected void deactivate() {
+    public void deactivate() {
         devices.clear();
-        upnpService.getRegistry().removeListener(this);
+        disconnect();
         super.deactivate();
     }
 
+    private void disconnect() {
+        upnpService.getRegistry().removeListener(this);
+    }
+
+    @Override
+    public void enable(boolean enable) {
+        disconnect();
+        if (enable) {
+            connect();
+        }
+    }
+
+    @Override
+    public String getServiceType() {
+        return SERVICE_TYPE;
+    }
+
     @Override
     public Set<AddonInfo> getSuggestedAddons() {
         Set<AddonInfo> result = new HashSet<>();
@@ -179,6 +200,10 @@ && propertyMatches(matchProperties, FRIENDLY_NAME, friendlyName)) {
         return result;
     }
 
+    /*
+     * ************ UpnpService call-back methods ************
+     */
+
     @Override
     public void afterShutdown() {
     }