From 267054e4ba926bf4764e27048a6e3c2d1a6cc893 Mon Sep 17 00:00:00 2001
From: Ziver Koc <ziver@koc.se>
Date: Wed, 9 Jun 2021 23:27:42 +0200
Subject: [PATCH] Changed controllers to be singleton in the manager and moved
 isAvailable to AbstractController

---
 .../se/hal/intf/HalAbstractController.java    | 14 ++++++--
 .../intf/HalAbstractControllerManager.java    | 32 ++++++++++---------
 .../se/hal/intf/HalAutostartController.java   |  5 ---
 .../hal/plugin/netscan/NetScanController.java |  3 +-
 .../se/hal/plugin/netscan/NetworkDevice.java  |  4 +--
 5 files changed, 31 insertions(+), 27 deletions(-)

diff --git a/hal-core/src/se/hal/intf/HalAbstractController.java b/hal-core/src/se/hal/intf/HalAbstractController.java
index 7f2c05a7..aea8acaf 100644
--- a/hal-core/src/se/hal/intf/HalAbstractController.java
+++ b/hal-core/src/se/hal/intf/HalAbstractController.java
@@ -27,6 +27,14 @@ package se.hal.intf;
 
 public interface HalAbstractController {
 
+    /**
+     * Indicates if the controller has all the configuration
+     * data and resources needed to be able to initialize correctly.
+     */
+    default boolean isAvailable() {
+        return true;
+    }
+
     /**
      * The framework might create dummy objects so any type of
      * resource initialization should be handled in this method
@@ -35,13 +43,13 @@ public interface HalAbstractController {
     void initialize() throws Exception;
 
     /**
-     * Will register an device type to be handled by this controller
+     * Will register an device type to be handled by this controller.
      */
     void register(HalDeviceConfig deviceConfig);
 
     /**
      * Deregisters an device from this controller, the controller
-     * will no longer handle that type of event
+     * will no longer handle that type of event.
      */
     void deregister(HalDeviceConfig deviceConfig);
 
@@ -51,7 +59,7 @@ public interface HalAbstractController {
     int size();
 
     /**
-     * Set a listener that will receive all reports from the the registered devices
+     * Set a listener that will receive all reports from the the registered devices.
      */
     void setListener(HalDeviceReportListener listener);
 
diff --git a/hal-core/src/se/hal/intf/HalAbstractControllerManager.java b/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
index 072de6f7..f6f44467 100644
--- a/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
+++ b/hal-core/src/se/hal/intf/HalAbstractControllerManager.java
@@ -19,7 +19,7 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
     private static final Logger logger = LogUtil.getLogger();
 
     /** A map of all instantiated controllers **/
-    protected static Map<Class, HalAbstractController> controllerMap = new ConcurrentHashMap<>();
+    protected static Map<Class, HalAbstractController> controllerMap;
     /** All available sensor plugins **/
     protected List<Class<? extends C>> availableDeviceConfigs = new ArrayList<>();
 
@@ -39,16 +39,16 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
             logger.severe("Unable to retrieve Controller class from generics for class: " + this.getClass());
         }
 
-        for (Class<? extends C> deviceConfig : getAvailableDeviceConfigs()){
-            try {
-                @SuppressWarnings("unchecked")
-                Class<T> controllerClass = (Class<T>) deviceConfig.getDeclaredConstructor().newInstance().getDeviceControllerClass();
+        // Instantiate autostart controllers, but only the first time
 
-                if (controllerClass.isAssignableFrom(HalAutostartController.class)) {
-                    getControllerInstance(controllerClass); // Instantiate controller
+        synchronized (this) {
+            if (controllerMap == null) {
+                controllerMap = new ConcurrentHashMap<>();
+
+                for (Iterator<Class<? extends HalAutostartController>> it = pluginManager.getClassIterator(HalAutostartController.class); it.hasNext(); ) {
+                    Class controller = it.next();
+                    getControllerInstance(controller); // Instantiate controller
                 }
-            } catch (Exception e) {
-                logger.log(Level.WARNING, "Unable to instantiate Device Config for controller check: " + deviceConfig.getClass());
             }
         }
     }
@@ -118,7 +118,7 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
     /**
      * Will return a singleton controller instance of the given class.
      * If a instance does not exist yet the a new instance will be allocated
-     * depending on if the controller is ready thorough the {@link HalAutostartController#isAvailable()} method.
+     * depending on if the controller is ready thorough the {@link HalAbstractController#isAvailable()} method.
      *
      * @param clazz     is the class of the wanted object instance wanted
      * @return A singleton instance of the input clazz or null if the class is unavailable or not ready to be instantiated.
@@ -127,14 +127,14 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
         T controller;
 
         if (controllerMap.containsKey(clazz)) {
+            //noinspection unchecked
             controller = (T) controllerMap.get(clazz);
         } else {
             try {
                 // Instantiate controller
                 controller = clazz.getDeclaredConstructor().newInstance();
 
-                if (controller instanceof HalAutostartController &&
-                        ! ((HalAutostartController) controller).isAvailable()) {
+                if (!controller.isAvailable()) {
                     logger.warning("Controller is not ready: " + clazz.getName());
                     return null;
                 }
@@ -142,9 +142,6 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
                 logger.info("Instantiating new controller: " + clazz.getName());
                 controller.initialize();
 
-                if (this instanceof HalDeviceReportListener)
-                    controller.setListener((HalDeviceReportListener)this);
-
                 controllerMap.put(clazz, controller);
             } catch (Exception e){
                 logger.log(Level.SEVERE, "Unable to instantiate controller: " + clazz.getName(), e);
@@ -152,6 +149,11 @@ public abstract class HalAbstractControllerManager<T extends HalAbstractControll
             }
         }
 
+        // Assign the manager as a listener
+
+        if (this instanceof HalDeviceReportListener)
+            controller.setListener((HalDeviceReportListener) this);
+
         return controller;
     }
 
diff --git a/hal-core/src/se/hal/intf/HalAutostartController.java b/hal-core/src/se/hal/intf/HalAutostartController.java
index 91bd79f7..36b1987f 100644
--- a/hal-core/src/se/hal/intf/HalAutostartController.java
+++ b/hal-core/src/se/hal/intf/HalAutostartController.java
@@ -6,9 +6,4 @@ package se.hal.intf;
  */
 public interface HalAutostartController {
 
-    /**
-     * Indicates if the controller has all the configuration
-     * data and resources needed to be able to initialize correctly
-     */
-    boolean isAvailable();
 }
diff --git a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
index 63df7fc4..973dc690 100644
--- a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
+++ b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetScanController.java
@@ -3,7 +3,6 @@ package se.hal.plugin.netscan;
 import se.hal.HalContext;
 import se.hal.intf.*;
 import se.hal.struct.devicedata.AvailabilityEventData;
-import se.hal.struct.devicedata.OnOffEventData;
 import zutil.InetUtil;
 import zutil.log.LogUtil;
 import zutil.net.InetScanner;
@@ -91,7 +90,7 @@ public class NetScanController implements HalEventController, HalAutostartContro
         if (listener != null)
             listener.reportReceived(
                     new NetworkDevice(ip.getHostAddress()),
-                    new OnOffEventData(true, System.currentTimeMillis()));
+                    new AvailabilityEventData(true, System.currentTimeMillis()));
     }
 
 
diff --git a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetworkDevice.java b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetworkDevice.java
index b4ef9811..fef5c7ad 100644
--- a/plugins/hal-netscan/src/se/hal/plugin/netscan/NetworkDevice.java
+++ b/plugins/hal-netscan/src/se/hal/plugin/netscan/NetworkDevice.java
@@ -3,7 +3,7 @@ package se.hal.plugin.netscan;
 import se.hal.intf.HalEventConfig;
 import se.hal.intf.HalEventController;
 import se.hal.intf.HalEventData;
-import se.hal.struct.devicedata.OnOffEventData;
+import se.hal.struct.devicedata.AvailabilityEventData;
 import zutil.ui.conf.Configurator;
 
 public class NetworkDevice implements HalEventConfig {
@@ -30,7 +30,7 @@ public class NetworkDevice implements HalEventConfig {
     }
     @Override
     public Class<? extends HalEventData> getDeviceDataClass() {
-        return OnOffEventData.class;
+        return AvailabilityEventData.class;
     }