forked from openhab/openhab-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduced new ui.start bundle, which brings custom lifecycle status … (
openhab#419) * Introduced new ui.start bundle, which brings custom lifecycle status HTTP pages as well as an 404 error page. Signed-off-by: Kai Kreuzer <[email protected]> GitOrigin-RevId: 39f0e17
- Loading branch information
1 parent
18cd809
commit 6169268
Showing
7 changed files
with
226 additions
and
9 deletions.
There are no files selected for viewing
19 changes: 19 additions & 0 deletions
19
bundles/org.openhab.ui.dashboard/src/main/java/org/openhab/ui/dashboard/DashboardReady.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| /** | ||
| * Copyright (c) 2015-2018 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; | ||
|
|
||
| /** | ||
| * This is a marker interface to declare that the dashboard is up and ready to be used. | ||
| * | ||
| * @author Kai Kreuzer - Initial contribution | ||
| * | ||
| */ | ||
| public interface DashboardReady { | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <?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.openhab.core</groupId> | ||
| <artifactId>pom-bundles</artifactId> | ||
| <version>2.4.0-SNAPSHOT</version> | ||
| </parent> | ||
|
|
||
| <artifactId>org.openhab.ui.start</artifactId> | ||
|
|
||
| <packaging>eclipse-plugin</packaging> | ||
| <name>openHAB Start UI</name> | ||
| </project> |
173 changes: 173 additions & 0 deletions
173
bundles/org.openhab.ui.start/src/main/java/org/openhab/ui/start/internal/RootServlet.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| /** | ||
| * Copyright (c) 2015-2018 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.start.internal; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.URL; | ||
| import java.util.Properties; | ||
|
|
||
| import javax.servlet.ServletException; | ||
| import javax.servlet.http.HttpServlet; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
|
|
||
| import org.apache.commons.io.IOUtils; | ||
| import org.openhab.ui.dashboard.DashboardReady; | ||
| import org.osgi.framework.Bundle; | ||
| import org.osgi.framework.BundleEvent; | ||
| import org.osgi.framework.SynchronousBundleListener; | ||
| import org.osgi.service.component.ComponentContext; | ||
| import org.osgi.service.component.ComponentException; | ||
| import org.osgi.service.component.annotations.Activate; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Deactivate; | ||
| import org.osgi.service.component.annotations.Reference; | ||
| import org.osgi.service.component.annotations.ReferenceCardinality; | ||
| import org.osgi.service.component.annotations.ReferencePolicy; | ||
| import org.osgi.service.http.HttpService; | ||
| import org.osgi.service.http.NamespaceException; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * This servlet registers status (starting/stopping/updating) pages and serves the 404 page if system is started and an | ||
| * unknown url is called. | ||
| * | ||
| * @author Kai Kreuzer - Initial contribution | ||
| * | ||
| */ | ||
| @Component(immediate = true) | ||
| public class RootServlet extends HttpServlet { | ||
|
|
||
| private static final long serialVersionUID = -2091860295954594917L; | ||
|
|
||
| private final Logger logger = LoggerFactory.getLogger(RootServlet.class); | ||
|
|
||
| protected HttpService httpService; | ||
|
|
||
| // an enumeration for the state the whole system is in | ||
| private enum LifeCycleState { | ||
| STARTING, | ||
| STARTED, | ||
| STOPPING, | ||
| UPDATING; | ||
| } | ||
|
|
||
| private String page404; | ||
| private String pageStatus; | ||
|
|
||
| private DashboardReady dashboardStarted; | ||
| private LifeCycleState lifecycleState = LifeCycleState.STARTING; | ||
|
|
||
| @Override | ||
| protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { | ||
| if (dashboardStarted != null) { | ||
| // all is up and running | ||
| if (req.getRequestURI().equals("/")) { | ||
| resp.sendRedirect("/start/index"); | ||
| } else { | ||
| resp.sendError(HttpServletResponse.SC_NOT_FOUND); | ||
| resp.setContentType("text/html;charset=UTF-8"); | ||
| resp.getWriter().append(page404); | ||
| resp.getWriter().close(); | ||
| } | ||
| } else { | ||
| // report current system state | ||
| String message = null; | ||
| String subMessage = null; | ||
| switch (lifecycleState) { | ||
| case STARTING: | ||
| message = "openHAB is starting..."; | ||
| subMessage = "Please wait a moment!"; | ||
| break; | ||
| case UPDATING: | ||
| message = "openHAB is updating..."; | ||
| subMessage = "Please wait a moment!"; | ||
| break; | ||
| case STOPPING: | ||
| message = "openHAB is shutting down..."; | ||
| subMessage = "Please stand by."; | ||
| break; | ||
| default: | ||
| throw new IllegalStateException("Invalid system state " + lifecycleState); | ||
| } | ||
| resp.setContentType("text/html;charset=UTF-8"); | ||
| resp.getWriter().append(pageStatus.replace("${message}", message).replace("${submessage}", subMessage)); | ||
| resp.getWriter().close(); | ||
| } | ||
| } | ||
|
|
||
| @Activate | ||
| protected void activate(ComponentContext context) { | ||
| try { | ||
| httpService.registerServlet("/", this, new Properties(), httpService.createDefaultHttpContext()); | ||
| } catch (ServletException | NamespaceException e) { | ||
| logger.error("Failed registering root servlet!", e); | ||
| } | ||
| URL notfound = context.getBundleContext().getBundle().getEntry("pages/404.html"); | ||
| if (notfound != null) { | ||
| try { | ||
| page404 = IOUtils.toString(notfound.openStream()); | ||
| } catch (IOException e) { | ||
| throw new ComponentException(e); | ||
| } | ||
| } else { | ||
| throw new ComponentException("Cannot find 404.html - failed to initialize root servlet"); | ||
| } | ||
| URL status = context.getBundleContext().getBundle().getEntry("pages/status.html"); | ||
| if (status != null) { | ||
| try { | ||
| pageStatus = IOUtils.toString(status.openStream()); | ||
| } catch (IOException e) { | ||
| throw new ComponentException(e); | ||
| } | ||
| } else { | ||
| throw new ComponentException("Cannot find status.html - failed to initialize root servlet"); | ||
| } | ||
|
|
||
| // we can determine whether the whole framework is shutdown by listening to a STOPPING event for bundle 0. | ||
| Bundle systemBundle = context.getBundleContext().getBundle(0); | ||
| systemBundle.getBundleContext().addBundleListener(new SynchronousBundleListener() { | ||
| @Override | ||
| public void bundleChanged(final BundleEvent event) { | ||
| if (event.getBundle().getBundleId() == 0 && event.getType() == BundleEvent.STOPPING) { | ||
| lifecycleState = LifeCycleState.STOPPING; | ||
| } | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| @Deactivate | ||
| protected void deactivate() { | ||
| // reset, if this component is ever reused (should normally not be the case), it should be "starting" again. | ||
| lifecycleState = LifeCycleState.STARTING; | ||
| } | ||
|
|
||
| @Reference(cardinality = ReferenceCardinality.OPTIONAL, policy = ReferencePolicy.DYNAMIC) | ||
| protected void setDashboardStarted(DashboardReady dashboardStarted) { | ||
| this.dashboardStarted = dashboardStarted; | ||
| this.lifecycleState = LifeCycleState.STARTED; | ||
| } | ||
|
|
||
| protected void unsetDashboardStarted(DashboardReady dashboardStarted) { | ||
| if (lifecycleState != LifeCycleState.STOPPING) { | ||
| lifecycleState = LifeCycleState.UPDATING; | ||
| } | ||
| this.dashboardStarted = null; | ||
| } | ||
|
|
||
| @Reference | ||
| protected void setHttpService(HttpService httpService) { | ||
| this.httpService = httpService; | ||
| } | ||
|
|
||
| protected void unsetHttpService(HttpService httpService) { | ||
| this.httpService = null; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters