You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by gh...@apache.org on 2019/08/22 17:14:26 UTC
[sling-org-apache-sling-hc-webconsole] 01/01: SLING-8653 Noop
version of org.apache.sling.hc.webconsole
This is an automated email from the ASF dual-hosted git repository.
ghenzler pushed a commit to branch noop-version-for-felix-migration
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-webconsole.git
commit 9d4ed7920a5f86d5b829f1fc2b784768e12f87c3
Author: georg.henzler <ge...@netcentric.biz>
AuthorDate: Thu Aug 22 18:27:10 2019 +0200
SLING-8653 Noop version of org.apache.sling.hc.webconsole
---
bnd.bnd | 9 +
pom.xml | 50 ++--
.../impl/HealthCheckWebconsolePlugin.java | 301 ---------------------
.../sling/hc/webconsole/impl/NoopHcWebconsole.java | 41 +++
.../sling/hc/webconsole/impl/WebConsoleHelper.java | 74 -----
src/main/resources/res/ui/healthcheck.css | 46 ----
6 files changed, 73 insertions(+), 448 deletions(-)
diff --git a/bnd.bnd b/bnd.bnd
new file mode 100644
index 0000000..e19e747
--- /dev/null
+++ b/bnd.bnd
@@ -0,0 +1,9 @@
+Bundle-Category: sling
+
+Bundle-Description: ${project.description}
+
+Bundle-DocURL: https://sling.apache.org
+
+Bundle-License: Apache License, Version 2.0
+
+Bundle-Vendor: The Apache Software Foundation
diff --git a/pom.xml b/pom.xml
index 3a4637e..05fbead 100644
--- a/pom.xml
+++ b/pom.xml
@@ -24,21 +24,18 @@
<parent>
<groupId>org.apache.sling</groupId>
<artifactId>sling</artifactId>
- <version>26</version>
+ <version>33</version>
<relativePath/>
</parent>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.hc.webconsole</artifactId>
- <packaging>bundle</packaging>
- <version>1.1.3-SNAPSHOT</version>
+ <version>2.0.0-SNAPSHOT</version>
<name>Apache Sling Health Check Webconsole Plugin</name>
<inceptionYear>2013</inceptionYear>
- <description>
- Webconsole plugin for Sling Health Check Services
- </description>
+ <description>CAUTION: Noop Package - ensure Felix Health Check bundles are installed!</description>
<scm>
<connection>scm:git:https://gitbox.apache.org/repos/asf/sling-org-apache-sling-hc-webconsole.git</connection>
@@ -46,16 +43,15 @@
<url>https://gitbox.apache.org/repos/asf?p=sling-org-apache-sling-hc-webconsole.git</url>
</scm>
+ <properties>
+ <project.bundle.file>${project.build.directory}/${project.build.finalName}.jar</project.bundle.file>
+ </properties>
+
<build>
<plugins>
<plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-scr-plugin</artifactId>
- </plugin>
- <plugin>
- <groupId>org.apache.felix</groupId>
- <artifactId>maven-bundle-plugin</artifactId>
- <extensions>true</extensions>
+ <groupId>biz.aQute.bnd</groupId>
+ <artifactId>bnd-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
@@ -63,31 +59,31 @@
<dependencies>
<dependency>
<groupId>org.osgi</groupId>
- <artifactId>org.osgi.core</artifactId>
+ <artifactId>osgi.core</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
<groupId>org.osgi</groupId>
- <artifactId>org.osgi.compendium</artifactId>
+ <artifactId>osgi.cmpn</artifactId>
+ <scope>provided</scope>
</dependency>
<dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.hc.core</artifactId>
- <version>1.2.1-SNAPSHOT</version>
+ <groupId>org.osgi</groupId>
+ <artifactId>osgi.annotation</artifactId>
+ <version>6.0.1</version>
<scope>provided</scope>
- </dependency>
+ </dependency>
+
<dependency>
- <groupId>org.apache.sling</groupId>
- <artifactId>org.apache.sling.api</artifactId>
- <version>2.1.0</version>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>org.apache.felix.healthcheck.api</artifactId>
+ <version>2.0.2</version>
<scope>provided</scope>
</dependency>
- <dependency>
- <groupId>javax.servlet</groupId>
- <artifactId>servlet-api</artifactId>
- </dependency>
+
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
- </dependency>
+ </dependency>
</dependencies>
</project>
diff --git a/src/main/java/org/apache/sling/hc/webconsole/impl/HealthCheckWebconsolePlugin.java b/src/main/java/org/apache/sling/hc/webconsole/impl/HealthCheckWebconsolePlugin.java
deleted file mode 100644
index 59d43f1..0000000
--- a/src/main/java/org/apache/sling/hc/webconsole/impl/HealthCheckWebconsolePlugin.java
+++ /dev/null
@@ -1,301 +0,0 @@
-/*
- * 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 SF 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.sling.hc.webconsole.impl;
-
-import static org.apache.sling.hc.util.FormattingResultLog.msHumanReadable;
-
-import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
-import java.io.PrintWriter;
-import java.text.SimpleDateFormat;
-import java.util.Collection;
-
-import javax.servlet.Servlet;
-import javax.servlet.ServletException;
-import javax.servlet.http.HttpServlet;
-import javax.servlet.http.HttpServletRequest;
-import javax.servlet.http.HttpServletResponse;
-
-import org.apache.felix.scr.annotations.Component;
-import org.apache.felix.scr.annotations.Properties;
-import org.apache.felix.scr.annotations.Property;
-import org.apache.felix.scr.annotations.Reference;
-import org.apache.felix.scr.annotations.Service;
-import org.apache.sling.api.request.ResponseUtil;
-import org.apache.sling.hc.api.Result;
-import org.apache.sling.hc.api.ResultLog;
-import org.apache.sling.hc.api.execution.HealthCheckExecutionOptions;
-import org.apache.sling.hc.api.execution.HealthCheckExecutionResult;
-import org.apache.sling.hc.api.execution.HealthCheckExecutor;
-
-/** Webconsole plugin to execute health check services */
-@Component
-@Service(Servlet.class)
-@SuppressWarnings("serial")
-@Properties({
- @Property(name=org.osgi.framework.Constants.SERVICE_DESCRIPTION, value="Apache Sling Health Check Web Console Plugin"),
- @Property(name="felix.webconsole.label", value=HealthCheckWebconsolePlugin.LABEL),
- @Property(name="felix.webconsole.title", value=HealthCheckWebconsolePlugin.TITLE),
- @Property(name="felix.webconsole.category", value=HealthCheckWebconsolePlugin.CATEGORY),
- @Property(name="felix.webconsole.css", value="/healthcheck/res/ui/healthcheck.css")
-})
-public class HealthCheckWebconsolePlugin extends HttpServlet {
-
- public static final String TITLE = "Sling Health Check";
- public static final String LABEL = "healthcheck";
- public static final String CATEGORY = "Sling";
- public static final String PARAM_TAGS = "tags";
- public static final String PARAM_DEBUG = "debug";
- public static final String PARAM_QUIET = "quiet";
-
- public static final String PARAM_FORCE_INSTANT_EXECUTION = "forceInstantExecution";
- public static final String PARAM_COMBINE_TAGS_WITH_OR = "combineTagsWithOr";
- public static final String PARAM_OVERRIDE_GLOBAL_TIMEOUT = "overrideGlobalTimeout";
-
- @Reference
- private HealthCheckExecutor healthCheckExecutor;
-
- /** Serve static resource if applicable, and return true in that case */
- private boolean getStaticResource(final HttpServletRequest req, final HttpServletResponse resp)
- throws ServletException, IOException {
- final String pathInfo = req.getPathInfo();
- if (pathInfo!= null && pathInfo.contains("res/ui")) {
- final String prefix = "/" + LABEL;
- final InputStream is = getClass().getResourceAsStream(pathInfo.substring(prefix.length()));
- if (is == null) {
- resp.sendError(HttpServletResponse.SC_NOT_FOUND, pathInfo);
- } else {
- final OutputStream os = resp.getOutputStream();
- try {
- final byte [] buffer = new byte[16384];
- int n=0;
- while( (n = is.read(buffer, 0, buffer.length)) > 0) {
- os.write(buffer, 0, n);
- }
- } finally {
- try {
- is.close();
- } catch ( final IOException ignore ) {
- // ignore
- }
- }
- }
- return true;
- }
- return false;
- }
-
- @Override
- protected void doGet(final HttpServletRequest req, final HttpServletResponse resp)
- throws ServletException, IOException {
- if (getStaticResource(req, resp)) {
- return;
- }
-
- final String tags = getParam(req, PARAM_TAGS, null);
- final boolean debug = Boolean.valueOf(getParam(req, PARAM_DEBUG, "false"));
- final boolean quiet = Boolean.valueOf(getParam(req, PARAM_QUIET, "false"));
- final boolean combineTagsWithOr = Boolean.valueOf(getParam(req, PARAM_COMBINE_TAGS_WITH_OR, "false"));
- final boolean forceInstantExecution = Boolean.valueOf(getParam(req, PARAM_FORCE_INSTANT_EXECUTION, "false"));
- final String overrideGlobalTimeoutStr = getParam(req, PARAM_OVERRIDE_GLOBAL_TIMEOUT, "");
-
- final PrintWriter pw = resp.getWriter();
- doForm(pw, tags, debug, quiet, combineTagsWithOr, forceInstantExecution, overrideGlobalTimeoutStr);
-
- // Execute health checks only if tags are specified (even if empty)
- if (tags != null) {
- HealthCheckExecutionOptions options = new HealthCheckExecutionOptions();
- options.setCombineTagsWithOr(combineTagsWithOr);
- options.setForceInstantExecution(forceInstantExecution);
- try {
- options.setOverrideGlobalTimeout(Integer.valueOf(overrideGlobalTimeoutStr));
- } catch (NumberFormatException nfe) {
- // override not set in UI
- }
-
- Collection<HealthCheckExecutionResult> results = healthCheckExecutor.execute(options, tags.split(","));
-
- pw.println("<table class='content healthcheck' cellpadding='0' cellspacing='0' width='100%'>");
- int total = 0;
- int failed = 0;
- for (final HealthCheckExecutionResult exR : results) {
-
- final Result r = exR.getHealthCheckResult();
- total++;
- if (!r.isOk()) {
- failed++;
- }
- if (!quiet || !r.isOk()) {
- renderResult(pw, exR, debug);
- }
-
- }
- final WebConsoleHelper c = new WebConsoleHelper(resp.getWriter());
- c.titleHtml("Summary", total + " HealthCheck executed, " + failed + " failures");
- pw.println("</table>");
- pw.println("<a href='configMgr/org.apache.sling.hc.core.impl.executor.HealthCheckExecutorImpl'>Configure executor</a><br/><br/>");
-
- }
- }
-
- private void renderResult(final PrintWriter pw,
- final HealthCheckExecutionResult exResult,
- final boolean debug)
- throws IOException {
- final Result result = exResult.getHealthCheckResult();
- final WebConsoleHelper c = new WebConsoleHelper(pw);
-
- final StringBuilder status = new StringBuilder();
-
- status.append("Tags: ").append(exResult.getHealthCheckMetadata().getTags());
- status.append(" Finished: ").append(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(exResult.getFinishedAt()) + " after "
- + msHumanReadable(exResult.getElapsedTimeInMs()));
-
- c.titleHtml(exResult.getHealthCheckMetadata().getTitle(), null);
-
- c.tr();
- c.tdContent();
- c.writer().print(ResponseUtil.escapeXml(status.toString()));
- c.writer().print("<br/>Result: <span class='resultOk");
- c.writer().print(result.isOk());
- c.writer().print("'>");
- c.writer().print(result.getStatus().toString());
- c.writer().print("</span>");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdContent();
- for(final ResultLog.Entry e : result) {
- if (!debug && e.getStatus().equals(Result.Status.DEBUG)) {
- continue;
- }
- c.writer().print("<div class='log");
- c.writer().print(e.getStatus().toString());
- c.writer().print("'>");
- c.writer().print(e.getStatus().toString());
- c.writer().print(' ');
- c.writer().print(ResponseUtil.escapeXml(e.getMessage()));
- if (e.getException() != null) {
- c.writer().print(" ");
- c.writer().print(ResponseUtil.escapeXml(e.getException().toString()));
- }
- c.writer().println("</div>");
- }
- c.closeTd();
- }
-
- private void doForm(final PrintWriter pw,
- final String tags,
- final boolean debug,
- final boolean quiet,
- final boolean combineTagsWithOr,
- final boolean forceInstantExecution,
- final String overrideGlobalTimeoutStr)
- throws IOException {
- final WebConsoleHelper c = new WebConsoleHelper(pw);
- pw.print("<form method='get'>");
- pw.println("<table class='content' cellpadding='0' cellspacing='0' width='100%'>");
- c.titleHtml(TITLE, "To execute health check services, enter "
- + " an optional list of tags, to select specific health checks, or no tags for all checks."
- + " Prefix a tag with a minus sign (-) to omit checks having that tag.");
-
- c.tr();
- c.tdLabel("Health Check tags (comma-separated)");
- c.tdContent();
- c.writer().print("<input type='text' name='" + PARAM_TAGS + "' value='");
- if ( tags != null ) {
- c.writer().print(ResponseUtil.escapeXml(tags));
- }
- c.writer().println("' class='input' size='80'>");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdLabel("Combine tags with logical 'OR' instead of the default 'AND'");
- c.tdContent();
- c.writer().print("<input type='checkbox' name='" + PARAM_COMBINE_TAGS_WITH_OR + "' class='input' value='true'");
- if (combineTagsWithOr) {
- c.writer().print(" checked=true");
- }
- c.writer().println(">");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdLabel("Show DEBUG logs");
- c.tdContent();
- c.writer().print("<input type='checkbox' name='" + PARAM_DEBUG + "' class='input' value='true'");
- if ( debug ) {
- c.writer().print(" checked=true");
- }
- c.writer().println(">");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdLabel("Show failed checks only");
- c.tdContent();
- c.writer().print("<input type='checkbox' name='" + PARAM_QUIET + "' class='input' value='true'");
- if ( quiet ) {
- c.writer().print(" checked=true");
- }
- c.writer().println(">");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdLabel("Force instant execution (no cache, async checks are executed)");
- c.tdContent();
- c.writer().print("<input type='checkbox' name='" + PARAM_FORCE_INSTANT_EXECUTION + "' class='input' value='true'");
- if (forceInstantExecution) {
- c.writer().print(" checked=true");
- }
- c.writer().println(">");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdLabel("Override global timeout");
- c.tdContent();
- c.writer().print("<input type='text' name='" + PARAM_OVERRIDE_GLOBAL_TIMEOUT + "' value='");
- if (overrideGlobalTimeoutStr != null) {
- c.writer().print(ResponseUtil.escapeXml(overrideGlobalTimeoutStr));
- }
- c.writer().println("' class='input' size='80'>");
- c.closeTd();
- c.closeTr();
-
- c.tr();
- c.tdContent();
- c.writer().println("<input type='submit' value='Execute selected health checks'/>");
- c.closeTd();
- c.closeTr();
-
- c.writer().println("</table></form>");
- }
-
- private String getParam(final HttpServletRequest req, final String name, final String defaultValue) {
- String result = req.getParameter(name);
- if(result == null) {
- result = defaultValue;
- }
- return result;
- }
-}
diff --git a/src/main/java/org/apache/sling/hc/webconsole/impl/NoopHcWebconsole.java b/src/main/java/org/apache/sling/hc/webconsole/impl/NoopHcWebconsole.java
new file mode 100644
index 0000000..79039e3
--- /dev/null
+++ b/src/main/java/org/apache/sling/hc/webconsole/impl/NoopHcWebconsole.java
@@ -0,0 +1,41 @@
+/*
+ * 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.sling.hc.webconsole.impl;
+
+import org.apache.felix.hc.api.execution.HealthCheckExecutor;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Component(immediate = true)
+public class NoopHcWebconsole {
+ private static final Logger LOG = LoggerFactory.getLogger(NoopHcWebconsole.class);
+
+ @Reference
+ protected HealthCheckExecutor executor;
+
+ @Activate
+ protected void activate() {
+ LOG.debug("The Sling Health Check Core Bundle is obsolete and replaced by Felix Health Check "
+ + "(found Felix HC executor: " + executor + ")");
+ }
+
+}
diff --git a/src/main/java/org/apache/sling/hc/webconsole/impl/WebConsoleHelper.java b/src/main/java/org/apache/sling/hc/webconsole/impl/WebConsoleHelper.java
deleted file mode 100644
index e623f31..0000000
--- a/src/main/java/org/apache/sling/hc/webconsole/impl/WebConsoleHelper.java
+++ /dev/null
@@ -1,74 +0,0 @@
-/*
- * 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 SF 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.sling.hc.webconsole.impl;
-
-import java.io.PrintWriter;
-
-import org.apache.sling.api.request.ResponseUtil;
-
-/** Webconsole plugin to execute health check rules */
-class WebConsoleHelper {
-
- final PrintWriter pw;
-
- WebConsoleHelper(final PrintWriter w) {
- pw = w;
- }
-
- PrintWriter writer() {
- return pw;
- }
-
- void tdContent() {
- pw.print("<td class='content' colspan='2'>");
- }
-
- void closeTd() {
- pw.print("</td>");
- }
-
- void closeTr() {
- pw.println("</tr>");
- }
-
- void tdLabel(final String label) {
- pw.print("<td class='content'>");
- pw.print(ResponseUtil.escapeXml(label));
- pw.println("</td>");
- }
-
- void tr() {
- pw.println("<tr class='content'>");
- }
-
- void titleHtml(String title, String description) {
- tr();
- pw.print("<th colspan='3' class='content container'>");
- pw.print(ResponseUtil.escapeXml(title));
- pw.println("</th>");
- closeTr();
-
- if (description != null) {
- tr();
- pw.print("<td colspan='3' class='content'>");
- pw.print(ResponseUtil.escapeXml(description));
- pw.println("</th>");
- closeTr();
- }
- }
-}
diff --git a/src/main/resources/res/ui/healthcheck.css b/src/main/resources/res/ui/healthcheck.css
deleted file mode 100644
index 75b79cf..0000000
--- a/src/main/resources/res/ui/healthcheck.css
+++ /dev/null
@@ -1,46 +0,0 @@
-/*
- * 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.
- */
-
-.healthcheck .logDEBUG {
- color:grey;
-}
-
-.healthcheck .logINFO {
- color:blue;
-}
-
-.healthcheck .logWARN,
-.healthcheck .logCRITICAL,
-.healthcheck .logHEALTH_CHECK_ERROR
-{
- color:red;
-}
-
-.healthcheck .logERROR {
- color:red;
- font-weight:bold;
-}
-
-.healthcheck .resultOktrue {
- color:green;
- font-weight:bold;
-}
-
-.healthcheck .resultOkfalse {
- color:red;
- font-weight:bold;
-}