Add Root Cause Webconsole Plugin

webconsole-plugins/root-cause/README.md

@@ -0,0 +1,5 @@
+# Root Cause OSGI Web Console Plugin
+
+A Felix Webconsole Plugin for [Root Cause Tool](https://github.com/apache/felix/tree/trunk/rootcause)
+
+![Plugin Demo](doc/root-cause-plugin.gif)

webconsole-plugins/root-cause/pom.xml

@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor 
+    license agreements. See the NOTICE file distributed with this work for additional 
+    information regarding copyright ownership. The ASF licenses this file to 
+    you under the Apache License, Version 2.0 (the "License"); you may not use 
+    this file except in compliance with the License. You may obtain a copy of 
+    the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required 
+    by applicable law or agreed to in writing, software distributed under the 
+    License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS 
+    OF ANY KIND, either express or implied. See the License for the specific 
+    language governing permissions and limitations under the License. -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>org.apache.felix</groupId>
+        <artifactId>felix-parent</artifactId>
+        <version>5</version>
+        <relativePath>../../../pom/pom.xml</relativePath>
+    </parent>
+
+    <artifactId>org.apache.felix.webconsole.plugins.rootcause</artifactId>
+    <packaging>bundle</packaging>
+    <version>1.0.0-SNAPSHOT</version>
+
+    <name>felix-root-cause-webconsole-plugin</name>
+    <description>Root Cause plugin for Apache Felix Web Console</description>
+
+    <properties>
+        <felix.java.version>8</felix.java.version>
+    </properties>
+    <scm>
+        <connection>
+            scm:svn:http://svn.apache.org/repos/asf/felix/trunk/webconsole-plugins/root-cause
+        </connection>
+        <developerConnection>
+            scm:svn:https://svn.apache.org/repos/asf/felix/trunk/webconsole-plugins/root-cause
+        </developerConnection>
+        <url>
+            http://svn.apache.org/viewvc/felix/trunk/webconsole-plugins/root-cause
+        </url>
+    </scm>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <version>3.2.0</version>
+                <extensions>true</extensions>
+                <configuration>
+                    <instructions>
+                        <Bundle-SymbolicName>${project.artifactId}</Bundle-SymbolicName>
+                        <Bundle-Description>${project.description}</Bundle-Description>
+                        <Embed-Dependency>
+                            org.apache.felix.rootcause,
+                            org.apache.felix.utils;inline=org/apache/felix/utils/json/JSONWriter**
+                        </Embed-Dependency>
+                        <Import-Package>
+                            sun.misc.*;resolution:=optional,
+                            *
+                        </Import-Package>
+                        <Private-Package>
+                            org.apache.felix.webconsole.plugins.rootcause.*
+                        </Private-Package>
+                    </instructions>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.rat</groupId>
+                <artifactId>apache-rat-plugin</artifactId>
+                <configuration>
+                    <includes>
+                        <include>src/**</include>
+                    </includes>
+                    <excludes>
+                        <exclude>src/main/resources/root-cause/**</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+    <dependencies>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>osgi.core</artifactId>
+            <version>6.0.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>osgi.cmpn</artifactId>
+            <version>6.0.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>osgi.annotation</artifactId>
+            <version>6.0.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>org.osgi.service.component.annotations</artifactId>
+            <version>1.3.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.osgi</groupId>
+            <artifactId>org.osgi.service.metatype.annotations</artifactId>
+            <version>1.3.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.webconsole</artifactId>
+            <version>4.3.8</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>javax.servlet</groupId>
+            <artifactId>servlet-api</artifactId>
+            <version>2.3</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.utils</artifactId>
+            <version>1.11.4</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.felix</groupId>
+            <artifactId>org.apache.felix.rootcause</artifactId>
+            <version>0.1.0</version>
+        </dependency>
+    </dependencies>
+</project>

webconsole-plugins/root-cause/src/main/java/org/apache/felix/webconsole/plugins/rootcause/internal/RootCausePlugin.java

@@ -0,0 +1,177 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.felix.webconsole.plugins.rootcause.internal;
+
+import static org.apache.felix.webconsole.WebConsoleConstants.PLUGIN_CATEGORY;
+import static org.apache.felix.webconsole.WebConsoleConstants.PLUGIN_LABEL;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.net.URL;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.NoSuchElementException;
+import java.util.Optional;
+import java.util.stream.Collectors;
+import javax.servlet.Servlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.apache.felix.rootcause.DSComp;
+import org.apache.felix.rootcause.RootCauseCommand;
+import org.apache.felix.rootcause.RootCausePrinter;
+import org.apache.felix.utils.json.JSONWriter;
+import org.apache.felix.webconsole.AbstractWebConsolePlugin;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.runtime.ServiceComponentRuntime;
+
+
+@Component(
+    service = Servlet.class,
+    property = {
+        PLUGIN_LABEL + "=" + RootCausePlugin.LABEL,
+        PLUGIN_CATEGORY + "=" + RootCausePlugin.CATEGORY,
+    })
+public class RootCausePlugin extends AbstractWebConsolePlugin {
+
+  // lives under OSGI Menu.
+  public static final String CATEGORY = "OSGi";
+
+  public static final String LABEL = "root-cause"; // used for the URL
+  public static final String TITLE = "Root Cause"; // used for the menu item title (UI)
+  public static final String RESOURCE_PREFIX = "/" + LABEL + "/";
+
+  private String pluginHtml;
+
+  @Reference
+  private RootCauseCommand rootCauseCommand;
+
+  @Reference
+  private ServiceComponentRuntime runtime;
+
+  @Activate
+  protected void activate() {
+    this.pluginHtml = getPluginHtml();
+  }
+
+  @Override
+  protected void renderContent(HttpServletRequest request, HttpServletResponse response)
+      throws IOException {
+    if (isHtmlRequest(request)) {
+      response.getWriter().write(getPluginHtml());
+    } else if (request.getPathInfo().equalsIgnoreCase("/" + LABEL + "/rootcause.json")) {
+      response.setContentType("application/json");
+      String name = request.getParameter("name");
+      response.getWriter().write(getRootCauses(name));
+    } else if (request.getPathInfo().equalsIgnoreCase("/" + LABEL + "/components.json")) {
+      response.setContentType("application/json");
+      response.getWriter().write(getComponentNamesJsonArray());
+    }
+  }
+
+  // I know, strange, does not override anything...
+  // see: https://github.com/justinedelson/felix/blob/df21d1b2eb10543de05727dce890cd6a9a347375/webconsole/src/main/java/org/apache/felix/webconsole/AbstractWebConsolePlugin.java#L230
+  // This method is called by this plugin to return a URL of a "resource" file
+  public URL getResource(final String path) {
+    if (path.startsWith(RESOURCE_PREFIX)) {
+      // get resource from this project/bundle "resources" folder
+      return this.getClass().getResource(path);
+    }
+    return null;
+  }
+
+  @Override
+  public String getLabel() {
+    return LABEL;
+  }
+
+  @Override
+  public String getTitle() {
+    return TITLE;
+  }
+
+  protected boolean isHtmlRequest(HttpServletRequest request) {
+    return ("/" + LABEL).equalsIgnoreCase(request.getPathInfo());
+  }
+
+  /**
+   * Returns the plugin's HTML as String
+   * The HTML in this case comes fom the plugin.html file in the "resources" folder.
+   */
+  private String getPluginHtml() {
+    if (null == this.pluginHtml) {
+      this.pluginHtml = readResourceString("plugin.html");
+    }
+    return this.pluginHtml;
+  }
+
+  /**
+   * Read resource file from the RESOURCE_PREFIX folder.
+   */
+  private String readResourceString(String name) {
+    return readTemplateFile(RESOURCE_PREFIX + name);
+  }
+
+  private String getComponentNamesJsonArray() throws IOException{
+    List<String> componentNames = Optional.of(runtime)
+        .map(ServiceComponentRuntime::getComponentDescriptionDTOs)
+        .map(dtos -> dtos.stream().map(dto -> dto.name).collect(Collectors.toList()))
+        .orElse(null);
+    return toJsonArray(componentNames);
+  }
+
+  private String toJsonArray(List<String> list) throws IOException {
+    StringWriter sw = new StringWriter();
+    JSONWriter jw = new JSONWriter(sw);
+    jw.array();
+    if (null != list) {
+      for(String str: list) {
+        jw.value(str);
+      }
+    }
+    jw.endArray();
+    jw.flush();
+    return sw.toString();
+  }
+
+  /**
+   * Get root cause lines as string JSON Array.
+   */
+  private String getRootCauses (String name) throws IOException {
+    DSComp rootCause = null;
+    List<String> causes = new ArrayList<>();
+    try {
+      rootCause = rootCauseCommand.rootcause(name);
+    } catch (NoSuchElementException e){
+      // thrown when component cannot be found. needs to be fixed in RootCauseCommand#rootcause
+      // see FELIX-6217
+      log("Could not find component with name: " + name, e);
+    }
+    if (rootCause == null) {
+      causes.add("Component with name: \""+ name + "\" Does not exist.");
+      causes.add("Tip: Use the component full name, for example: "
+          + "\"org.apache.felix.webconsole.plugins.rootcause.internal.RootCausePlugin\"");
+    } else {
+      new RootCausePrinter(causes::add).print(rootCause);
+    }
+
+    return toJsonArray(causes);
+  }
+}

webconsole-plugins/root-cause/src/main/resources/root-cause/jquery-ui-1.12.1.custom/README.md

@@ -0,0 +1,3 @@
+This directory was generated using:
+
+[https://jqueryui.com/download/#!version=1.12.1&components=100000010001000001000000000000000000000000000000](https://jqueryui.com/download/#!version=1.12.1&components=100000010001000001000000000000000000000000000000)