Added support for dashboard links to external services.

bundles/org.openhab.ui.dashboard/README.md

@@ -0,0 +1,34 @@
+# Dashboard tiles
+
+OpenHAB dashboard is landing page for the user where all openHAB UI's can be found. Dashboard support also links to external services. Links can be added to dashboard by ```conf/services/dashboard.cfg``` configuration file.
+
+## Link Configuration
+
+| Parameter name  | Type    | Description                                                                             |
+|-----------------|---------|-----------------------------------------------------------------------------------------|
+| link-nameX      | String  | Name which is shown in the openHAB dashboard.                                           |
+| link-urlX       | String  | URL to external service.                                                                |
+| link-overlayX   | String  | Image overlay icon. Supported values are empty (no icon), "html5", "android" or "apple" |
+| link-imageurlX  | String  | URL to image.                                                                           |
+
+Where X is link unique number (see examples). All configuration parameters need to start with ```org.openhab.ui.dashboard:``` prefix.
+
+## Image URL
+
+Image URL support several URL formats. URL support direct http links to local or Internet servers, but also the "data" URL scheme (RFC2397) is supported. See e.g. [https://www.base64-image.de](https://www.base64-image.de) to convert images to base64 coded data.
+
+## Example configuration file
+```
+org.openhab.ui.dashboard:link-name1=openHAB Log Viewer
+org.openhab.ui.dashboard:link-url1=http://localhost:9001
+org.openhab.ui.dashboard:link-overlay1=
+org.openhab.ui.dashboard:link-imageurl1=http://localhost:8080/static/image.png
+
+org.openhab.ui.dashboard:link-name2=Node-RED
+org.openhab.ui.dashboard:link-url2=http://localhost:1880
+org.openhab.ui.dashboard:link-overlay2=
+org.openhab.ui.dashboard:link-imageurl2=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAXwAAACfCAIAAA...QmCC
+
+```
+
+Note: **Link 2** image data URL is not valid (it's shorten for the sake of clarity).

bundles/org.openhab.ui.dashboard/src/main/java/org/openhab/ui/dashboard/internal/DashboardService.java

@@ -11,6 +11,7 @@
 import java.io.IOException;
 import java.net.URL;
 import java.util.Hashtable;
+import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.CopyOnWriteArraySet;
 
@@ -50,7 +51,13 @@ public class DashboardService {
 
     private BundleContext bundleContext;
 
-    protected void activate(ComponentContext componentContext) {
+    private final static String LINK_NAME = "link-name";
+    private final static String LINK_URL = "link-url";
+    private final static String LINK_OVERLAY = "link-overlay";
+    private final static String LINK_IMAGEURL = "link-imageurl";
+
+    protected void activate(ComponentContext componentContext, Map<String, Object> properties) {
+
         try {
             bundleContext = componentContext.getBundleContext();
             Hashtable<String, String> props = new Hashtable<>();
@@ -69,6 +76,8 @@ protected void activate(ComponentContext componentContext) {
         } catch (NamespaceException | ServletException e) {
             logger.error("Error during dashboard startup: {}", e.getMessage());
         }
+
+        addTilesToExternalServices(properties);
     }
 
     protected void deactivate(ComponentContext componentContext) {
@@ -153,4 +162,30 @@ protected HttpServlet createServlet() {
         return new DashboardServlet(configurationAdmin, indexTemplate, entryTemplate, warnTemplate, setupTemplate,
                 tiles);
     }
+
+    private void addTilesToExternalServices(Map<String, Object> properties) {
+        for (String key : properties.keySet()) {
+            if (key.startsWith(LINK_NAME)) {
+                if (key.length() > LINK_NAME.length()) {
+                    try {
+                        // get index number from link name
+                        int index = Integer.parseInt(key.substring(LINK_NAME.length()));
+
+                        String name = (String) properties.get(LINK_NAME + Integer.toString(index));
+                        String url = (String) properties.get(LINK_URL + Integer.toString(index));
+                        String overlay = (String) properties.get(LINK_OVERLAY + Integer.toString(index));
+                        String imageUrl = (String) properties.get(LINK_IMAGEURL + Integer.toString(index));
+
+                        logger.debug("Add link: {}", name);
+
+                        addDashboardTile(new DashboardTileImp.DashboardTileBuilder().withName(name).withUrl(url)
+                                .withOverlay(overlay).withImageUrl(imageUrl).build());
+                    } catch (NumberFormatException e) {
+                        logger.error("Syntax error in dashboard tile '{}'", key);
+                    }
+
+                }
+            }
+        }
+    }
 }

bundles/org.openhab.ui.dashboard/src/main/java/org/openhab/ui/dashboard/internal/DashboardTileImp.java

@@ -0,0 +1,82 @@
+/**
+ * Copyright (c) 2010-2017 by the respective copyright holders.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.openhab.ui.dashboard.internal;
+
+import org.openhab.ui.dashboard.DashboardTile;
+
+/**
+ * The dashboard tile for external services.
+ *
+ * @author Pauli Anttila - Initial contribution
+ */
+public class DashboardTileImp implements DashboardTile {
+    private String name;
+    private String url;
+    private String overlay;
+    private String imageUrl;
+
+    private DashboardTileImp(DashboardTileBuilder builder) {
+        this.name = builder.name;
+        this.url = builder.url;
+        this.overlay = builder.overlay;
+        this.imageUrl = builder.imageUrl;
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public String getUrl() {
+        return url;
+    }
+
+    @Override
+    public String getOverlay() {
+        return overlay;
+    }
+
+    @Override
+    public String getImageUrl() {
+        return imageUrl;
+    }
+
+    public static class DashboardTileBuilder {
+
+        private String name;
+        private String url;
+        private String overlay;
+        private String imageUrl;
+
+        public DashboardTileBuilder withName(String name) {
+            this.name = name;
+            return this;
+        }
+
+        public DashboardTileBuilder withUrl(String url) {
+            this.url = url;
+            return this;
+        }
+
+        public DashboardTileBuilder withOverlay(String overlay) {
+            this.overlay = overlay;
+            return this;
+        }
+
+        public DashboardTileBuilder withImageUrl(String imageUrl) {
+            this.imageUrl = imageUrl;
+            return this;
+        }
+
+        public DashboardTileImp build() {
+            return new DashboardTileImp(this);
+        }
+    }
+}