Add Microprofile Health

appserver/distributions/glassfish/pom.xml

@@ -142,6 +142,10 @@
                                     basedir="${patches}/microprofile-rest-client-api" includes="META-INF/MANIFEST.MF"
                                     destfile="${glassfish.modules}/microprofile-rest-client-api.jar"
                                 />
+                                <jarupdate if:set="java17orGreater"
+                                           basedir="${patches}/microprofile-health-api" includes="META-INF/MANIFEST.MF"
+                                           destfile="${glassfish.modules}/microprofile-health-api.jar"
+                                />
                                 <jarupdate
                                     basedir="${patches}/tyrus-client" includes="META-INF/MANIFEST.MF"
                                     destfile="${glassfish.modules}/tyrus-client.jar"

appserver/distributions/glassfish/src/main/patches/microprofile-health-api/META-INF/MANIFEST.MF

@@ -0,0 +1,28 @@
+Manifest-Version: 1.0
+Bundle-Description: MicroProfile Health :: API
+Bundle-License: Apache License, Version 2.0
+Bundle-SymbolicName: org.eclipse.microprofile.health
+Bnd-LastModified: 1664892780713
+Bundle-ManifestVersion: 2
+Bundle-DocURL: https://microprofile.io/project/eclipse/microprofile-he
+ alth/microprofile-health-api
+Bundle-Vendor: Eclipse Foundation
+Import-Package: jakarta.enterprise.util;version="[3.0,5)",jakarta.inje
+ ct;version="[2.0,4)",org.eclipse.microprofile.health;version="[3.0,5)
+ ",org.eclipse.microprofile.health.spi;version="[1.1,2)"
+Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"
+Tool: Bnd-5.2.0.202010142003
+Export-Package: org.eclipse.microprofile.health;version="3.0";uses:="j
+ akarta.enterprise.util,jakarta.inject,org.eclipse.microprofile.health
+ .spi",org.eclipse.microprofile.health.spi;version="1.1";uses:="org.ec
+ lipse.microprofile.health"
+Bundle-Name: MicroProfile Health Check Bundle
+Bundle-Version: 4.0.1
+Bundle-SCM: url="https://github.com/eclipse/microprofile-health/microp
+ rofile-health-api",connection="scm:git:https://github.com/eclipse/mic
+ roprofile-health.git/microprofile-health-api",developer-connection="s
+ cm:git:[email protected]:eclipse/microprofile-health.git/microprofile-he
+ alth-api",tag="4.0.1"
+Build-Jdk-Spec: 1.8
+Created-By: 1.8.0_292 (AdoptOpenJDK)
+

appserver/featuresets/glassfish/pom.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-    Copyright (c) 2022, 2023 Contributors to Eclipse Foundation.
+    Copyright (c) 2022, 2024 Contributors to Eclipse Foundation.
     Copyright (c) 2015, 2022 Oracle and/or its affiliates. All rights reserved.
 
     This program and the accompanying materials are made available under the
@@ -840,6 +840,40 @@
                     </exclusions>
                 </dependency>
 
+                <!-- MicroProfile Health -->
+                <dependency>
+                    <groupId>org.eclipse.microprofile.health</groupId>
+                    <artifactId>microprofile-health-api</artifactId>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
+                <dependency>
+                    <groupId>org.glassfish.main.microprofile</groupId>
+                    <artifactId>microprofile-health</artifactId>
+                    <version>${project.version}</version>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
+                <dependency>
+                    <groupId>org.glassfish.main.microprofile</groupId>
+                    <artifactId>health-glassfish</artifactId>
+                    <version>${project.version}</version>
+                    <exclusions>
+                        <exclusion>
+                            <groupId>*</groupId>
+                            <artifactId>*</artifactId>
+                        </exclusion>
+                    </exclusions>
+                </dependency>
+
                 <!-- MicroProfile JWT -->
                 <dependency>
                     <groupId>org.eclipse.microprofile.jwt</groupId>

appserver/microprofile/health-glassfish/pom.xml

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>org.glassfish.main.microprofile</groupId>
+        <artifactId>microprofile-parent</artifactId>
+        <version>7.1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>health-glassfish</artifactId>
+    <packaging>glassfish-jar</packaging>
+
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.glassfish.main.microprofile</groupId>
+            <artifactId>microprofile-health</artifactId>
+            <version>${project.version}</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.json.bind</groupId>
+            <artifactId>jakarta.json.bind-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>jakarta.enterprise</groupId>
+            <artifactId>jakarta.enterprise.cdi-api</artifactId>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <release>17</release>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.felix</groupId>
+                <artifactId>maven-bundle-plugin</artifactId>
+                <configuration>
+                    <supportedProjectTypes>
+                        <supportedProjectType>glassfish-jar</supportedProjectType>
+                    </supportedProjectTypes>
+                    <instructions>
+                        <Include-Resource>
+                            {maven-resources},
+                            META-INF/hk2-locator/=target/classes/META-INF/hk2-locator/,
+                        </Include-Resource>
+                    </instructions>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>osgi-bundle</id>
+                        <phase>package</phase>
+                        <goals>
+                            <goal>bundle</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>

appserver/microprofile/health-glassfish/src/main/java/org/glassfish/microprofile/health/service/CollectHealthChecksExtension.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) 2024 Contributors to Eclipse Foundation.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+package org.glassfish.microprofile.health.service;
+
+import jakarta.enterprise.context.spi.CreationalContext;
+import jakarta.enterprise.event.Observes;
+import jakarta.enterprise.inject.spi.AfterDeploymentValidation;
+import jakarta.enterprise.inject.spi.Annotated;
+import jakarta.enterprise.inject.spi.Bean;
+import jakarta.enterprise.inject.spi.BeanManager;
+import jakarta.enterprise.inject.spi.Extension;
+import jakarta.enterprise.inject.spi.ProcessBean;
+
+import java.util.Collections;
+import java.util.EnumSet;
+import java.util.Set;
+import java.util.concurrent.ConcurrentHashMap;
+
+
+import org.eclipse.microprofile.health.HealthCheck;
+import org.eclipse.microprofile.health.Liveness;
+import org.eclipse.microprofile.health.Readiness;
+import org.eclipse.microprofile.health.Startup;
+import org.glassfish.api.invocation.InvocationManager;
+import org.glassfish.hk2.api.ServiceLocator;
+import org.glassfish.hk2.utilities.ServiceLocatorUtilities;
+import org.glassfish.internal.api.Globals;
+import org.glassfish.microprofile.health.HealthCheckInfo;
+import org.glassfish.microprofile.health.HealthReporter;
+
+
+public class CollectHealthChecksExtension implements Extension {
+    private final HealthReporter service;
+    private final Set<HealthCheckBeanAndKind> healthChecks = Collections.newSetFromMap(new ConcurrentHashMap<>());
+    private final InvocationManager invocationManager;
+
+    record HealthCheckBeanAndKind(Bean<HealthCheck> bean, Set<HealthCheckInfo.Kind> kind) {
+    }
+
+    public CollectHealthChecksExtension() {
+        ServiceLocator defaultBaseServiceLocator = Globals.getDefaultBaseServiceLocator();
+        invocationManager = Globals.get(InvocationManager.class);
+        HealthReporter healthReporterService = defaultBaseServiceLocator.getService(HealthReporter.class);
+        if (healthReporterService == null) {
+            ServiceLocatorUtilities.addClasses(defaultBaseServiceLocator, true, HealthReporter.class);
+            healthReporterService = defaultBaseServiceLocator.getService(HealthReporter.class);
+        }
+        service = healthReporterService;
+    }
+
+    @SuppressWarnings("unchecked")
+    public <T> void processBeans(@Observes ProcessBean<T> beans) {
+        Annotated annotated = beans.getAnnotated();
+        boolean livenessPresent = annotated.isAnnotationPresent(Liveness.class);
+        boolean readinessPresent = annotated.isAnnotationPresent(Readiness.class);
+        boolean startupPresent = annotated.isAnnotationPresent(Startup.class);
+        if (livenessPresent || readinessPresent || startupPresent) {
+            Bean<T> bean = beans.getBean();
+            if (bean.getTypes().contains(HealthCheck.class)) {
+                Set<HealthCheckInfo.Kind> kinds = EnumSet.noneOf(HealthCheckInfo.Kind.class);
+                if (livenessPresent) {
+                    kinds.add(HealthCheckInfo.Kind.LIVE);
+                }
+                if (readinessPresent) {
+                    kinds.add(HealthCheckInfo.Kind.READY);
+                }
+                if (startupPresent) {
+                    kinds.add(HealthCheckInfo.Kind.STARTUP);
+                }
+
+                healthChecks.add(new HealthCheckBeanAndKind((Bean<HealthCheck>) bean, kinds));
+            }
+        }
+    }
+
+    public void afterDeploymentValidation(@Observes AfterDeploymentValidation adv, BeanManager beanManager) {
+        healthChecks.forEach(healthCheckBeanAndKind -> {
+            Bean<HealthCheck> bean = healthCheckBeanAndKind.bean();
+            CreationalContext<HealthCheck> creationalContext = beanManager.createCreationalContext(bean);
+            if (beanManager.getReference(bean, HealthCheck.class, creationalContext) instanceof HealthCheck healthCheck) {
+                service.addHealthCheck(invocationManager.getCurrentInvocation().getAppName(),
+                        new HealthCheckInfo(healthCheck, healthCheckBeanAndKind.kind()));
+            }
+        });
+    }
+}

appserver/microprofile/health-glassfish/src/main/java/org/glassfish/microprofile/health/service/HealthService.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2024 Contributors to Eclipse Foundation.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+package org.glassfish.microprofile.health.service;
+
+import jakarta.inject.Inject;
+
+import org.glassfish.api.StartupRunLevel;
+import org.glassfish.api.event.EventListener;
+import org.glassfish.api.event.Events;
+import org.glassfish.hk2.api.PostConstruct;
+import org.glassfish.hk2.runlevel.RunLevel;
+import org.glassfish.internal.api.Globals;
+import org.glassfish.internal.data.ApplicationInfo;
+import org.glassfish.internal.deployment.Deployment;
+import org.glassfish.microprofile.health.HealthReporter;
+import org.jvnet.hk2.annotations.Service;
+
+@Service(name = "healthcheck-service")
+@RunLevel(StartupRunLevel.VAL)
+public class HealthService implements EventListener, PostConstruct {
+
+    @Inject
+    Events events;
+
+    @Override
+    public void postConstruct() {
+        events.register(this);
+    }
+
+    @Override
+    public void event(Event<?> event) {
+
+        HealthReporter service = Globals.getDefaultHabitat().getService(HealthReporter.class);
+
+        if (service == null) {
+            return;
+        }
+
+        if (event.is(Deployment.APPLICATION_UNLOADED) && event.hook() instanceof ApplicationInfo appInfo) {
+            service.removeAllHealthChecksFrom(appInfo.getName());
+        }
+    }
+}

appserver/microprofile/health-glassfish/src/main/java/org/glassfish/microprofile/health/service/HealthServlet.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2024 Contributors to Eclipse Foundation.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0, which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the
+ * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
+ * version 2 with the GNU Classpath Exception, which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ */
+package org.glassfish.microprofile.health.service;
+
+import jakarta.json.bind.Jsonb;
+import jakarta.json.bind.JsonbBuilder;
+import jakarta.servlet.http.HttpServlet;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpServletResponse;
+
+import java.io.IOException;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import org.eclipse.microprofile.health.HealthCheckResponse;
+import org.glassfish.internal.api.Globals;
+import org.glassfish.microprofile.health.HealthReport;
+import org.glassfish.microprofile.health.HealthReporter;
+
+public class HealthServlet extends HttpServlet {
+
+    private static final Logger LOGGER = Logger.getLogger(HealthServlet.class.getName());
+
+    @Override
+    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
+        HealthReport healthReport;
+        try {
+            healthReport = Globals.getDefaultHabitat().getService(HealthReporter.class)
+                    .getReport(getReportKind(req.getRequestURI()));
+
+            int httpStatus = switch (healthReport.status()) {
+                case UP -> HttpServletResponse.SC_OK;
+                case DOWN -> HttpServletResponse.SC_SERVICE_UNAVAILABLE;
+            };
+            resp.setStatus(httpStatus);
+        } catch (Exception e) {
+            LOGGER.log(Level.SEVERE, "Unable to fetch health check status", e);
+            healthReport = new HealthReport(HealthCheckResponse.Status.DOWN, List.of());
+            resp.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
+        }
+
+        Jsonb jsonb = JsonbBuilder.create();
+        String json = jsonb.toJson(healthReport);
+        resp.setCharacterEncoding("UTF-8");
+        resp.setContentType("application/json");
+        resp.getWriter().println(json);
+    }
+
+    private static HealthReporter.ReportKind getReportKind(String path) {
+        if (path.endsWith("health/live")) {
+            return HealthReporter.ReportKind.LIVE;
+        } else if (path.endsWith("health/ready")) {
+            return HealthReporter.ReportKind.READY;
+        } else if (path.endsWith("health/started")) {
+            return HealthReporter.ReportKind.STARTED;
+        } else {
+            return HealthReporter.ReportKind.ALL;
+        }
+    }
+}