Avoid chatty API calls during extension load

Signed-off-by: Mitch Gaffigan <mitch.gaffigan@comcast.net>

Author: mgaffigan

client/src/com/mirth/connect/client/ui/Frame.java

@@ -724,14 +724,16 @@ public void dispose() {
     private void loadExtensionMetaData() throws ClientException {
         loadedPlugins = mirthClient.getPluginMetaData();
         loadedConnectors = mirthClient.getConnectorMetaData();
+        Map<String, Boolean> extensionStatuses = mirthClient.getExtensionStatuses();
 
         // Register extension JAX-RS providers with the client
         Set<String> apiProviderPackages = new HashSet<String>();
         Set<String> apiProviderClasses = new HashSet<String>();
 
         for (Object extensionMetaData : CollectionUtils.union(loadedPlugins.values(), loadedConnectors.values())) {
             MetaData metaData = (MetaData) extensionMetaData;
-            if (mirthClient.isExtensionEnabled(metaData.getName())) {
+            // Check if disabled (unknown extensions are enabled by default)
+            if (!Boolean.FALSE.equals(extensionStatuses.get(metaData.getName()))) {
                 for (ApiProvider provider : metaData.getApiProviders(Version.getLatest())) {
                     switch (provider.getType()) {
                         case SERVLET_INTERFACE_PACKAGE:

client/src/com/mirth/connect/client/ui/LoadedExtensions.java

@@ -102,12 +102,21 @@ public void initialize() {
         // initialized again
         clearExtensionMaps();
 
+        Map<String, Boolean> extensionStatuses;
+        try {
+            extensionStatuses = PlatformUI.MIRTH_FRAME.mirthClient.getExtensionStatuses();
+        } catch (Exception e) {
+            PlatformUI.MIRTH_FRAME.alertThrowable(PlatformUI.MIRTH_FRAME, e);
+            return;
+        }
+
         // Order all the plugins by their weight before loading any of them.
         Map<String, String> pluginNameMap = new HashMap<String, String>();
         NavigableMap<Integer, List<String>> weightedPlugins = new TreeMap<Integer, List<String>>();
         for (PluginMetaData metaData : PlatformUI.MIRTH_FRAME.getPluginMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                // Check if disabled (unknown extensions are enabled by default)
+                if (!Boolean.FALSE.equals(extensionStatuses.get(metaData.getName()))) {
                     extensionVersions.put(metaData.getName(), metaData.getPluginVersion());
                     if (metaData.getClientClasses() != null) {
                         for (PluginClass pluginClass : metaData.getClientClasses()) {
@@ -150,7 +159,8 @@ public void initialize() {
         // Load connector code template plugins before anything else
         for (ConnectorMetaData metaData : PlatformUI.MIRTH_FRAME.getConnectorMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                // Check if disabled (unknown extensions are enabled by default)
+                if (!Boolean.FALSE.equals(extensionStatuses.get(metaData.getName()))) {
                     extensionVersions.put(metaData.getName(), metaData.getPluginVersion());
                     if (StringUtils.isNotEmpty(metaData.getTemplateClassName())) {
                         Class<?> clazz = Class.forName(metaData.getTemplateClassName());
@@ -205,7 +215,8 @@ public void initialize() {
 
         for (ConnectorMetaData metaData : PlatformUI.MIRTH_FRAME.getConnectorMetaData().values()) {
             try {
-                if (PlatformUI.MIRTH_FRAME.mirthClient.isExtensionEnabled(metaData.getName())) {
+                // Check if disabled (unknown extensions are enabled by default)
+                if (!Boolean.FALSE.equals(extensionStatuses.get(metaData.getName()))) {
 
                     String connectorName = metaData.getName();
                     ConnectorSettingsPanel connectorSettingsPanel = (ConnectorSettingsPanel) Class.forName(metaData.getClientClassName()).newInstance();

server/src/com/mirth/connect/client/core/Client.java

@@ -2622,6 +2622,16 @@ public boolean isExtensionEnabled(String extensionName) throws ClientException {
         return getServlet(ExtensionServletInterface.class).isExtensionEnabled(extensionName);
     }
 
+    /**
+     * Returns the enabled status of extensions on the classpath.
+     * 
+     * @see ExtensionServletInterface#getExtensionStatuses
+     */
+    @Override
+    public Map<String, Boolean> getExtensionStatuses() throws ClientException {
+        return getServlet(ExtensionServletInterface.class).getExtensionStatuses();
+    }
+
     /**
      * Enables or disables an extension.
      * 

server/src/com/mirth/connect/client/core/api/servlets/ExtensionServletInterface.java

@@ -111,6 +111,16 @@ public void uninstallExtension(@Param("extensionPath") @RequestBody(description
     @MirthOperation(name = "isExtensionEnabled", display = "Check if extension is enabled", auditable = false)
     public boolean isExtensionEnabled(@Param("extensionName") @Parameter(description = "The name of the extension to retrieve.", required = true) @PathParam("extensionName") String extensionName) throws ClientException;
 
+    @GET
+    @Path("/enabled")
+    @Operation(summary = "Returns the enabled status of extensions on the classpath.")
+    @ApiResponse(content = { @Content(mediaType = MediaType.APPLICATION_XML, examples = {
+            @ExampleObject(name = "extensionStatuses", value = "<map><entry><string>Channel Reader</string><boolean>true</boolean></entry></map>") }),
+            @Content(mediaType = MediaType.APPLICATION_JSON, examples = {
+                    @ExampleObject(name = "extensionStatuses", value = "{\"Channel Reader\":true}") }) })
+    @MirthOperation(name = "getExtensionStatuses", display = "Get extension enabled statuses", auditable = false)
+    public Map<String, Boolean> getExtensionStatuses() throws ClientException;
+
     @POST
     @Path("/{extensionName}/_setEnabled")
     @Operation(summary = "Enables or disables an extension.")

server/src/com/mirth/connect/server/api/servlets/ExtensionServlet.java

@@ -102,6 +102,11 @@ public boolean isExtensionEnabled(String extensionName) {
         return extensionController.isExtensionEnabled(extensionName);
     }
 
+    @Override
+    public Map<String, Boolean> getExtensionStatuses() {
+        return extensionController.getExtensionStatuses();
+    }
+
     @Override
     public void setExtensionEnabled(String extensionName, boolean enabled) {
         try {

server/src/com/mirth/connect/server/controllers/DefaultExtensionController.java

@@ -364,6 +364,21 @@ public boolean isExtensionEnabled(String extensionName) {
         return extensionStatuses.isEnabled(extensionName);
     }
 
+    @Override
+    public Map<String, Boolean> getExtensionStatuses() {
+        Map<String, Boolean> extensionStatusMap = new HashMap<String, Boolean>();
+
+        for (MetaData metaData : getPluginMetaData().values()) {
+            extensionStatusMap.put(metaData.getName(), isExtensionEnabled(metaData.getName()));
+        }
+
+        for (MetaData metaData : getConnectorMetaData().values()) {
+            extensionStatusMap.put(metaData.getName(), isExtensionEnabled(metaData.getName()));
+        }
+
+        return extensionStatusMap;
+    }
+
     @Override
     public void startPlugins() {
         for (ServerPlugin serverPlugin : serverPlugins) {

server/src/com/mirth/connect/server/controllers/ExtensionController.java

@@ -86,6 +86,11 @@ public static ExtensionController getInstance() {
      */
     public abstract boolean isExtensionEnabled(String name);
 
+    /**
+     * Returns the enabled status of extensions on the classpath, keyed by extension name.
+     */
+    public abstract Map<String, Boolean> getExtensionStatuses();
+
     /**
      * Invokes the start method on all loaded server plugins.
      */